Create an Access Request
post
/access-governance/access-controls/20250331/accessRequests
Creates a new access request for an identity with the specified details.
Request
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.
Details for the new Access Request
Root Schema : CreateAccessRequestDetails
Type:
object
The information about new AccessRequest.
Show Source
-
accessBundles:
array accessBundles
list of Access bundle items.
-
accountProfileDetails:
array accountProfileDetails
list of account profiles associated to access request
-
attributes:
object attributes
Additional Properties Allowed: additionalPropertiesAttributes of the corresponding model. Example: `{"foo-namespace": {"bar-key": "value"}}`
-
createdBy:
string
The user that created the request
-
identities:
array identities
list of identity ids
-
justification:
string
Justification for creating the access request
-
permissionRoles:
array permissionRoles
list of Permission roles items.
-
requestStatus:
string
Status of the access request
-
targetAttributes:
array targetAttributes
list of targetAttributes associated with targets
Nested Schema : accessBundles
Type:
array
list of Access bundle items.
Show Source
-
Array of:
object AccessBundleInfo
Generic information object.
Nested Schema : accountProfileDetails
Type:
array
list of account profiles associated to access request
Show Source
-
Array of:
object AccountProfileInfo
Account Profile Configuration by Identity
Nested Schema : attributes
Type:
object
Additional Properties Allowed
Show Source
Attributes of the corresponding model.
Example: `{"foo-namespace": {"bar-key": "value"}}`
Nested Schema : identities
Type:
array
list of identity ids
Show Source
-
Array of:
object Info
Generic information object.
Nested Schema : permissionRoles
Type:
array
list of Permission roles items.
Show Source
-
Array of:
object Info
Generic information object.
Nested Schema : targetAttributes
Type:
array
list of targetAttributes associated with targets
Show Source
-
Array of:
object TargetAttribute
Account & entitlement attributes
Nested Schema : AccessBundleInfo
Type:
object
Generic information object.
Show Source
-
accountProfileId:
string
account profile id
-
displayName:
string
display name of the entity
-
id:
string
id of the entity.
-
name:
string
name of the entity.
Nested Schema : AccountProfileInfo
Type:
object
Account Profile Configuration by Identity
Show Source
-
accountAttributes:
array accountAttributes
Account Attribute Values
-
accountProfileId:
string
Account Profile Id
-
identityAccountAttributesDetails:
array identityAccountAttributesDetails
Account Attributes Info by Identity
-
identitySpecific:
boolean
Same configuration for all identities.
Nested Schema : accountAttributes
Type:
array
Account Attribute Values
Show Source
-
Array of:
object TargetAttributeDataSummary
Target Attributes
Nested Schema : identityAccountAttributesDetails
Type:
array
Account Attributes Info by Identity
Show Source
-
Array of:
object IdentityAccountAttributesInfo
Account Profile Attributes
Nested Schema : TargetAttributeDataSummary
Type:
object
Target Attributes
Show Source
-
children:
array children
nested attributes
-
discriminator:
string
this field signify attribute field is password
-
entitlementType:
string
Entitlement Type
-
isQuestion:
boolean
Boolean value for checking if this is attribute is a question for requester.
-
name:
string
Attribute name - Unique identifier
-
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 : 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 : IdentityAccountAttributesInfo
Type:
object
Account Profile Attributes
Show Source
-
accountAttributes:
array accountAttributes
Account Attribute Values
-
identityId:
string
Global Identity Id
Nested Schema : accountAttributes
Type:
array
Account Attribute Values
Show Source
-
Array of:
object TargetAttributeDataSummary
Target Attributes
Nested Schema : Info
Type:
object
Generic 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 : TargetAttribute
Type:
object
Account & entitlement attributes
Show Source
-
accountAttributes:
array accountAttributes
List of target account attributes
-
displayName:
string
displayName of the object class
-
entitlementAttributes:
array entitlementAttributes
List of target entitlement attributes
-
objectClass:
string
Name of the object class
-
target(required):
object Info
Generic information object.
Nested Schema : accountAttributes
Type:
array
List of target account attributes
Show Source
-
Array of:
object TargetAttributeData
Target Attributes
Nested Schema : entitlementAttributes
Type:
array
List of target entitlement attributes
Show Source
-
Array of:
object TargetAttributeData
Target Attributes
Nested Schema : TargetAttributeData
Type:
object
Target Attributes
Show Source
-
discriminator:
string
this field signify attribute field is password
-
entitlementType:
string
Entitlement Type
-
lookupType:
string
LookUpID for the attribute
-
name:
string
Attribute name
-
required:
boolean
Is this attribute mandatory
-
type:
string
Type of attribute
Response
Supported Media Types
- application/json
200 Response
The newly created Access Request
Headers
-
etag: string
For optimistic concurrency control. See `if-match`.
-
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 : AccessRequest
Type:
object
Description of AccessRequest.
Show Source
-
accessBundles:
array accessBundles
list of Access bundle items.
-
attributes:
object attributes
Additional Properties Allowed: additionalPropertiesAttributes of the corresponding model. Example: `{"foo-namespace": {"bar-key": "value"}}`
-
createdBy:
string
The user that created the request
-
id(required):
string
The Unique Oracle ID (OCID) that is immutable on creation.
-
identities:
array identities
list of identities
-
justification:
string
Justification for creating or updating the access request
-
permissionRoles:
array permissionRoles
list of Permission roles items.
-
requestStatus:
string
Status of the access request
-
timeCreated:
string(date-time)
The time the the AccessRequest was created. An RFC3339 formatted datetime string
-
timeUpdated:
string(date-time)
The time the the AccessRequest was last updated. An RFC3339 formatted datetime string
Nested Schema : accessBundles
Type:
array
list of Access bundle items.
Show Source
-
Array of:
object AccessBundleInfo
Generic information object.
Nested Schema : attributes
Type:
object
Additional Properties Allowed
Show Source
Attributes of the corresponding model.
Example: `{"foo-namespace": {"bar-key": "value"}}`
Nested Schema : identities
Type:
array
list of identities
Show Source
-
Array of:
object Info
Generic information object.
Nested Schema : permissionRoles
Type:
array
list of Permission roles items.
Show Source
-
Array of:
object Info
Generic information object.
Nested Schema : AccessBundleInfo
Type:
object
Generic information object.
Show Source
-
accountProfileId:
string
account profile id
-
displayName:
string
display name of the entity
-
id:
string
id of the entity.
-
name:
string
name of the entity.
Nested Schema : Info
Type:
object
Generic information object.
Show Source
-
displayName:
string
Display Name of the entity.
-
id:
string
id of the entity.
-
name:
string
name of the entity.
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.
409 Response
Conflict
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.