REST APIリファレンス

前へ次へ

ユーザーグループの作成

管理者権限がある場合は、userGroupsリソースを使用してユーザーグループを作成できます。

ユーザー、ユーザーグループ、結合されたロールの数は、1つの組織で1000を超える事は出来ません。

POST要求

ユーザーグループを作成するには、次のURIを使用してPOST要求を送信します。

/public/core/v3/userGroups

以下の情報を含めます。

フィールド	タイプ	必須	説明
name	String	○	ユーザーグループの名前。
description	文字列	-	ユーザーグループの説明。
roles	配列	はい	ユーザーグループに割り当てるロールのID。
users	配列	-	ユーザーグループに割り当てるユーザーのID。

POST応答

成功した場合、userGroupsオブジェクトと、POST要求に含めた詳細が返されます。

POSTの例

ユーザーグループを作成するには、次の例のような要求を送信します。

POST <baseApiUrl>/public/core/v3/userGroups
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
    "name" : "user_group_1",
    "roles" : ["5IPgtye09EbiWqz5XXuzwC", "9gedBDoYQoQibNMohf5KCh"],
    "users" : ["9EcgvBYZ9GGflOYr98GzOH"]
}

次の例のような応答を受信します。

{
    "id": "0TLmCMwX0jNdJ5SzlQC2CW",
    "orgId": "cPYWk02I4aBeuLEvYRtaMS",
    "createdBy": "a@abc.com",
    "updatedBy": "a@abc.com",
    "createTime": "2019-03-20T18:30:32.457Z",
    "updateTime": "2019-03-20T18:30:32.472Z",
    "userGroupName": "user_group_1",
    "description": null,
    "roles": [
        {
            "id": "9gedBDoYQoQibNMohf5KCh",
            "roleName": "Admin",
            "description": "Role for performing administrative tasks for an organization. Has full access to all licensed services."
            "displayName": "Admin",
            "displayDescription": "Role for performing administrative tasks for an organization. Has full access to all licensed services."
        },
        {
            "id": "5IPgtye09EbiWqz5XXuzwC",
            "roleName": "test_user_1",
            "description": ""
            "roleName": "test_user_1",
            "description": ""
       }
    ],
    "users": [
        {
            "id": "9EcgvBYZ9GGflOYr98GzOH",
            "userName": "test_user_2",
            "description": null
        }
    ]
}

ユーザーグループ

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal