ロールのリストの取得
get
/access-governance/access-controls/20250331/roles
ページ区切りをサポートしている使用可能なすべてのロールの詳細を返します。
リクエスト
問合せパラメータ
- approvalWorkflowId: string
最小長:
1最大長:255指定された承認ワークフローIDに一致するリソースのみを返すフィルタ。 - keywordContains: string
フィルタするキーワード。 指定できるキーワードは1つのみです。 デフォルトは空の文字列です。
- limit: integer
最小値:
1最大値:1000返されるアイテムの最大数。デフォルト値:10 - page: string
最小長:
1結果の取得を開始する位置を表すトークン。 これは、前のレスポンスの`opc-next-page`ヘッダー・フィールドから取得する必要があります。 - requestableBy: string
最小長:
1最大長:255指定されたidentityTypeに一致するリソースのみを返すフィルタ。許容値:[ "ANY", "NONE" ] - sortBy: string
ソートの基準となるフィールド。 指定できるソート順は1つのみです。 timeCreatedのデフォルトの順序は降順です。 displayNameのデフォルトの順序は昇順です。デフォルト値:
timeCreated許容値:[ "timeCreated", "displayName" ] - sortOrder: string
使用するソート順(ASCまたはDESC)。許容値:
[ "ASC", "DESC" ] - status: string
指定されたステータスのエンティティの検索に使用するフィルタ。デフォルト値:
ALL許容値:[ "ALL", "ACTIVE", "DRAFT", "INACTIVE" ] - userId: string
最小長:
1最大長:255操作を実行しているユーザーの識別子
ヘッダー・パラメータ
- opc-request-id: string
トレース用のクライアント・リクエストID。 リクエストIDに有効な文字は、文字、数字、アンダースコアおよびダッシュのみです。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
ロール・サマリーのリスト
ヘッダー
- opc-next-page: string
アイテム・リストのページ区切り。 リストをページングする際、このヘッダーがレスポンスに表示される場合は、部分的なリストが返されている可能性があります。 この値を後続のGETリクエストの`page`パラメータとして含め、次のアイテム・バッチを取得します。
- opc-request-id: string
リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。
ルート・スキーマ: RoleCollection
型:
objectロール検索の結果。 ロール・アイテムとその他のデータの両方が含まれます。
ソースを表示
- items(必須): array items
ロール・サマリーのリスト。
ネストされたスキーマ: RoleSummary
型:
objectロール・オブジェクトのサマリー。
ソースを表示
- approvalWorkflowId: string
ロールに適用可能なApprovalWorkflowId
- createdBy: object IdInfo
汎用識別情報オブジェクト。
- customAttributes: object customAttributes
アクセス・バンドルに関連付けられたメタデータ
- description: string
ロールの説明
- id(必須): string
作成時に変更できない一意の識別子
- isOwner: boolean
ログイン・ユーザーがこのリソースの所有者であるかどうかをチェックするブール値。
- name: string
ロール名
- owners: array owners
所有者エンティティのリスト
- primaryOwner: object PrimaryOwner
プライマリ所有者の詳細。
- requestableBy: string
許容値:
[ "ANY", "NONE" ]アクセス・バンドルをリクエストできるアイデンティティ・タイプ。 - status: string
許容値:
[ "ACTIVE", "DRAFT", "INACTIVE", "PENDING", "FAILED", "IN_PROGRESS", "SAVED", "SUCCESS", "TIMEOUT" ]ロールのステータス - tags: array tags
ロールに添付されたタグのリスト
- timeCreated: string(date-time)
ロールが作成された時間。 「An RFC3339」書式設定日時文字列
- timeUpdated: string(date-time)
ロールが最後に更新された時間。 「An RFC3339」書式設定日時文字列
ネストされたスキーマ : IdInfo
型:
object汎用識別情報オブジェクト。
ソースを表示
- displayName: string
エンティティの表示名。
- id: string
エンティティのID。
- name: string
エンティティの名前。
ネストされたスキーマ : PrimaryOwner
型:
objectプライマリ所有者の詳細。
ソースを表示
- displayName: string
プライマリ所有者の表示名。
- value: string
プライマリ所有者のID。
ネストされたスキーマ : OwnerSummary
型:
object所有者エンティティ・オブジェクト
ソースを表示
- id(必須): string
作成時に変更できない一意の識別子
- isPrimary(required): boolean
このエンティティはプライマリ所有者ですか?
- name(required): string
所有者の名前
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
判読可能なエラー文字列。
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>" \
'https://${service-instance-url}/access-governance/access-controls/20250331/roles'レスポンス本文の例
次の例は、使用可能なすべてのロールのリストを含む、JSON形式のレスポンス本文の内容を示しています:
{
"items": [
{
"id": "7642ff7d-xxxx-45c4-88d4-db7d2e79e85f",
"name": "UA External API Access Manager",
"description": "Manages permissions for identities.",
"status": "ACTIVE",
"approvalWorkflowId": "NO_APPROVAL_REQUIRED",
"createdBy": {
"id": "globalId.125123c3-xxxx-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b201421b4xxx046b3ceb16a",
"name": "Amel Maclead",
"displayName": "Amel Maclead"
},
"requestableBy": "ANY",
"timeCreated": "2025-04-24T06:55:26.546Z",
"timeUpdated": "2025-04-24T06:55:26.546Z",
"tags": ["UA Role"],
"customAttributes": null,
"primaryOwner": {
"value": "globalId.125123c3-xxxx-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b201421b44aa046b3ceb16a",
"displayName": "Amel Maclead"
},
"isOwner": true,
"owners": null
},
{
"id": "a5ee5a10-xxxx-4882-8ff9-c5277e94f9ce",
"name": "UA External API Role - Account Manager",
"description": "Responsible for updating and managing accounts.",
"status": "ACTIVE",
"approvalWorkflowId": "NO_APPROVAL_REQUIRED",
"createdBy": {
"id": "globalId.125123c3-xxxx-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b201421b44aa046b3ceb16a",
"name": "Amel Maclead",
"displayName": "Amel Maclead"
},
"requestableBy": "ANY",
"timeCreated": "2025-04-24T06:27:26.011Z",
"timeUpdated": "2025-04-24T06:39:11.143Z",
"tags": ["UA Role"],
"customAttributes": null,
"primaryOwner": {
"value": "globalId.125123c3-xxxx-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b201421b44aa046b3ceb16a",
"displayName": "Amel Maclead"
},
"isOwner": true,
"owners": null
}
]
}