Employee Identity and Access Management (EIAM) のグループ情報をページ単位で取得します。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
GET /v2/{instanceId}/{applicationId}/groups HTTP/1.1パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| instanceId |
string |
必須 |
インスタンス ID。 |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| applicationId |
string |
必須 |
アプリケーション ID。 |
app_mkv7rgt4d7i4u7zqtzev2mxxxx |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| Authorization |
string |
必須 |
認証情報。値は Bearer ${access_token} 形式です（例： Bearer ATxxxx）。 |
Bearer xxxx |
| groupNameStartWith |
string |
任意 |
グループ名のプレフィックス。 |
group_xxx |
| nextToken |
string |
任意 |
次回クエリの開始位置を示すトークン。 |
NTxxx |
| maxResults |
integer |
任意 |
1 ページあたりの最大エントリ数。デフォルト値：20。 |
20 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
DeveloperNextTokenResponse |
||
| totalCount |
integer |
返されたエントリの合計数。 |
1000 |
| data |
array<object> |
返されたデータ。 |
|
|
object |
返されたデータ。 |
||
| instanceId |
string |
インスタンス ID。 |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| groupId |
string |
グループ ID。 |
group_ufdsasn35ea5lmthk267xxxxx |
| groupName |
string |
グループ名。 |
name_test |
| description |
string |
グループの説明文。 |
description_demo |
| groupExternalId |
string |
グループの外部 ID。 |
group_ufdsasn35ea5lmthk267xxxxx |
| groupSourceType |
string |
グループのソース種別。有効な値： build_in、ding_talk、ad、ldap。 |
build_in |
| groupSourceId |
string |
グループのソース ID。 |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| createTime |
integer |
グループが作成された時刻。値は UNIX タイムスタンプ（ミリ秒単位）です。 |
1652085686179 |
| updateTime |
integer |
グループが最後に更新された時刻。値は UNIX タイムスタンプ（ミリ秒単位）です。 |
1652085686179 |
| nextToken |
string |
クエリの開始位置を示すトークン。このパラメーターを空欄のままにした場合、クエリは先頭から開始されます。 |
NTxxx |
| maxResults |
integer |
返される最大エントリ数。 |
20 |
例
成功レスポンス
JSONJSON
{
"totalCount": 1000,
"data": [
{
"instanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
"groupId": "group_ufdsasn35ea5lmthk267xxxxx",
"groupName": "name_test",
"description": "description_demo",
"groupExternalId": "group_ufdsasn35ea5lmthk267xxxxx",
"groupSourceType": "build_in",
"groupSourceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
"createTime": 1652085686179,
"updateTime": 1652085686179
}
],
"nextToken": "NTxxx",
"maxResults": 20
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。