Get Role
get
/access-governance/access-controls/20250331/roles/{roleId}
Returns details of a role with a given ID.
Request
Path Parameters
-
roleId(required): string
Unique Role identifier
Header Parameters
-
opc-request-id: string
The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.
Response
Supported Media Types
- application/json
200 Response
The Role for the given id
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Role
Type:
object
Role object.
Show Source
-
accessBundles:
array accessBundles
List of Access Bundles
-
approvalWorkflowId:
object IdInfo
Generic identifying information object.
-
createdBy:
object IdInfo
Generic identifying information object.
-
customAttributes:
object customAttributes
Metadata associated with the role
-
description:
string
Description of the Role
-
displayName:
string
Display Name of the Role
-
externalId:
string
ExternalId of the Role
-
id(required):
string
Unique identifier that is immutable on creation
-
name:
string
Name of the Role
-
owners:
array owners
List of owner entities
-
ownershipCollectionId:
string
Ownership collection associate with the Role
-
requestableBy:
object IdInfo
Generic identifying information object.
-
status:
string
Allowed Values:
[ "ACTIVE", "DRAFT", "INACTIVE", "PENDING", "FAILED", "IN_PROGRESS", "SAVED", "SUCCESS", "TIMEOUT" ]
Status of the Role -
tags:
array tags
List of tags attached to the Role
-
timeCreated:
string(date-time)
Time when the Role was created. An RFC3339 formatted datetime string
-
timeUpdated:
string(date-time)
Time when the Role was last updated. An RFC3339 formatted datetime string
-
updatedBy:
object IdInfo
Generic identifying information object.
Nested Schema : accessBundles
Type:
array
List of Access Bundles
Show Source
-
Array of:
object AccessBundle
Access Bundle object.
Nested Schema : IdInfo
Type:
object
Generic identifying information object.
Show Source
-
displayName:
string
Display Name of the entity.
-
id:
string
Id of the entity.
-
name:
string
Name of the entity.
Nested Schema : owners
Type:
array
List of owner entities
Show Source
-
Array of:
object OwnerSummary
Owner entity object
Nested Schema : AccessBundle
Type:
object
Access Bundle object.
Show Source
-
accessGuardrails:
array accessGuardrails
List of access guardrail information attached to the Access Bundle.
-
accountProfileId:
string
Configured account profile id for the access bundle.
-
accountProfileName:
string
configured account profile name for the access bundle.
-
approvalWorkflowId:
object IdInfo
Generic identifying information object.
-
cloudAccountName:
string
Cloud Account name of OCI bundle i.e., OCI tenancy
-
compartmentFqn:
string
Compartment full name of OCI bundle
-
compartmentName:
string
Compartment name of OCI bundle
-
createdBy:
object IdInfo
Generic identifying information object.
-
customAttributes:
object customAttributes
Metadata associated with the access bundle
-
description:
string
Description of the Access Bundle
-
displayName:
string
Display Name of the Access Bundle
-
domainName:
string
Domain name of OCI bundle
-
externalId:
string
ExternalId of the Access Bundle
-
id(required):
string
Unique identifier that is immutable on creation
-
name:
string
Name of the Access Bundle
-
orchestratedSystem:
object IdInfo
Generic identifying information object.
-
orchestratedSystemAttributes:
object OrchestratedSystemAttributeSummary
Account & permission attributes
-
orchestratedSystemType:
string
Orchestrated System type
-
owners:
array owners
List of owner entities
-
ownershipCollectionId:
string
Ownership collection associated with the Access Bundle
-
permissions:
array permissions
List of permissions
-
requestableBy:
object IdInfo
Generic identifying information object.
-
resourceType:
string
Resource Type of an OCI Access Bundle
-
status:
string
Allowed Values:
[ "ACTIVE", "DRAFT", "INACTIVE", "PENDING", "FAILED", "IN_PROGRESS", "SAVED", "SUCCESS", "TIMEOUT" ]
Status of the Access Bundle -
tags:
array tags
List of tags attached to the Access Bundle
-
timeCreated:
string(date-time)
Time when the Access Bundle was created. An RFC3339 formatted datetime string
-
timeUpdated:
string(date-time)
Time when the Access Bundle was last updated. An RFC3339 formatted datetime string
-
updatedBy:
object IdInfo
Generic identifying information object.
Nested Schema : accessGuardrails
Type:
array
List of access guardrail information attached to the Access Bundle.
Show Source
-
Array of:
object AccessGuardrailDetails
Access Guardrail object
Nested Schema : customAttributes
Type:
object
Metadata associated with the access bundle
Show Source
Nested Schema : OrchestratedSystemAttributeSummary
Type:
object
Account & permission attributes
Show Source
-
accountAttributes:
array accountAttributes
List of Orchestrated System account attributes
-
permissionAttributes:
array permissionAttributes
List of Orchestrated System permission attributes
Nested Schema : owners
Type:
array
List of owner entities
Show Source
-
Array of:
object OwnerSummary
Owner entity object
Nested Schema : permissions
Type:
array
List of permissions
Show Source
-
Array of:
object PermissionSummary
Description of Permission.
Nested Schema : AccessGuardrailDetails
Type:
object
Access Guardrail object
Show Source
-
id(required):
string
The access guardrail id
-
name(required):
string
The access guardrail name
Nested Schema : accountAttributes
Type:
array
List of Orchestrated System account attributes
Show Source
-
Array of:
object OrchestratedSystemAttributeDataSummary
Orchestrated System Attributes
Nested Schema : permissionAttributes
Type:
array
List of Orchestrated System permission attributes
Show Source
-
Array of:
object OrchestratedSystemAttributeDataSummary
Orchestrated System Attributes
Nested Schema : OrchestratedSystemAttributeDataSummary
Type:
object
Orchestrated System Attributes
Show Source
-
children:
array children
nested attributes
-
discriminator:
string
this field signify attribute field is password
-
isQuestion:
boolean
Indicates if this Orchestrated System Attribute will be presented as a question.
-
name:
string
Attribute name - Unique identifier
-
permissionType:
string
Permission Type
-
title:
string
Display Name for the attribute.
-
type:
string
Type of attribute
-
values:
array values
Attribute Values
Nested Schema : children
Type:
array
nested attributes
Show Source
-
Array of:
object NestedAttributesSummary
Nested set of Orchestrated System attributes
Nested Schema : NestedAttributesSummary
Type:
object
Nested set of Orchestrated System attributes
Show Source
-
items:
array items
Orchestrated System attributes
Nested Schema : items
Type:
array
Orchestrated System attributes
Show Source
-
Array of:
object OrchestratedSystemAttributeDataSummary
Orchestrated System Attributes
Nested Schema : OwnerSummary
Type:
object
Owner entity object
Show Source
-
id(required):
string
Unique identifier that is immutable on creation
-
isPrimary(required):
boolean
Is this entity the primary owner?
-
name(required):
string
Name of the owner
Nested Schema : PermissionSummary
Type:
object
Description of Permission.
Show Source
-
description:
string
Description of the permission
-
id(required):
string
The Unique Oracle ID (OCID) that is immutable on creation
-
name:
string
Name of the permission
-
permissionType:
object PermissionTypeSummary
PermissionType Summary.
-
resource:
object ResourceSummary
Resource Summary.
-
timeCreated:
string(date-time)
Time when the permission was last created. An RFC3339 formatted datetime string
-
timeUpdated:
string(date-time)
Time when the permission was last updated. An RFC3339 formatted datetime string
-
type:
string
Type of the permission
Nested Schema : PermissionTypeSummary
Type:
object
PermissionType Summary.
Show Source
-
displayName:
string
Display Name of the PermissionType.
-
externalId:
string
External Id of the PermissionType
-
id:
string
The Unique Oracle ID (OCID) that is immutable on creation.
-
name:
string
name of the PermissionType.
Nested Schema : ResourceSummary
Type:
object
Resource Summary.
Show Source
-
customAttributes:
object customAttributes
Metadata associated with the resource
-
displayName:
string
Display Name of the Resource.
-
id(required):
string
The Unique Oracle ID (OCID) that is immutable on creation.
-
name:
string
name of the Resource.
-
type:
string
Type of the Resource
400 Response
Bad Request
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
Error Information.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing.
-
message(required):
string
A human-readable error string.
401 Response
Unauthorized
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
Error Information.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing.
-
message(required):
string
A human-readable error string.
404 Response
Not Found
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
Error Information.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing.
-
message(required):
string
A human-readable error string.
429 Response
Too Many Requests
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
Error Information.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing.
-
message(required):
string
A human-readable error string.
500 Response
Internal Server Error
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
Error Information.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing.
-
message(required):
string
A human-readable error string.
Default Response
Unknown Error
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
Error Information.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing.
-
message(required):
string
A human-readable error string.
Examples
The following example shows how to retrieve details of a specific role. Replace placeholder values with the actual values.
cURL Example - Without Query Parameters
curl -i -X GET \
-H "Authorization:Bearer <your access token>" \
'https://<host>/access-governance/access-controls/20250331/roles/${roleId}'
Example of the Response Body
The following example shows the contents of the response body in JSON format:
{
"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"
}