openapi: 3.2.0 info: description: Use the Oracle Access Governance API to create, view, and manage GovernanceInstances. title: Access Governance Access Governance CP API version: '20220518' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/a5cdce2cc56dddfbf507db56ef7e68c5117ef46ee84978f4fec55266d58aa370.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Access Governance APIs OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/a5cdce2cc56dddfbf507db56ef7e68c5117ef46ee84978f4fec55266d58aa370.yaml what: the harvested document for Access Governance APIs servers: - url: http://127.0.0.1/20220518 - url: https://127.0.0.1/20220518 tags: - name: accessGovernanceCP paths: /governanceInstances: get: description: 'Returns a list of Governance Instances. ' operationId: ListGovernanceInstances parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/InstanceLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/AccessGovernanceIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/InstanceSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of GovernanceInstance objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/GovernanceInstanceCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all GovernanceInstances in a compartment tags: - accessGovernanceCP x-related-resource: '#/definitions/GovernanceInstanceCollection' post: description: 'Creates a new GovernanceInstance. ' operationId: CreateGovernanceInstance parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The GovernanceInstance will be created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/GovernanceInstance' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new GovernanceInstance. tags: - accessGovernanceCP x-related-resource: '#/definitions/GovernanceInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateGovernanceInstanceDetails' description: The details of a new GovernanceInstance. required: true /governanceInstances/configuration: get: description: Gets the tenancy-wide configuration for GovernanceInstances operationId: GetGovernanceInstanceConfiguration parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the tenancy-wide configuration for GovernanceInstances headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/GovernanceInstanceConfiguration' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get GovernanceInstance tags: - accessGovernanceCP put: description: Updates the tenancy-wide configuration for GovernanceInstances operationId: UpdateGovernanceInstanceConfiguration parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Accepted the request. The GovernanceInstanceConfiguration will be updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/GovernanceInstanceConfiguration' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the tenancy-wide configuration for GovernanceInstances tags: - accessGovernanceCP x-related-resource: '#/definitions/GovernanceInstanceConfiguration' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateGovernanceInstanceConfigurationDetails' description: The details of the tenancy-wide configuration to be updated. required: true /governanceInstances/{governanceInstanceId}: delete: description: 'Deletes an existing GovernanceInstance. ' operationId: DeleteGovernanceInstance parameters: - $ref: '#/components/parameters/AccessGovernanceIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OverrideLocksQueryParameter' responses: 202: description: Accepted the request. The Governance Instance will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes an existing GovernanceInstance. tags: - accessGovernanceCP x-related-resource: '#/definitions/GovernanceInstance' get: description: Gets a GovernanceInstance by OCID. operationId: GetGovernanceInstance parameters: - $ref: '#/components/parameters/AccessGovernanceIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the GovernanceInstance with the given OCID headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/GovernanceInstance' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get GovernanceInstance tags: - accessGovernanceCP put: description: Updates the GovernanceInstance. operationId: UpdateGovernanceInstance parameters: - $ref: '#/components/parameters/AccessGovernanceIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Accepted the request. The GovernanceInstance will be updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/GovernanceInstance' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the GovernanceInstance. tags: - accessGovernanceCP x-related-resource: '#/definitions/GovernanceInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateGovernanceInstanceDetails' description: The details of the GovernanceInstance to be updated. required: true /governanceInstances/{governanceInstanceId}/actions/addLock: post: description: Adds a lock to a GovernanceInstance resource. operationId: AddGovernanceInstanceLock parameters: - description: 'Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string - description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match schema: type: string - $ref: '#/components/parameters/AccessGovernanceIdentifierPathParam' - $ref: '#/components/parameters/AddResourceLockDetailsBodyParam' responses: 200: description: Lock is added. headers: etag: description: 'etag for the returned GovernanceInstance resource. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/GovernanceInstance' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Adds a lock to a GovernanceInstance resource. tags: - accessGovernanceCP x-related-resource: '#/definitions/GovernanceInstance' /governanceInstances/{governanceInstanceId}/actions/changeCompartment: post: description: Moves a GovernanceInstance resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeGovernanceInstanceCompartment parameters: - $ref: '#/components/parameters/AccessGovernanceIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OverrideLocksQueryParameter' responses: 204: description: Accepted the request. The GovernanceInstance resource will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves the GovernanceInstance into a different compartment. tags: - accessGovernanceCP x-related-resource: '#/definitions/GovernanceInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeGovernanceInstanceCompartmentDetails' description: The details to change the compartment of a GovernanceInstance. required: true /governanceInstances/{governanceInstanceId}/actions/removeLock: post: description: Removes a lock from a GovernanceInstance resource. operationId: RemoveGovernanceInstanceLock parameters: - description: 'Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string - description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match schema: type: string - $ref: '#/components/parameters/AccessGovernanceIdentifierPathParam' - $ref: '#/components/parameters/RemoveResourceLockDetailsBodyParam' responses: 200: description: Lock is removed. headers: etag: description: 'etag for the returned GovernanceInstance resource. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/GovernanceInstance' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Removes a lock to a GovernanceInstance resource. tags: - accessGovernanceCP x-related-resource: '#/definitions/GovernanceInstance' /workRequests: get: description: 'Lists the work requests in a compartment. ' operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/WorkRequestIdQueryParam' - $ref: '#/components/parameters/WorkRequestStatusQueryParam' - $ref: '#/components/parameters/ResourceIdentifierQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List Work Requests tags: - accessGovernanceCP x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}: delete: description: Cancel work request with the given ID. operationId: CancelWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The work request will be cancelled. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Cancel the work request tags: - accessGovernanceCP x-related-resource: '#/definitions/WorkRequest' get: description: Gets the status of the work request with the given ID. operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The detail of the work request. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: GET Work Request Status tags: - accessGovernanceCP x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/errors: get: description: 'Return a (paginated) list of errors for a given work request. ' operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: A list of work request errors. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestErrorCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists work request errors tags: - accessGovernanceCP x-related-resource: '#/definitions/WorkRequestError' /workRequests/{workRequestId}/logs: get: description: 'Return a (paginated) list of logs for a given work request. ' operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: A list of work request logs. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestLogEntryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists work request logs tags: - accessGovernanceCP x-related-resource: '#/definitions/WorkRequestLogEntry' components: schemas: ResourceLock: description: 'Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resource and deleting the resource. A delete lock prevents deleting the resource. ' properties: compartmentId: description: The compartment ID of the lock. type: string message: description: 'A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. ' type: string relatedResourceId: description: 'The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. ' type: string timeCreated: description: When the lock was created. format: date-time type: string type: description: Type of the lock. enum: - FULL - DELETE type: string required: - type type: object Error: description: Error Information. properties: code: description: A short error code that defines the error, meant for programmatic parsing. type: string message: description: A human-readable error string. type: string required: - code - message RemoveResourceLockDetails: description: 'Used to remove a resource lock. Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resource and deleting the resource. A delete lock prevents deleting the resource. ' properties: compartmentId: description: The compartment ID of the lock. type: string type: description: Type of the lock. enum: - FULL - DELETE type: string required: - type type: object GovernanceInstance: description: The details of a GovernanceInstance. properties: compartmentId: description: The OCID of the compartment where the GovernanceInstance resides. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: The description of the GovernanceInstance. maxLength: 255 minLength: 1 type: string displayName: description: The name for the GovernanceInstance. maxLength: 50 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The unique OCID of the GovernanceInstance. maxLength: 255 minLength: 1 type: string instanceUrl: description: The access URL of the GovernanceInstance. maxLength: 400 minLength: 1 type: string licenseType: description: The license type of the instance. enum: - AG_ORACLE_WORKLOADS - AG_OCI - AG_PREMIUM type: string x-obmcs-top-level-enum: '#/definitions/LicenseType' lifecycleState: description: The current state of the GovernanceInstance. enum: - CREATING - ACTIVE - DELETING - DELETED - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/InstanceLifecycleState' locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 2 type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object tenancyNamespace: description: The namespace for tenancy object storage. maxLength: 400 minLength: 1 type: string timeCreated: description: The time the the GovernanceInstance was created in an RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time the GovernanceInstance was updated in an RFC3339 formatted datetime string. format: date-time type: string required: - compartmentId - lifecycleState - timeCreated - displayName type: object SenderConfig: description: The sender information for email notifications sent by GovernanceInstance. properties: displayName: description: The sender's displayName. maxLength: 255 minLength: 1 type: string email: description: The sender's email. type: string isInboxConfigured: description: Whether the sender email has inbox configured to receive emails. type: boolean isVerified: description: Whether or not the sender's email has been verified. type: boolean timeVerifyResponseExpiry: description: The time when the verify response needs to be received by. format: date-time type: string type: object UpdateGovernanceInstanceDetails: description: The details of a GovernanceInstance to be updated. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: The description of the GovernanceInstance. maxLength: 255 minLength: 1 type: string displayName: description: The name for the GovernanceInstance. maxLength: 50 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object licenseType: description: The license type of the instance. enum: - AG_ORACLE_WORKLOADS - AG_OCI - AG_PREMIUM type: string x-obmcs-top-level-enum: '#/definitions/LicenseType' type: object WorkRequestResource: description: A resource created or operated on by a work request. properties: actionType: description: 'The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively. ' enum: - CREATED - UPDATED - DELETED - IN_PROGRESS - RELATED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/ActionType' entityType: description: The resource type the work request affects. type: string entityUri: description: The URI path that the user can do a GET on to access the resource metadata type: string identifier: description: The identifier of the resource the work request affects. type: string metadata: additionalProperties: type: string description: Additional information that helps to explain the resource. enum: - IS_DRY_RUN type: object x-obmcs-top-level-enum: '#/definitions/WorkRequestResourceMetadataKey' required: - actionType - entityType - identifier WorkRequestSummaryCollection: description: Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata. properties: items: description: A list of workRequestSummary objects. items: $ref: '#/components/schemas/WorkRequestSummary' type: array required: - items type: object UpdateSenderConfig: description: Update to a sender information for email notifications sent by GovernanceInstance. properties: displayName: description: The sender's displayName. maxLength: 255 minLength: 1 type: string email: description: The sender's email. type: string isInboxConfigured: description: Whether the sender email has inbox configured to receive emails. type: boolean isResendNotificationEmail: description: Whether there is a need to resend the verification email. type: boolean required: - email - isInboxConfigured type: object ChangeGovernanceInstanceCompartmentDetails: description: The details of a GovernanceInstance to be updated for a compartment change. properties: compartmentId: description: The OCID of the compartment where the GovernanceInstance resides. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object GovernanceInstanceSummary: description: The summary of an GovernanceInstance. properties: compartmentId: description: The OCID of the compartment where the GovernanceInstance resides. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: The description of the GovernanceInstance. maxLength: 255 minLength: 1 type: string displayName: description: The name for the GovernanceInstance. maxLength: 50 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The unique OCID of the GovernanceInstance. maxLength: 255 minLength: 1 type: string instanceUrl: description: The access URL of the GovernanceInstance. maxLength: 400 minLength: 1 type: string licenseType: description: The license type of the instance. enum: - AG_ORACLE_WORKLOADS - AG_OCI - AG_PREMIUM type: string x-obmcs-top-level-enum: '#/definitions/LicenseType' lifecycleState: description: The current state of the GovernanceInstance. enum: - CREATING - ACTIVE - DELETING - DELETED - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/InstanceLifecycleState' locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 2 type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the the GovernanceInstance was created in an RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time the GovernanceInstance was updated in an RFC3339 formatted datetime string. format: date-time type: string required: - compartmentId - lifecycleState - timeCreated - displayName type: object WorkRequestErrorCollection: description: Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata. properties: items: description: A list of workRequestError objects. items: $ref: '#/components/schemas/WorkRequestError' type: array required: - items type: object GovernanceInstanceConfiguration: description: The tenancy-wide configuration for GovernanceInstances. properties: senderInfo: $ref: '#/components/schemas/SenderConfig' required: - senderInfo type: object GovernanceInstanceCollection: description: Results of a GovernanceInstance search. properties: items: description: List of GovernanceInstances. items: $ref: '#/components/schemas/GovernanceInstanceSummary' type: array required: - items type: object WorkRequestSummary: description: A summary of the status of a work request. properties: compartmentId: description: 'The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used ' type: string id: description: The OCID of the work request. type: string operationType: description: Type of the work request enum: - CREATE_GOVERNANCE_INSTANCE - DELETE_GOVERNANCE_INSTANCE - UPDATE_GOVERNANCE_INSTANCE type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: Percentage of the request completed. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' maxItems: 50 type: array status: description: Status of current work request. enum: - ACCEPTED - IN_PROGRESS - WAITING - FAILED - SUCCEEDED - CANCELING - CANCELED - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeFinished: description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted UpdateGovernanceInstanceConfigurationDetails: description: The details of a tenancy-wide configuration for GovernanceInstances to be updated. properties: senderInfo: $ref: '#/components/schemas/UpdateSenderConfig' type: object WorkRequestError: description: An error encountered while executing a work request. properties: code: description: "A machine-usable code for the error that occured. Error codes are listed on \nAPI Errors Landing Page.\n" type: string message: description: A human readable description of the issue encountered. type: string timestamp: description: The time the error occured. An RFC3339 formatted datetime string. format: date-time type: string required: - code - message - timestamp AddResourceLockDetails: description: 'Used to add a resource lock. Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resource and deleting the resource. A delete lock prevents deleting the resource. ' properties: compartmentId: description: The compartment ID of the lock. type: string message: description: 'A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. ' type: string relatedResourceId: description: 'The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. ' type: string type: description: Type of the lock. enum: - FULL - DELETE type: string required: - type type: object WorkRequestLogEntry: description: A log message from the execution of a work request. properties: message: description: Human-readable log message. type: string timestamp: description: The time the log message was written. An RFC3339 formatted datetime string format: date-time type: string required: - message - timestamp CreateGovernanceInstanceDetails: description: The details about a new GovernanceInstance. properties: compartmentId: description: The OCID of the compartment where the GovernanceInstance resides. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: The description of the GovernanceInstance. maxLength: 255 minLength: 1 type: string displayName: description: The name for the GovernanceInstance. maxLength: 50 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object idcsAccessToken: description: 'IDCS access token identifying a stripe and service administrator user. ' maxLength: 8192 type: string licenseType: description: The license type of the instance. enum: - AG_ORACLE_WORKLOADS - AG_OCI - AG_PREMIUM type: string x-obmcs-top-level-enum: '#/definitions/LicenseType' locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 2 type: array tenancyNamespace: description: The namespace for tenancy object storage. maxLength: 400 minLength: 1 type: string required: - displayName - licenseType - tenancyNamespace - compartmentId - idcsAccessToken type: object WorkRequestLogEntryCollection: description: Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata. properties: items: description: A list of workRequestLogEntries. items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array required: - items type: object WorkRequest: description: A description of workrequest status properties: compartmentId: description: 'The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used ' type: string id: description: The OCID of the work request. type: string operationType: description: Type of the work request enum: - CREATE_GOVERNANCE_INSTANCE - DELETE_GOVERNANCE_INSTANCE - UPDATE_GOVERNANCE_INSTANCE type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: Percentage of the request completed. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' maxItems: 50 type: array status: description: Status of current work request. enum: - ACCEPTED - IN_PROGRESS - WAITING - FAILED - SUCCEEDED - CANCELING - CANCELED - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeFinished: description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted parameters: PaginationTokenQueryParam: description: A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. in: query name: page x-default-description: 'null' schema: type: string minLength: 1 AddResourceLockDetailsBodyParam: description: AddResourceLockDetails body parameter in: body name: AddResourceLockDetails required: true schema: $ref: '#/components/schemas/AddResourceLockDetails' ResourceIdentifierQueryParam: description: The ID of the resource affected by the work request. in: query name: resourceId x-default-description: 'null' schema: type: string CompartmentIdQueryParam: description: The OCID of the compartment in which resources are listed. in: query name: compartmentId required: true x-default-description: 'null' schema: type: string IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string WorkRequestStatusQueryParam: description: A filter to return only resources whose lifecycle state matches the given operation status. in: query name: status required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/OperationStatus' schema: type: string enum: - ACCEPTED - IN_PROGRESS - WAITING - FAILED - SUCCEEDED - CANCELING - CANCELED - NEEDS_ATTENTION RemoveResourceLockDetailsBodyParam: description: RemoveResourceLockDetails body parameter in: body name: RemoveResourceLockDetails required: true schema: $ref: '#/components/schemas/RemoveResourceLockDetails' PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 100 minimum: 1 AccessGovernanceIdentifierPathParam: description: The OCID of the GovernanceInstance in: path name: governanceInstanceId required: true schema: type: string WorkRequestIdPathParam: description: The OCID of the asynchronous request. in: path name: workRequestId required: true schema: type: string WorkRequestIdQueryParam: description: The OCID of the asynchronous work request. in: query name: workRequestId x-default-description: 'null' schema: type: string SortOrderQueryParam: description: The sort order to use, either 'ASC' or 'DESC'. in: query name: sortOrder x-default-description: 'The default value depends upon `sortBy`, and in general is ''DESC'' when sorting by time and ''ASC'' otherwise. ' x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 InstanceLifecycleStateQueryParam: description: The lifecycle state to filter on. in: query name: lifecycleState x-default-description: 'null' schema: type: string OverrideLocksQueryParameter: description: Whether to override locks (if any exist). in: query name: isLockOverride schema: type: boolean default: false DisplayNameQueryParam: description: A filter to return only resources that match the entire display name given. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 InstanceSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName - timeUpdated - lifecycleState default: timeCreated WorkRequestSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. ' in: query name: sortBy schema: type: string enum: - timeAccepted default: timeAccepted RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string AccessGovernanceIdentifierQueryParam: description: The OCID of the GovernanceInstance in: query name: id x-default-description: 'null' schema: type: string responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' DefaultError: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. type: integer x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.idm.agcs.cp