Oracle Access Governance REST API

機械翻訳について

ロールの取得

get

/access-governance/access-controls/20250331/roles/{roleId}

指定されたIDを持つロールの詳細を返します。

リクエスト

パス・パラメータ

roleId(必須): string

一意のロール識別子

ヘッダー・パラメータ

opc-request-id: string

トレース用のクライアント・リクエストID。リクエストIDに有効な文字は、文字、数字、アンダースコアおよびダッシュのみです。

トップに戻る

レスポンス

サポートされているメディア・タイプ

application/json

200レスポンス

指定されたIDのロール

ヘッダー

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

汎用識別情報オブジェクト。

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier that is immutable on creation"
        },
        "name":{
            "type":"string",
            "description":"Name of the Role"
        },
        "description":{
            "type":"string",
            "description":"Description of the Role"
        },
        "requestableBy":{
            "$ref":"#/definitions/IdInfo"
        },
        "status":{
            "type":"string",
            "description":"Status of the Role",
            "enum":[
                "ACTIVE",
                "DRAFT",
                "INACTIVE",
                "PENDING",
                "FAILED",
                "IN_PROGRESS",
                "SAVED",
                "SUCCESS",
                "TIMEOUT"
            ],
            "x-obmcs-top-level-enum":"#/definitions/EntityStatus",
            "x-default-description":"ACTIVE"
        },
        "approvalWorkflowId":{
            "$ref":"#/definitions/IdInfo"
        },
        "tags":{
            "type":"array",
            "description":"List of tags attached to the Role",
            "items":{
                "type":"string"
            }
        },
        "accessBundles":{
            "type":"array",
            "description":"List of Access Bundles",
            "items":{
                "$ref":"#/definitions/AccessBundle"
            }
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the Role was created. An RFC3339 formatted datetime string"
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the Role was last updated. An RFC3339 formatted datetime string"
        },
        "ownershipCollectionId":{
            "type":"string",
            "description":"Ownership collection associate with the Role"
        },
        "owners":{
            "type":"array",
            "description":"List of owner entities",
            "items":{
                "$ref":"#/definitions/OwnerSummary"
            }
        },
        "createdBy":{
            "$ref":"#/definitions/IdInfo"
        },
        "updatedBy":{
            "$ref":"#/definitions/IdInfo"
        },
        "customAttributes":{
            "type":"object",
            "description":"Metadata associated with the role",
            "properties":{
            }
        },
        "externalId":{
            "type":"string",
            "description":"ExternalId of the Role"
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of the Role"
        }
    },
    "description":"Role object."
}

ネストされたスキーマ : accessBundles

型: array

アクセス・バンドルのリスト

ソースを表示

Array of: object AccessBundle

バンドル・オブジェクトにアクセスします。

{
    "type":"array",
    "description":"List of Access Bundles",
    "items":{
        "$ref":"#/definitions/AccessBundle"
    }
}

ネストされたスキーマ : IdInfo

型: object

汎用識別情報オブジェクト。

ソースを表示

displayName: string

エンティティの表示名。
id: string

エンティティのID。
name: string

エンティティの名前。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id of the entity."
        },
        "name":{
            "type":"string",
            "description":"Name of the entity."
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of the entity."
        }
    },
    "description":"Generic identifying information object."
}

ネストされたスキーマ : customAttributes

型: object

ロールに関連付けられたメタデータ

ソースを表示

{
    "type":"object",
    "description":"Metadata associated with the role",
    "properties":{
    }
}

ネストされたスキーマ: owner

型: array

所有者エンティティのリスト

ソースを表示

Array of: object OwnerSummary

所有者エンティティ・オブジェクト

{
    "type":"array",
    "description":"List of owner entities",
    "items":{
        "$ref":"#/definitions/OwnerSummary"
    }
}

ネストされたスキーマ: tags

型: array

ロールに添付されたタグのリスト

ソースを表示

Array of: string

{
    "type":"array",
    "description":"List of tags attached to the Role",
    "items":{
        "type":"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

汎用識別情報オブジェクト。

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier that is immutable on creation."
        },
        "name":{
            "type":"string",
            "description":"Name of the Access Bundle."
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of the Access Bundle."
        },
        "description":{
            "type":"string",
            "description":"Description of the Access Bundle."
        },
        "tags":{
            "type":"array",
            "description":"List of tags attached to the Access Bundle.",
            "items":{
                "type":"string"
            }
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the Access Bundle was created. An RFC3339 formatted datetime string."
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the Access Bundle was last updated. An RFC3339 formatted datetime string."
        },
        "createdBy":{
            "$ref":"#/definitions/IdInfo"
        },
        "updatedBy":{
            "$ref":"#/definitions/IdInfo"
        },
        "requestableBy":{
            "$ref":"#/definitions/IdInfo"
        },
        "status":{
            "type":"string",
            "description":"Status of the Access Bundle.",
            "enum":[
                "ACTIVE",
                "DRAFT",
                "INACTIVE",
                "PENDING",
                "FAILED",
                "IN_PROGRESS",
                "SAVED",
                "SUCCESS",
                "TIMEOUT"
            ],
            "x-obmcs-top-level-enum":"#/definitions/EntityStatus",
            "x-default-description":"ACTIVE"
        },
        "approvalWorkflowId":{
            "$ref":"#/definitions/IdInfo"
        },
        "orchestratedSystem":{
            "$ref":"#/definitions/IdInfo"
        },
        "orchestratedSystemType":{
            "type":"string",
            "description":"Orchestrated System type."
        },
        "ownershipCollectionId":{
            "type":"string",
            "description":"Ownership collection associated with the Access Bundle."
        },
        "owners":{
            "type":"array",
            "description":"List of owner entities.",
            "items":{
                "$ref":"#/definitions/OwnerSummary"
            }
        },
        "externalId":{
            "type":"string",
            "description":"ExternalId of the Access Bundle."
        },
        "cloudAccountName":{
            "type":"string",
            "description":"Cloud Account name of OCI bundle i.e., OCI tenancy."
        },
        "domainName":{
            "type":"string",
            "description":"Domain name of OCI bundle."
        },
        "resourceType":{
            "type":"string",
            "description":"Resource Type of an OCI Access Bundle."
        },
        "compartmentName":{
            "type":"string",
            "description":"Compartment name of OCI bundle."
        },
        "compartmentFqn":{
            "type":"string",
            "description":"Compartment full name of OCI bundle."
        },
        "orchestratedSystemAttributes":{
            "$ref":"#/definitions/OrchestratedSystemAttributeSummary"
        },
        "accountProfileId":{
            "type":"string",
            "description":"Configured account profile id for the access bundle."
        },
        "accountProfileName":{
            "type":"string",
            "description":"configured account profile name for the access bundle."
        },
        "customAttributes":{
            "type":"object",
            "description":"Metadata associated with the access bundle.",
            "properties":{
            }
        },
        "accessGuardrail":{
            "$ref":"#/definitions/AccessGuardrailDetails"
        },
        "permissions":{
            "type":"array",
            "description":"List of permissions",
            "items":{
                "$ref":"#/definitions/PermissionSummary"
            }
        },
        "autoApproveIfNoViolation":{
            "type":"boolean",
            "description":"Boolean flag to indicate auto approve if no violation in access request to the Access Bundle."
        },
        "accessTimeLimitType":{
            "type":"string",
            "description":"Time limit type of the access bundle.",
            "enum":[
                "INDEFINITELY",
                "NUMBER_OF_DAYS",
                "NUMBER_OF_HOURS"
            ],
            "x-obmcs-top-level-enum":"#/definitions/AccessBundleTimeLimitType",
            "x-default-description":"INDEFINITELY"
        },
        "accessTimeLimit":{
            "$ref":"#/definitions/AccessBundleTimeLimit"
        }
    },
    "description":"Access Bundle object."
}

ネストされたスキーマ : AccessGuardrailDetails

型: object

Guardrailオブジェクトにアクセスします。

ソースを表示

id(必須): string

アクセス・ガード・レールID。
name(required): string

アクセス・ガード・レール名。

{
    "type":"object",
    "required":[
        "id",
        "name"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The access guardrail id."
        },
        "name":{
            "type":"string",
            "description":"The access guardrail name."
        }
    },
    "description":"Access Guardrail object."
}

ネストされたスキーマ : AccessBundleTimeLimit

型: object

時間制限の定義。 daysLimit、hoursLimitまたはdateTimeLimitのいずれか1つのみを指定する必要があります。

ソースを表示

daysLimit: object AccessBundleTimeLimitDays

時間制限の定義(日数)。
hoursLimit: object AccessBundleTimeLimitHours

時間制限の定義(時間)。

{
    "type":"object",
    "properties":{
        "daysLimit":{
            "$ref":"#/definitions/AccessBundleTimeLimitDays"
        },
        "hoursLimit":{
            "$ref":"#/definitions/AccessBundleTimeLimitHours"
        }
    },
    "description":"Time limit definition. Only one of daysLimit, hoursLimit, or dateTimeLimit should be specified.\n"
}

ネストされたスキーマ : customAttributes

型: object

アクセス・バンドルに関連付けられたメタデータ。

ソースを表示

{
    "type":"object",
    "description":"Metadata associated with the access bundle.",
    "properties":{
    }
}

ネストされたスキーマ : OrchestratedSystemAttributeSummary

型: object

アカウント属性と権限属性。

ソースを表示

accountAttributes: array accountAttributes

オーケストレーション済システム・アカウント属性のリスト。
permissionAttributes: array permissionAttributes

オーケストレート済システム権限属性のリスト。

{
    "type":"object",
    "properties":{
        "accountAttributes":{
            "type":"array",
            "description":"List of Orchestrated System account attributes.",
            "items":{
                "$ref":"#/definitions/OrchestratedSystemAttributeDataSummary"
            }
        },
        "permissionAttributes":{
            "type":"array",
            "description":"List of Orchestrated System permission attributes.",
            "items":{
                "$ref":"#/definitions/OrchestratedSystemAttributeDataSummary"
            }
        }
    },
    "description":"Account & permission attributes."
}

ネストされたスキーマ: owner

型: array

所有者エンティティのリスト。

ソースを表示

Array of: object OwnerSummary

所有者エンティティ・オブジェクト

{
    "type":"array",
    "description":"List of owner entities.",
    "items":{
        "$ref":"#/definitions/OwnerSummary"
    }
}

ネストされたスキーマ : 許可

型: array

権限のリスト

ソースを表示

Array of: object PermissionSummary

権限の説明。

{
    "type":"array",
    "description":"List of permissions",
    "items":{
        "$ref":"#/definitions/PermissionSummary"
    }
}

ネストされたスキーマ: tags

型: array

アクセス・バンドルに添付されたタグのリスト。

ソースを表示

Array of: string

{
    "type":"array",
    "description":"List of tags attached to the Access Bundle.",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ : AccessBundleTimeLimitDays

型: object

時間制限の定義(日数)。

ソースを表示

accessLimitInDays(required): integer

最小値: 1

最大値: 365

失効までに許可される最大日数。
extensionApprovalWorkflowId(required): object IdInfo

汎用識別情報オブジェクト。
extensionInDays(required): integer

最小値: 1

最大値: 90

拡張が許可される日数。
notificationInDays(required): integer

最小値: 1

最大値: 30

通知を送信する日数。

{
    "type":"object",
    "required":[
        "accessLimitInDays",
        "extensionApprovalWorkflowId",
        "extensionInDays",
        "notificationInDays"
    ],
    "properties":{
        "accessLimitInDays":{
            "type":"integer",
            "description":"Maximum number of days allowed before expiry.",
            "minimum":1,
            "maximum":365
        },
        "notificationInDays":{
            "type":"integer",
            "description":"Number of days when notification should be sent.",
            "minimum":1,
            "maximum":30
        },
        "extensionInDays":{
            "type":"integer",
            "description":"Number of days extensions is allowed.",
            "minimum":1,
            "maximum":90
        },
        "extensionApprovalWorkflowId":{
            "$ref":"#/definitions/IdInfo"
        }
    },
    "description":"Time limit definition in days."
}

ネストされたスキーマ : AccessBundleTimeLimitHours

型: object

時間制限の定義(時間)。

ソースを表示

accessLimitInHours(required): integer

最小値: 1

最大値: 24

失効までに許可される最大時間数。
extensionApprovalWorkflowId(required): object IdInfo

汎用識別情報オブジェクト。
extensionInHours(required): integer

最小値: 1

最大値: 8

時間数の延長が許可されています。
notificationInHours(required): integer

最小値: 1

最大値: 24

通知を送信する時間数。

{
    "type":"object",
    "required":[
        "accessLimitInHours",
        "extensionApprovalWorkflowId",
        "extensionInHours",
        "notificationInHours"
    ],
    "properties":{
        "accessLimitInHours":{
            "type":"integer",
            "description":"Maximum number of hours allowed before expiry.",
            "minimum":1,
            "maximum":24
        },
        "notificationInHours":{
            "type":"integer",
            "description":"Number of hours when notification should be sent.",
            "minimum":1,
            "maximum":24
        },
        "extensionInHours":{
            "type":"integer",
            "description":"Number of hours extension is allowed.",
            "minimum":1,
            "maximum":8
        },
        "extensionApprovalWorkflowId":{
            "$ref":"#/definitions/IdInfo"
        }
    },
    "description":"Time limit definition in hours."
}

ネストされたスキーマ : accountAttributes

型: array

オーケストレーション済システム・アカウント属性のリスト。

ソースを表示

Array of: object OrchestratedSystemAttributeDataSummary

オーケストレーション・システム属性

{
    "type":"array",
    "description":"List of Orchestrated System account attributes.",
    "items":{
        "$ref":"#/definitions/OrchestratedSystemAttributeDataSummary"
    }
}

ネストされたスキーマ : permissionAttributes

型: array

オーケストレート済システム権限属性のリスト。

ソースを表示

Array of: object OrchestratedSystemAttributeDataSummary

オーケストレーション・システム属性

{
    "type":"array",
    "description":"List of Orchestrated System permission attributes.",
    "items":{
        "$ref":"#/definitions/OrchestratedSystemAttributeDataSummary"
    }
}

ネストされたスキーマ : OrchestratedSystemAttributeDataSummary

型: object

オーケストレーション・システム属性

ソースを表示

children: array children

ネストされた属性
discriminator: string

このフィールドは、属性フィールドがパスワードであることを示します
isQuestion: boolean

このオーケストレーション・システム属性が質問として表示されるかどうかを示します。
name: string

属性名 - 一意の識別子
permissionType: string

パーミッション・タイプ
title: string

属性の表示名。
type: string

属性のタイプ
values: array values

属性値

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Attribute name - Unique identifier"
        },
        "title":{
            "type":"string",
            "description":"Display Name for the attribute."
        },
        "values":{
            "type":"array",
            "description":"Attribute Values",
            "items":{
                "type":"string"
            }
        },
        "type":{
            "type":"string",
            "description":"Type of attribute"
        },
        "permissionType":{
            "type":"string",
            "description":"Permission Type"
        },
        "children":{
            "type":"array",
            "description":"nested attributes",
            "items":{
                "$ref":"#/definitions/NestedAttributesSummary"
            }
        },
        "discriminator":{
            "type":"string",
            "description":"this field signify attribute field is password"
        },
        "isQuestion":{
            "type":"boolean",
            "description":"Indicates if this Orchestrated System Attribute will be presented as a question."
        }
    },
    "description":"Orchestrated System Attributes"
}

ネストされたスキーマ: children

型: array

ネストされた属性

ソースを表示

Array of: object NestedAttributesSummary

オーケストレーション・システム属性のネストされたセット

{
    "type":"array",
    "description":"nested attributes",
    "items":{
        "$ref":"#/definitions/NestedAttributesSummary"
    }
}

ネストされたスキーマ: values

型: array

属性値

ソースを表示

Array of: string

{
    "type":"array",
    "description":"Attribute Values",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ : NestedAttributesSummary

型: object

オーケストレーション・システム属性のネストされたセット

ソースを表示

items: array items

オーケストレーションされたシステム属性

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"Orchestrated System attributes",
            "items":{
                "$ref":"#/definitions/OrchestratedSystemAttributeDataSummary"
            }
        }
    },
    "description":"Nested set of Orchestrated System attributes"
}

ネストされたスキーマ: items

型: array

オーケストレーションされたシステム属性

ソースを表示

Array of: object OrchestratedSystemAttributeDataSummary

オーケストレーション・システム属性

{
    "type":"array",
    "description":"Orchestrated System attributes",
    "items":{
        "$ref":"#/definitions/OrchestratedSystemAttributeDataSummary"
    }
}

ネストされたスキーマ : OwnerSummary

型: object

所有者エンティティ・オブジェクト

ソースを表示

id(必須): string

作成時に変更できない一意の識別子
isPrimary(required): boolean

このエンティティはプライマリ所有者ですか?
name(required): string

所有者の名前

{
    "type":"object",
    "required":[
        "id",
        "isPrimary",
        "name"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier that is immutable on creation"
        },
        "name":{
            "type":"string",
            "description":"Name of the owner"
        },
        "isPrimary":{
            "type":"boolean",
            "description":"Is this entity the primary owner?"
        }
    },
    "description":"Owner entity object"
}

ネストされたスキーマ : 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

権限のタイプ

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The Unique Oracle ID (OCID) that is immutable on creation"
        },
        "name":{
            "type":"string",
            "description":"Name of the permission"
        },
        "description":{
            "type":"string",
            "description":"Description of the permission"
        },
        "type":{
            "type":"string",
            "description":"Type of the permission"
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the permission was last created. An RFC3339 formatted datetime string"
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the permission was last updated. An RFC3339 formatted datetime string"
        },
        "resource":{
            "$ref":"#/definitions/ResourceSummary"
        },
        "permissionType":{
            "$ref":"#/definitions/PermissionTypeSummary"
        }
    },
    "description":"Description of Permission."
}

ネストされたスキーマ : PermissionTypeSummary

型: object

PermissionTypeサマリー。

ソースを表示

displayName: string

PermissionTypeの表示名。
externalId: string

PermissionTypeの外部ID
id: string

作成時に不変である一意のOracle ID (OCID)。
name: string

PermissionTypeの名前。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The Unique Oracle ID (OCID) that is immutable on creation."
        },
        "name":{
            "type":"string",
            "description":"name of the PermissionType."
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of the PermissionType."
        },
        "externalId":{
            "type":"string",
            "description":"External Id of the PermissionType"
        }
    },
    "description":"PermissionType Summary."
}

ネストされたスキーマ : ResourceSummary

型: object

資源要約

ソースを表示

customAttributes: object customAttributes

リソースに関連付けられたメタデータ
displayName: string

リソースの表示名。
id(必須): string

作成時に不変である一意のOracle ID (OCID)。
name: string

リソースの名前。
type: string

リソースのタイプ

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The Unique Oracle ID (OCID) that is immutable on creation."
        },
        "name":{
            "type":"string",
            "description":"name of the Resource."
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of the Resource."
        },
        "type":{
            "type":"string",
            "description":"Type of the Resource"
        },
        "customAttributes":{
            "type":"object",
            "description":"Metadata associated with the resource",
            "properties":{
            }
        }
    },
    "description":"Resource Summary."
}

ネストされたスキーマ : customAttributes

型: object

リソースに関連付けられたメタデータ

ソースを表示

{
    "type":"object",
    "description":"Metadata associated with the resource",
    "properties":{
    }
}

400レスポンス

不正なリクエスト

ヘッダー

opc-request-id: string

リクエストに対するOracleで割り当てられた一意の識別子。特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

code(必須): string

プログラム解析用のエラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

401レスポンス

未認可

ヘッダー

opc-request-id: string

リクエストに対するOracleで割り当てられた一意の識別子。特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

code(必須): string

プログラム解析用のエラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

404レスポンス

見つかりません

ヘッダー

opc-request-id: string

リクエストに対するOracleで割り当てられた一意の識別子。特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

code(必須): string

プログラム解析用のエラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

429レスポンス

リクエストが多すぎます

ヘッダー

opc-request-id: string

リクエストに対するOracleで割り当てられた一意の識別子。特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

code(必須): string

プログラム解析用のエラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

500レスポンス

内部サーバー・エラー

ヘッダー

opc-request-id: string

リクエストに対するOracleで割り当てられた一意の識別子。特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

code(必須): string

プログラム解析用のエラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

デフォルト・レスポンス

不明なエラー

ヘッダー

opc-request-id: string

リクエストに対するOracleで割り当てられた一意の識別子。特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

code(必須): string

プログラム解析用のエラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

トップに戻る

例

次の例は、特定のロールの詳細を取得する方法を示しています。プレースホルダー値を実際の値に置き換えます。

cURL例 - 問合せパラメータなし

curl -i -X GET \
   -H "Authorization:Bearer <your access token>" \
 'https://<host>/access-governance/access-controls/20250331/roles/${roleId}'

レスポンス本文の例

JSON形式のレスポンス本文のコンテンツの例を次に示します。

{
  "id": "a5ee5a10-xxxx-4882-8ff9-c5277e94f9ce",
  "name": "UA External API Access Controller",
  "description": "Role for controlling acesses and permissions.",
  "requestableBy": {
    "id": "ANY",
    "name": "Anyone",
    "displayName": "Anyone"
  },
  "status": "ACTIVE",
  "approvalWorkflowId": {
    "id": "NO_APPROVAL_REQUIRED",
    "name": "No Approval Required",
    "displayName": "No Approval Required"
  },
  "tags": ["UA Role"],
  "accessBundles": null,
  "timeCreated": "2025-04-24T06:27:26.011Z",
  "timeUpdated": "2025-04-24T06:27:26.011Z",
  "ownershipCollectionId": "040a8a2b-xxxx-419b-95a5-36e1f7193c5b",
  "owners": [
    {
      "id": "globalId.125123c3-xxxx-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b201421b44aa046b3ceb16a",
      "name": "Amel Maclead",
      "isPrimary": true
    }
  ],
  "createdBy": {
    "id": "globalId.125123c3-xxxx-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b201421b44aa046b3ceb16a",
    "name": "Amel Maclead",
    "displayName": "Amel Maclead"
  },
  "updatedBy": {
    "id": "globalId.125123c3-xxxx-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b201421b44aa046b3ceb16a",
    "name": "Amel Maclead",
    "displayName": "Amel Maclead"
  },
  "customAttributes": null,
  "externalId": "ocid1.agcsgovernanceinstance.dev.dev.xxxxxxxxpzw5rdia4pv5rudpgmf5enb2yzcloj2pbd5ogxaructfrhgbuq7a",
  "displayName": "Dev Role Access Manager"
}

先頭に戻る