新規ロールの作成
post
/access-governance/access-controls/20250331/roles
指定された詳細で新しいロールを作成します。
リクエスト
ヘッダー・パラメータ
- opc-request-id: string
トレース用のクライアント・リクエストID。 リクエストIDに有効な文字は、文字、数字、アンダースコアおよびダッシュのみです。
新規ロールの詳細
ルート・スキーマ : CreateRoleDetails
型:
object
新規ロールに関する情報。
ソースを表示
- accessBundles: array accessBundles
アクセス・バンドルのリスト
- approvalWorkflowId: string
ロールに適用可能なApprovalWorkflowId
- customAttributes: object customAttributes
ロールに関連付けられたメタデータ
- description: string
ロールの説明
- displayName: string
ロールの表示名
- externalId: string
ロールのExternalId
- name(required): string
最小長:
1
最大長:255
ロール識別子 - owners: array owners
所有者エンティティのリスト
- requestableBy: string
許容値:
[ "ANY", "NONE" ]
アクセス・バンドルをリクエストできるエンティティ - tags: array tags
ロールに添付されたタグのリスト
ネストされたスキーマ : 情報
型:
object
汎用情報オブジェクト。
ソースを表示
- displayName: string
エンティティの表示名。
- id: string
エンティティのID。
- name: string
エンティティの名前。
ネストされたスキーマ : OwnerSummary
型:
object
所有者エンティティ・オブジェクト
ソースを表示
- id(必須): string
作成時に変更できない一意の識別子
- isPrimary(required): boolean
このエンティティはプライマリ所有者ですか?
- name(required): string
所有者の名前
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
新しく作成されたロール
ヘッダー
- etag: string
オプティミスティックな同時実行性制御用。 `if-match`を参照してください。
- opc-request-id: string
リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。
ルート・スキーマ: Role
型:
object
ロール・オブジェクト。
ソースを表示
- accessBundles: array accessBundles
アクセス・バンドルのリスト
- approvalWorkflowId: object IdInfo
汎用識別情報オブジェクト。
- createdBy: object IdInfo
汎用識別情報オブジェクト。
- customAttributes: object customAttributes
ロールに関連付けられたメタデータ
- description: string
ロールの摘要
- displayName: string
ロールの表示名
- externalId: string
ロールのExternalId
- id(必須): string
作成時に変更できない一意の識別子
- name: string
ロール名
- owners: array owners
所有者エンティティのリスト
- ownershipCollectionId: string
ロールに関連付けられた所有権コレクション
- requestableBy: object IdInfo
汎用識別情報オブジェクト。
- 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」書式設定日時文字列
- updatedBy: object IdInfo
汎用識別情報オブジェクト。
ネストされたスキーマ : accessBundles
型:
array
アクセス・バンドルのリスト
ソースを表示
- Array of: object AccessBundle
バンドル・オブジェクトにアクセスします。
ネストされたスキーマ : IdInfo
型:
object
汎用識別情報オブジェクト。
ソースを表示
- displayName: string
エンティティの表示名。
- id: string
エンティティのID。
- name: string
エンティティの名前。
ネストされたスキーマ : AccessBundle
型:
object
バンドル・オブジェクトにアクセスします。
ソースを表示
- accessGuardrail: object AccessGuardrailDetails
Guardrailオブジェクトにアクセスします。
- accessTimeLimit: object AccessBundleTimeLimit
時間制限の定義。 daysLimit、hoursLimitまたはdateTimeLimitのいずれか1つのみを指定する必要があります。
- accessTimeLimitType: string
許容値:
[ "INDEFINITELY", "NUMBER_OF_DAYS", "NUMBER_OF_HOURS" ]
アクセス・バンドルの時間制限タイプ。 - accountProfileId: string
アクセス・バンドルの構成済アカウント・プロファイルID。
- accountProfileName: string
アクセス・バンドルの構成済アカウント・プロファイル名。
- approvalWorkflowId: object IdInfo
汎用識別情報オブジェクト。
- autoApproveIfNoViolation: boolean
アクセス・バンドルへのアクセス・リクエストに違反がない場合に自動承認を示すブール・フラグ。
- cloudAccountName: string
OCIバンドルのクラウド・アカウント名(OCIテナンシなど)。
- compartmentFqn: string
OCIバンドルのコンパートメントのフルネーム。
- compartmentName: string
OCIバンドルのコンパートメント名。
- createdBy: object IdInfo
汎用識別情報オブジェクト。
- customAttributes: object customAttributes
アクセス・バンドルに関連付けられたメタデータ。
- description: string
アクセス・バンドルの説明。
- displayName: string
アクセス・バンドルの表示名。
- domainName: string
OCIバンドルのドメイン名。
- externalId: string
Access BundleのExternalId。
- id(必須): string
作成時に変更できない一意の識別子
- name: string
アクセス・バンドルの名前。
- orchestratedSystem: object IdInfo
汎用識別情報オブジェクト。
- orchestratedSystemAttributes: object OrchestratedSystemAttributeSummary
アカウント属性と権限属性。
- orchestratedSystemType: string
オーケストレート済システム・タイプ。
- owners: array owners
所有者エンティティのリスト。
- ownershipCollectionId: string
アクセス・バンドルに関連付けられた所有権コレクション。
- permissions: array permissions
権限のリスト
- requestableBy: object IdInfo
汎用識別情報オブジェクト。
- resourceType: string
OCI Access Bundleのリソース・タイプ。
- status: string
許容値:
[ "ACTIVE", "DRAFT", "INACTIVE", "PENDING", "FAILED", "IN_PROGRESS", "SAVED", "SUCCESS", "TIMEOUT" ]
アクセス・バンドルのステータス。 - tags: array tags
アクセス・バンドルに添付されたタグのリスト。
- timeCreated: string(date-time)
アクセス・バンドルが作成された時間。 RFC3339形式の日時文字列
- timeUpdated: string(date-time)
アクセス・バンドルが最後に更新された時間。 RFC3339形式の日時文字列
- updatedBy: object IdInfo
汎用識別情報オブジェクト。
ネストされたスキーマ : AccessGuardrailDetails
型:
object
Guardrailオブジェクトにアクセスします。
ソースを表示
- id(必須): string
アクセス・ガード・レールID。
- name(required): string
アクセス・ガード・レール名。
ネストされたスキーマ : AccessBundleTimeLimit
型:
object
時間制限の定義。 daysLimit、hoursLimitまたはdateTimeLimitのいずれか1つのみを指定する必要があります。
ソースを表示
- daysLimit: object AccessBundleTimeLimitDays
時間制限の定義(日数)。
- hoursLimit: object AccessBundleTimeLimitHours
時間制限の定義(時間)。
ネストされたスキーマ : OrchestratedSystemAttributeSummary
型:
object
アカウント属性と権限属性。
ソースを表示
- accountAttributes: array accountAttributes
オーケストレーション済システム・アカウント属性のリスト。
- permissionAttributes: array permissionAttributes
オーケストレート済システム権限属性のリスト。
ネストされたスキーマ : AccessBundleTimeLimitDays
型:
object
時間制限の定義(日数)。
ソースを表示
- accessLimitInDays(required): integer
最小値:
1
最大値:365
失効までに許可される最大日数。 - extensionApprovalWorkflowId(required): object IdInfo
汎用識別情報オブジェクト。
- extensionInDays(required): integer
最小値:
1
最大値:90
拡張が許可される日数。 - notificationInDays(required): integer
最小値:
1
最大値:30
通知を送信する日数。
ネストされたスキーマ : AccessBundleTimeLimitHours
型:
object
時間制限の定義(時間)。
ソースを表示
- accessLimitInHours(required): integer
最小値:
1
最大値:24
失効までに許可される最大時間数。 - extensionApprovalWorkflowId(required): object IdInfo
汎用識別情報オブジェクト。
- extensionInHours(required): integer
最小値:
1
最大値:8
時間数の延長が許可されています。 - notificationInHours(required): integer
最小値:
1
最大値:24
通知を送信する時間数。
ネストされたスキーマ : accountAttributes
型:
array
オーケストレーション済システム・アカウント属性のリスト。
ソースを表示
- Array of: object OrchestratedSystemAttributeDataSummary
オーケストレーション・システム属性
ネストされたスキーマ : permissionAttributes
型:
array
オーケストレート済システム権限属性のリスト。
ソースを表示
- Array of: object OrchestratedSystemAttributeDataSummary
オーケストレーション・システム属性
ネストされたスキーマ : OrchestratedSystemAttributeDataSummary
型:
object
オーケストレーション・システム属性
ソースを表示
- children: array children
ネストされた属性
- discriminator: string
このフィールドは、属性フィールドがパスワードであることを示します
- isQuestion: boolean
このオーケストレーション・システム属性が質問として表示されるかどうかを示します。
- name: string
属性名 - 一意の識別子
- permissionType: string
パーミッション・タイプ
- title: string
属性の表示名。
- type: string
属性のタイプ
- values: array values
属性値
ネストされたスキーマ: children
型:
array
ネストされた属性
ソースを表示
- Array of: object NestedAttributesSummary
オーケストレーション・システム属性のネストされたセット
ネストされたスキーマ : NestedAttributesSummary
型:
object
オーケストレーション・システム属性のネストされたセット
ソースを表示
- items: array items
オーケストレーションされたシステム属性
ネストされたスキーマ: items
型:
array
オーケストレーションされたシステム属性
ソースを表示
- Array of: object OrchestratedSystemAttributeDataSummary
オーケストレーション・システム属性
ネストされたスキーマ : OwnerSummary
型:
object
所有者エンティティ・オブジェクト
ソースを表示
- id(必須): string
作成時に変更できない一意の識別子
- isPrimary(required): boolean
このエンティティはプライマリ所有者ですか?
- name(required): string
所有者の名前
ネストされたスキーマ : PermissionSummary
型:
object
権限の説明。
ソースを表示
- description: string
権限の説明
- id(必須): string
作成時に不変である一意のOracle ID (OCID)
- name: string
パーミッション名
- permissionType: object PermissionTypeSummary
PermissionTypeサマリー。
- resource: object ResourceSummary
資源要約
- timeCreated: string(date-time)
権限が最後に作成された時間。 「An RFC3339」書式設定日時文字列
- timeUpdated: string(date-time)
権限が最後に更新された時間。 「An RFC3339」書式設定日時文字列
- type: string
権限のタイプ
ネストされたスキーマ : PermissionTypeSummary
型:
object
PermissionTypeサマリー。
ソースを表示
- displayName: string
PermissionTypeの表示名。
- externalId: string
PermissionTypeの外部ID
- id: string
作成時に不変である一意のOracle ID (OCID)。
- name: string
PermissionTypeの名前。
ネストされたスキーマ : ResourceSummary
型:
object
資源要約
ソースを表示
- customAttributes: object customAttributes
リソースに関連付けられたメタデータ
- displayName: string
リソースの表示名。
- id(必須): string
作成時に不変である一意のOracle ID (OCID)。
- name: string
リソースの名前。
- type: 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
判読可能なエラー文字列。
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
判読可能なエラー文字列。
例
次の例は、ロールの作成方法を示しています。 サンプル・コマンドを実行する前に、プレースホルダー値を実際の値に置き換えます。
ノート:
grant_type = password
または認可コードを使用してアクセス・トークンを生成します。
ロールを作成する前に、次のAPIを実行して必要なデータをフェッチする必要があります:
- すべての承認ワークフローのリスト - [GET] {BasePath}/approvalWorkflows
- アクセス・バンドルのリスト - [GET] {BasePath}/accessBundles
cURLリクエストの例
curl -i -X POST \
-H "Authorization:Bearer <your-access-token>" \
-H "Content-Type:application/json" \
-d \
'{
"name": "Database Administrator",
"description": "Responsible for managing database access and ensuring optimized SQL performance.",
"requestableBy": "ANY",
"approvalWorkflowId": "NO_APPROVAL_REQUIRED",
"tags": [
"UA Role"
],
"accessBundles": [
{
"id": "b943f987-xxxx-4bac-bca0-6a09ded5dcad",
"name": "DBUM Standard SQL Tuning Access UA 8",
"displayName": "DBUM Standard SQL Tuning Access UA 8",
"owners": [
{
"id": "globalId.125123c3-xxxx-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b201421b44aa046b3ceb16a",
"name": "Bill Clark",
"isPrimary": true
}
]
}
],
"customAttributes": null,
"displayName": "Database Administrator Role",
"owners": [
{
"id": "globalId.125123c3-xxxx-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b201421b44aa046b3ceb16a",
"name": "Bill Clark",
"isPrimary": true
}
]
}' \
'<${service-instance-url}/access-governance/access-controls/20250331/roles>'
リクエスト・ペイロードの例
{
"name": "Database Administrator",
"description": "Responsible for managing database access and ensuring optimized SQL performance.",
"requestableBy": "ANY",
"approvalWorkflowId": "NO_APPROVAL_REQUIRED",
"tags": [
"UA Role"
],
"accessBundles": [
{
"id": "b943f987-xxxx-4bac-bca0-6a09ded5dcad",
"name": "DBUM Standard SQL Tuning Access UA 8",
"displayName": "DBUM Standard SQL Tuning Access UA 8",
"owners": [
{
"id": "globalId.125123c3-xxxx-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b201421b44aa046b3ceb16a",
"name": "Bill Clark",
"isPrimary": true
}
]
}
],
"customAttributes": null,
"displayName": "Database Administrator Role",
"owners": [
{
"id": "globalId.125123c3-xxxx-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b201421b44aa046b3ceb16a",
"name": "Bill Clark",
"isPrimary": true
}
]
}
レスポンス・コードの例
ロールの作成には数秒かかる場合があります。 リクエストを中断しないでください。
次のレスポンス本文とともに200 OKレスポンスを受信します:
{
"id": "7642ff7d-xxxx-45c4-88d4-db7d2e79e85f",
"name": "Database Administrator",
"description": "Responsible for managing database access and ensuring optimized SQL performance.",
"requestableBy": {
"id": "ANY",
"name": "Anyone",
"displayName": "Anyone"
},
"status": "ACTIVE",
"approvalWorkflowId": {
"id": "NO_APPROVAL_REQUIRED",
"name": "No Approval Required",
"displayName": "No Approval Required"
},
"tags": [
"Database Role"
],
"accessBundles": null,
"timeCreated": "2025-04-24T06:55:26.546Z",
"timeUpdated": "2025-04-24T06:55:26.546Z",
"ownershipCollectionId": "b384e140-xxxx-413f-843b-bafc38182db7",
"owners": [
{
"id": "globalId.125123c3-xxxx-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b201421b44aa046b3ceb16a",
"name": "Bill Clark",
"isPrimary": true
}
],
"createdBy": {
"id": "globalId.125123c3-xxxx-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b201421b44aa046b3ceb16a",
"name": "Bill Clark",
"displayName": "Bill Clark"
},
"updatedBy": {
"id": "globalId.125123c3-xxxx-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b201421b44aa046b3ceb16a",
"name": "Bill Clark",
"displayName": "Bill Clark"
},
"customAttributes": null,
"externalId": "ocid1.agcsgovernanceinstance.dev.dev.xxxxxxxxpzw5rdia4pv5rudpgmf5enb2yzcloj2pbd5ogxaructfrhgbuq7a",
"displayName": "Database Admin Role"
}