EIAM から組織情報を取得するためのページングクエリを実行します。
操作説明
ルート組織の直下の子組織を取得するには、リクエストパラメーターを以下のように設定します:
{
"parentOrganizationalUnitId": "ou_root"
}
今すぐお試しください
テスト
RAM 認証
リクエスト構文
GET /v2/{instanceId}/{applicationId}/organizationalUnits HTTP/1.1
パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| instanceId |
string |
必須 |
インスタンス ID。 |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| applicationId |
string |
必須 |
アプリケーション ID。 |
app_mkv7rgt4d7i4u7zqtzev2mxxxx |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| Authorization |
string |
必須 |
認証情報。値は `Bearer ${access_token}` の形式である必要があります。例:`Bearer ATxxxx`。 |
Bearer AT8csE2seYxxxxxij |
| parentId |
string |
必須 |
親組織 ID。 |
ou_wovwffm62xifdziem7an7xxxxx |
| pageNumber |
integer |
任意 |
ページ番号。デフォルト値は 1 です。 |
1 |
| pageSize |
integer |
任意 |
1 ページあたりのレコード数。デフォルト値は 20 です。有効値の範囲は 1~100 です。 |
20 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答。 |
||
| totalCount |
integer |
レコードの合計数。 |
1000 |
| data |
array<object> |
データオブジェクトのリスト。 |
|
|
object |
データオブジェクト。 |
||
| instanceId |
string |
インスタンス ID。 |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| organizationalUnitId |
string |
組織 ID。 |
ou_wovwffm62xifdziem7an7xxxxx |
| organizationalUnitName |
string |
組織名。 |
name001 |
| parentId |
string |
親組織 ID。 |
ou_wovwffm62xifdziem7an7xxxxx |
| organizationalUnitExternalId |
string |
組織の外部 ID。この ID は、IDaaS 内の組織データと外部データをマップするために使用されます。デフォルト値は IDaaS 組織 ID です。 注:同一のソースタイプおよびソース ID に対して、外部 ID は一意である必要があります。 |
ou_wovwffm62xifdziem7an7xxxxx |
| organizationalUnitSourceType |
string |
組織のソースタイプ。有効な値は以下のとおりです:
|
build_in |
| organizationalUnitSourceId |
string |
組織のソース ID。 `build_in` タイプの場合、デフォルト値はインスタンス ID です。その他のタイプでは、値はソース側のエンタープライズ ID となります。たとえば、ソースが DingTalk の場合、値は DingTalk エンタープライズの `corpId` になります。 |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| createTime |
integer |
組織が作成された時刻。UNIX タイムスタンプ(ミリ秒単位)です。 |
1652083425923 |
| updateTime |
integer |
組織が最後に更新された時刻。UNIX タイムスタンプ(ミリ秒単位)です。 |
1652083425923 |
| description |
string |
組織の説明文。 |
测试组织 |
例
成功レスポンス
JSONJSON
{
"totalCount": 1000,
"data": [
{
"instanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
"organizationalUnitId": "ou_wovwffm62xifdziem7an7xxxxx",
"organizationalUnitName": "name001",
"parentId": "ou_wovwffm62xifdziem7an7xxxxx",
"organizationalUnitExternalId": "ou_wovwffm62xifdziem7an7xxxxx",
"organizationalUnitSourceType": "build_in",
"organizationalUnitSourceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
"createTime": 1652083425923,
"updateTime": 1652083425923,
"description": "测试组织"
}
]
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。