REST APIリファレンス

前へ次へ

ユーザーグループの詳細の取得

組織内のすべてのユーザーグループの詳細、または特定のユーザーグループの詳細を要求できます。

GET要求

組織内のすべてのユーザーグループの詳細、または特定のユーザーグループの詳細を要求できます。

ユーザーグループの詳細を取得するには、次のURIを使用します。

/public/core/v3/userGroups

特定のユーザーグループの詳細を取得するには、次のクエリパラメータをURIに追加する事ができます。

パラメータ	タイプ	説明
q	文字列	クエリフィルタ。次のいずれかのフィールドを使用してフィルタできます。 userGroupId。ユーザーグループを一意に識別するID。 userGroupName。ユーザーグループの名前。
limit	Int	返すユーザーグループの最大数。デフォルトは100です。
skip	Int	結果のリストのオフセットの量。デフォルトは0です。

例えば、ユーザーグループの名前を使用して特定のユーザーグループの詳細を取得するには、次の要求を使用できます。

public/core/v3/userGroups?q=userGroupName=="group_a"

GET応答

正常に実行された場合は、各ユーザーグループの次の情報を返します。

フィールド	タイプ	説明
id	文字列	ユーザーグループID。
orgId	String	ユーザーグループが属する組織のID。
createdBy	文字列	ユーザーアカウントを作成したユーザー。
updatedBy	String	ユーザーアカウントを最後に更新したユーザー。
createTime	文字列	ユーザーグループを作成した日時。
updateTime	文字列	ユーザーグループが最後に更新された日時。
userGroupName	文字列	ユーザーグループの名前。
description	文字列	ユーザーグループの説明。
roles	配列	ユーザーグループに割り当てられたロール。
id	文字列	rolesオブジェクトに含まれます。ロールID。
roleName	文字列	rolesオブジェクトに含まれます。ロール名。
description	文字列	rolesオブジェクトに含まれます。ロールの説明。
displayName	String	rolesオブジェクトに含まれます。ユーザーインタフェースに表示されるロール名。
displayDescription	String	rolesオブジェクトに含まれます。ユーザーインタフェースに表示されるロールの説明。
users	配列	ユーザーグループに割り当てられたユーザー。
id	文字列	usersオブジェクトに含まれます。ユーザーID。
userName	文字列	usersオブジェクトに含まれます。ユーザー名。
description	文字列	usersオブジェクトに含まれます。ユーザーの説明。

GET応答の例

成功した場合、次の例のような応答を受信します。

[
    {
        "id": "a6x85hoMvH2kWUIlcIRBEh",
        "orgId": "cPYWk02I4aBeuLEvYRtaMS",
        "createdBy": "a@abc.com",
        "updatedBy": "a@abc.com",
        "createTime": "2019-03-19T17:27:09.000Z",
        "updateTime": "2019-03-19T17:27:09.000Z",
        "userGroupName": "group_a",
        "description": "",
        "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."
            }
        ],
        "users": [
            {
                "id": "5N9JGth6pRYfOGjGKv3Q2D",
                "userName": "a@abc.com",
                "description": ""
            }
        ]
    }
]

ユーザーグループ

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal