Activate an Access Bundle
patch
/access-governance/access-controls/20250331/accessBundles/{accessBundleId}/activate
Activates an access bundle currently in draft state with a given ID.
An error will be returned if the Access Bundle is not currently in DRAFT status.
Request
Path Parameters
-
accessBundleId(required): string
A filter to be used for finding Access Bundles with the given id. Available values can be found using the ListAccessBundles operation.
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 activated Access Bundle
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 : 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 : 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 : 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.
412 Response
Precondition failed
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 send a patch request to activate an access bundle. After running this API, the Access Bundle status should change from Draft to Active.
cURL Example PATCH
curl -i -X \
PATCH \
-H \
"Authorization:Bearer <your access token>" \
-d \
'' \
'${service-instance-url}/access-governance/access-controls/20250331/accessBundles/${accessBundleId}/activate'
Example of the Response Code
You'll receive a 200 OK Response code with the following Response body:
{
"accessBundleType" : "PERMISSION_BUNDLE",
"id" : "787190ce-b440-4619-a020-88a1xxx995",
"name" : "AD-Basic-Permissions",
"displayName" : "AD-Basic-Permissions",
"description" : "",
"tags" : [ "REST API UA" ],
"timeCreated" : "2025-03-21T16:50:28.624Z",
"timeUpdated" : "2025-03-21T16:52:02.609Z",
"createdBy" : {
"id" : "globalId.125123c3-eedc-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4xxxxxb44aa046b3ceb16a",
"name" : "Amel Maclead",
"displayName" : "Amel Maclead"
},
"updatedBy" : {
"id" : "globalId.125123c3-eedc-4d6a-b6d4-6c0f6537bad2.18.02e36bccxxx21b44aa046b3ceb16a",
"name" : "Amel Maclead",
"displayName" : "Amel Maclead"
},
"requestableBy" : {
"id" : "ANY",
"name" : "Anyone",
"displayName" : "Anyone"
},
"status" : "ACTIVE",
"approvalWorkflowId" : {
"id" : "NO_APPROVAL_REQUIRED",
"name" : "No Approval Required",
"displayName" : "No Approval Required"
},
"orchestratedSystem" : {
"id" : "e4aa3f66-9eed-4a25-b8cc-a04c3fb2d84a",
"name" : "AD System AG_App_Owner_Admin",
"displayName" : "AD System AG_App_Owner_Admin"
},
"orchestratedSystemType" : "ICF",
"ownershipCollectionId" : "6957a649-308b-408f-b0f1-aa675dcfa07d",
"owners" : [ {
"id" : "globalId.125123c3-eedc-4d6a-b6d4-6c0f6537bad2.18.02e36bbxxxxb44aa046b3ceb16a",
"name" : "Amel Maclead",
"isPrimary" : true
} ],
"externalId" : "ocid1.agcsgovernanceinstance.dev.dev.amaaaaaapzw5rdiaxxxxmf5enb2yzcloj2pbd5ogxaructfrhgbuq7a",
"cloudAccountName" : null,
"domainName" : null,
"resourceType" : null,
"compartmentName" : null,
"compartmentFqn" : null,
"customAttributes" : { },
"permissions" : [ {
"id" : "groups.ICF.e4aa3f66-9eed-4a25-b8cc-a04c3fb2d84a.95dexxxxf8af649d7709915e0",
"name" : "AD_JML_GRP1",
"description" : null,
"type" : "ENTITLEMENTS",
"timeCreated" : "2024-08-12T13:44:07.205Z",
"timeUpdated" : null,
"resource" : {
"id" : "resource.ICF.e4aa3f66-9eed-4a25-b8cc-a04c3fb2d84a.e427xxxxxxxxx7f067fc39be6f",
"name" : "AD System AG_App_Owner_Admin",
"displayName" : "AD System AG_App_Owner_Admin",
"type" : "AD",
"customAttributes" : null
},
"permissionType" : {
"id" : "etype.ICF.e4aa3f66-9eed-4a25-b8cc-a04c3fb2d84a.936d9xxxxxx01c59cdaeaa3",
"name" : "icf.connector.entitlement.type.groups",
"displayName" : "Group",
"externalId" : "groups"
}
}, {
"id" : "groups.ICF.e4aa3f66-9eed-4a25-b8cc-a04c3fb2d84a.edba9xxxxxx99d1a944",
"name" : "AD_JML_PERSONAS1",
"description" : null,
"type" : "ENTITLEMENTS",
"timeCreated" : "2024-08-12T14:34:43.034Z",
"timeUpdated" : null,
"resource" : {
"id" : "resource.ICF.e4aa3f66-9eed-4a25-b8cc-a04c3fb2d84a.e427125e46e48xxxxx7fc39be6f",
"name" : "AD System AG_App_Owner_Admin",
"displayName" : "AD System AG_App_Owner_Admin",
"type" : "AD",
"customAttributes" : null
},
"permissionType" : {
"id" : "etype.ICF.e4aa3f66-9eed-4a25-b8cc-a04c3fb2d84a.936d9be0ce4c3ce91d9401c59cdaeaa3",
"name" : "icf.connector.entitlement.type.groups",
"displayName" : "Group",
"externalId" : "groups"
}
} ]
}