アイデンティティのリスト
get
/access-governance/identities/20250331/identities
ページ区切りをサポートし、すべてのアクティブなアイデンティティ(要員およびコンシューマ)詳細を返します。
リクエスト
問合せパラメータ
- attributeValues: array[string]
コレクション形式:
multi
最大アイテム数:5
一致するフィルタとして使用する属性値のリスト。 - attributes: array[string]
コレクション形式:
multi
最大アイテム数:5
フィルタ処理に使用する属性のリスト。 - bindingOperator: string
式をバインドするパラメータ。デフォルト値:
ALL
許容値:[ "ALL", "ANY" ]
- consumerFilter: string
消費者/従業員タイプのフィルタ。許容値:
[ "CONSUMER", "WORKFORCE" ]
- keywordContains: array[string]
コレクション形式:
multi
最大アイテム数:5
フィルタするキーワードのリスト - limit: integer
最小値:
1
最大値:1000
返されるアイテムの最大数。デフォルト値:10
- operators: array[string]
コレクション形式:
multi
最大アイテム数:5
論理式を形成するパラメータ。-
許容値:
[ "EQ", "NE", "GT", "LT", "GTE", "LTE", "BEFORE", "AFTER", "TO", "FROM", "CONTAINS", "NOT_CONTAINS" ]
-
- page: string
最小長:
1
結果の取得を開始する位置を表すトークン。 これは、前のレスポンスの`opc-next-page`ヘッダー・フィールドから取得する必要があります。 - sortBy: string
ソートの基準となるフィールド。 指定できるソート順は1つのみです。 timeCreatedのデフォルトの順序は降順です。 displayNameのデフォルトの順序は昇順です。デフォルト値:
timeCreated
許容値:[ "timeCreated", "displayName" ]
- sortOrder: string
使用するソート順(ASCまたはDESC)。許容値:
[ "ASC", "DESC" ]
ヘッダー・パラメータ
- opc-request-id: string
トレース用のクライアント・リクエストID。 リクエストIDに有効な文字は、文字、数字、アンダースコアおよびダッシュのみです。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
アイデンティティのリストを正常に問い合せました。
ヘッダー
- opc-next-page: string
アイテム・リストのページ区切り。 リストをページングする際、このヘッダーがレスポンスに表示される場合は、部分的なリストが返されている可能性があります。 この値を後続のGETリクエストの`page`パラメータとして含め、次のアイテム・バッチを取得します。
- opc-request-id: string
リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。
ルート・スキーマ : AccessGovernanceTypeCollection
型:
object
アクセス・ガバナンス・エンティティ・アイテムのリスト。
ソースを表示
- items(必須): array items
アクセス・ガバナンス・エンティティ項目のリスト。
ネストされたスキーマ: items
型:
array
アクセス・ガバナンス・エンティティ項目のリスト。
ソースを表示
- Array of: object AccessGovernanceEntity
Access Governanceエンティティ
ネストされたスキーマ : AccessGovernanceEntity
型:
object
Access Governanceエンティティ
ソースを表示
- entityType(required): string
Access Governanceのエンティティ・タイプ
- id(必須): string
Access GovernanceエンティティのID
- isRuleBased: boolean
このアイデンティティはベースですか
- name(required): string
アクセス・ガバナンス・タイプの名前
- timeCreated(required): string(日時)
アクセス・ガバナンスによってエンティティが作成された時間
- timeUpdated(required): string(日時)
エンティティがアクセス・ガバナンスによって最後に変更された時間
- type(必須): string
許容値:
[ "IDENTITY", "IDENTITY_COLLECTION", "ORGANIZATION", "ROLE", "PERMISSION", "ACCESS_BUNDLE", "POLICY", "RESOURCE", "CLOUD_RESOURCE", "ACCOUNT", "OWNERSHIP", "APPROVAL_PROCESS", "TARGET", "ACCESS_GUARDRAIL" ]
アクセス・ガバナンスのエンティティ・タイプ - value(required): string
アクセス・ガバナンス・タイプのjsonスキーマ
400レスポンス
不正なリクエスト
ヘッダー
- opc-request-id: string
リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。
ルート・スキーマ : Error
型:
object
エラー情報。
ソースを表示
- code(必須): string
プログラム解析用のエラーを定義する短いエラー・コード。
- message(必須): string
判読可能なエラー文字列。
401レスポンス
未認可
ヘッダー
- opc-request-id: string
リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。
ルート・スキーマ : Error
型:
object
エラー情報。
ソースを表示
- code(必須): string
プログラム解析用のエラーを定義する短いエラー・コード。
- message(必須): string
判読可能なエラー文字列。
404レスポンス
見つかりません
ヘッダー
- opc-request-id: string
リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。
ルート・スキーマ : Error
型:
object
エラー情報。
ソースを表示
- code(必須): string
プログラム解析用のエラーを定義する短いエラー・コード。
- message(必須): string
判読可能なエラー文字列。
409レスポンス
競合
ヘッダー
- opc-request-id: string
リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。
ルート・スキーマ : Error
型:
object
エラー情報。
ソースを表示
- code(必須): string
プログラム解析用のエラーを定義する短いエラー・コード。
- message(必須): string
判読可能なエラー文字列。
429レスポンス
リクエストが多すぎます
ヘッダー
- opc-request-id: string
リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。
ルート・スキーマ : Error
型:
object
エラー情報。
ソースを表示
- code(必須): string
プログラム解析用のエラーを定義する短いエラー・コード。
- message(必須): string
判読可能なエラー文字列。
500レスポンス
内部サーバー・エラー
ヘッダー
- opc-request-id: string
リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。
ルート・スキーマ : Error
型:
object
エラー情報。
ソースを表示
- code(必須): string
プログラム解析用のエラーを定義する短いエラー・コード。
- message(必須): string
判読可能なエラー文字列。
デフォルト・レスポンス
不明なエラー
ヘッダー
- opc-request-id: string
リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。
ルート・スキーマ : Error
型:
object
エラー情報。
ソースを表示
- code(必須): string
プログラム解析用のエラーを定義する短いエラー・コード。
- message(必須): string
判読可能なエラー文字列。
例
次の例は、GETリクエストを発行してアイデンティティのリストを取得する方法を示しています。
cURL例 - 問合せパラメータなし
curl -i -X \
GET \
-H \
"Authorization:Bearer <your access token>" \
'${service-instance-url}/access-governance/identities/${versionId}/identities'
attributeValues
を使用したアイデンティティ・データの問合せのルール
attributeValues
パラメータは、attribute
パラメータと連携します。 そのため、attributes
とattributeValues
の両方を指定する必要があり、数値で一致する必要があります。keywordContains
およびattributeValues
パラメータは、同じ問合せでは使用できません。bindingOperator
は、複数の属性条件を組み合せる方法を決定します。ALL
(すべての条件がtrueである必要があります)およびANY
(少なくとも1つの条件がtrueである必要があります)。Operators
は、属性とその値の比較を定義します。 デフォルトはEQ (equals)
です。
例1 - 問合せパラメータあり
データを制限し、要員IDのみを含めるcURLコマンド。
curl -i -X GET \
-H "Authorization:Bearer <your access token>" \
'${service-instance-url}/access-governance/identities/${versionId}/identities?consumerFilter=WORKFORCE'
例2 - 属性および属性値を含むIDの問合せ
familyName CONTAINS Clark
およびagRisk.value EQ 1
を使用してアイデンティティを問い合せるcURLコマンド
curl -i -X GET \
-H "Authorization:Bearer <your access token>" \
'${service-instance-url}/access-governance/identities/${versionId}/identities?attributes=name.familyName&operators=CONTAINS&attributeValues=Clark&attributes=agRisk.value&operators=EQ&attributeValues=1'
attributes=name.familyName,agRisk.value
: フィルタする属性を指定します。operators=CONTAINS,EQ
attributeValues=Clark,1
: 対応する値を指定します。
例3 - カスタム属性およびバインド演算子と属性値がある問合せID
curl -i -X GET \
-H "Authorization:Bearer <your access token>" \
'${service-instance-url}/access-governance/identities/${versionId}/attributes=customAttributes.Division&operators=EQ&attributeValues=Finance&attributes=agRisk.value&operators=EQ&attributeValues=1&bindingOperator=ALL'
レスポンス本文の例
次の例は、Workforceアイデンティティのリストを含む、JSON形式のレスポンス本文のコンテンツを示しています:
{
"items": [
{
"id": "globalId.ICF.xxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.xxxxxxxxxxxxxx",
"type": "IDENTITY",
"name": "jclark_admin",
"timeCreated": "2025-05-29T13:39:32.244Z",
"timeUpdated": "2025-05-29T13:39:32.244Z",
"entityType": "USER",
"typeDetails": "https://your-api-endpoint/access-governance/identities/yyyyMMdd/types/agcs.Identity",
"attributes": [
{
"name": "agTerminated",
"value": false
}
],
"value": "{\"name\":{\"familyName\":\"Clark\",\"givenName\":\"James\"},\"userName\":\"jclark_admin\",\"displayName\":\"James Clark\",\"primaryEmail\":\"jclark_admin@example.com\",\"employeeNumber\":\"JCLARK123\",\"status\":\"Active\",\"emails\":[{\"value\":\"jclark_admin@example.com\"}],\"addresses\":[{}],\"agStatus\":\"AG_ACTIVE\",\"agSubType\":\"WORKFORCE\",\"agRisk\":{\"value\":1,\"customAttributes\":{}},\"customAttributes\":{\"Company\":\"TestCorp\",\"BadgeNumber\":\"123\"},\"id\":\"globalId.ICF.xxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.xxxxxxxxxxxxxx\",\"externalId\":\"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\"meta\":{\"resourceType\":\"USER\",\"created\":1748525972244,\"lastModified\":1748525972244,\"version\":\"1\",\"location\":\"\"}}"
},
{
"id": "globalId.ICF.xxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.xxxxxxxxxxxxxx",
"type": "IDENTITY",
"name": "bclark_user",
"timeCreated": "2025-05-29T13:39:32.244Z",
"timeUpdated": "2025-05-29T13:39:32.244Z",
"entityType": "USER",
"typeDetails": "https://your-api-endpoint/access-governance/identities/yyyyMMdd/types/agcs.Identity",
"attributes": [
{
"name": "agTerminated",
"value": false
}
],
"value": "{\"name\":{\"familyName\":\"Clark\",\"givenName\":\"Bill\"},\"userName\":\"bclark_user\",\"displayName\":\"Bill Clark\",\"primaryEmail\":\"bclark_user@example.com\",\"status\":\"Active\",\"emails\":[{\"value\":\"bclark_user@example.com\"}],\"addresses\":[{}],\"agStatus\":\"AG_ACTIVE\",\"agSubType\":\"WORKFORCE\",\"agRisk\":{\"value\":1,\"customAttributes\":{}},\"customAttributes\":{\"Company\":\"TestCorp\",\"BadgeNumber\":\"456\"},\"id\":\"globalId.ICF.xxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.xxxxxxxxxxxxxx\",\"externalId\":\"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\"meta\":{\"resourceType\":\"USER\",\"created\":1748525972244,\"lastModified\":1748525972244,\"version\":\"1\",\"location\":\"\"}}"
}
]
}