EIAM 組織単位のページングクエリを実行します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
eiam:ListOrganizationalUnits |
list |
*OrganizationalUnit
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| InstanceId |
string |
必須 |
インスタンス ID。 |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| PageNumber |
integer |
任意 |
返されるページのページ番号。デフォルト値: 1。 |
1 |
| PageSize |
integer |
任意 |
ページごとに返されるエントリ数。デフォルト値: 20。最大値: 100。 |
20 |
| OrganizationalUnitIds |
array |
任意 |
組織単位 ID のリスト。リスト内の ID 数は 100 を超えることはできません。 |
[ou_wovwffm62xifdziem7an7xxxxx] |
|
string |
任意 |
The organizational unit ID. |
ou_wovwffm62xifdziem7an7xxxxx |
|
| OrganizationalUnitName |
string |
任意 |
組織単位の名前。クエリには完全に一致が使用されます。 |
name_001 |
| OrganizationalUnitNameStartsWith |
string |
任意 |
組織単位の名前のプレフィックス。クエリには左側一致が使用されます。 |
name |
| ParentId |
string |
任意 |
親組織単位の ID。 |
ou_wovwffm62xifdziem7an7xxxxx |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
The response. |
||
| RequestId |
string |
The request ID. |
0441BD79-92F3-53AA-8657-F8CE4A2B912A |
| TotalCount |
integer |
The total number of entries that are returned. This value is the total number of matched entries. The maximum number of entries that can be returned in a single request is specified by PageSize. |
100 |
| OrganizationalUnits |
array<object> |
The list of organizational units. |
|
|
object |
The data object of the organizational unit. |
||
| OrganizationalUnitId |
string |
The organizational unit ID. |
ou_wovwffm62xifdziem7an7xxxxx |
| OrganizationalUnitName |
string |
The name of the organizational unit. |
test_organizationalUnit_name |
| ParentId |
string |
The ID of the parent organizational unit. |
ou_wovwffm62xifdziem7an7xxxxx |
| OrganizationalUnitExternalId |
string |
The external ID of the organizational unit. This ID is used to map the data of the organizational unit to the data of an external system. By default, the value of this parameter is the organizational unit ID. Note: The external ID must be unique within the same source type and source ID. |
ou_wovwffm62xifdziem7an7xxxxx |
| OrganizationalUnitSourceType |
string |
The source type of the organizational unit. Valid values:
|
build_in |
| OrganizationalUnitSourceId |
string |
The source ID of the organizational unit. |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| CreateTime |
integer |
The time when the organizational unit was created. The value is a UNIX timestamp. Unit: milliseconds. |
1652085686179 |
| UpdateTime |
integer |
The time when the organizational unit was last updated. The value is a UNIX timestamp. Unit: milliseconds. |
1652085686179 |
| Description |
string |
The description of the organizational unit. |
Test organizational unit |
| InstanceId |
string |
The instance ID. |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| Leaf |
boolean |
Indicates whether the organizational unit is a leaf node. A value of true indicates that the organizational unit has no child nodes. A value of false indicates that the organizational unit has child nodes. |
false |
例
成功レスポンス
JSONJSON
{
"RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
"TotalCount": 100,
"OrganizationalUnits": [
{
"OrganizationalUnitId": "ou_wovwffm62xifdziem7an7xxxxx",
"OrganizationalUnitName": "test_organizationalUnit_name",
"ParentId": "ou_wovwffm62xifdziem7an7xxxxx",
"OrganizationalUnitExternalId": "ou_wovwffm62xifdziem7an7xxxxx",
"OrganizationalUnitSourceType": "build_in",
"OrganizationalUnitSourceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
"CreateTime": 1652085686179,
"UpdateTime": 1652085686179,
"Description": "Test organizational unit\n",
"InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
"Leaf": false
}
]
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。