openapi: 3.2.0 info: description: "Operator Access Control enables you to control the time duration and the actions an Oracle operator can perform on your Exadata Cloud@Customer infrastructure.\nUsing logging service, you can view a near real-time audit report of all actions performed by an Oracle operator. \n" title: Operator Access Control Access Requests API version: '20200630' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/9cf6d46a3ebf1062eb0a9b386e1727a9f1b39525782fc49580c4ba13b79c72fa.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Operator Access Control API 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/9cf6d46a3ebf1062eb0a9b386e1727a9f1b39525782fc49580c4ba13b79c72fa.yaml what: the harvested document for Operator Access Control API servers: - url: http://127.0.0.1/20200630 - url: https://127.0.0.1/20200630 tags: - name: accessRequests paths: /accessRequests: get: description: 'Lists all access requests in the compartment. ' operationId: ListAccessRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ResourceNameQueryParam' - $ref: '#/components/parameters/AccessRequestLifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: returns AccessRequestCollection. 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/AccessRequestCollection' 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 all access requests in the compartment. tags: - accessRequests x-related-resource: '#/definitions/AccessRequest' /accessRequests/{accessRequestId}: get: description: Gets details of an access request. operationId: GetAccessRequest parameters: - $ref: '#/components/parameters/AccessRequestIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Returns the access request. 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/AccessRequest' 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 GetAccessRequest tags: - accessRequests x-related-resource: '#/definitions/AccessRequest' /accessRequests/{accessRequestId}/action/approve: post: description: 'Approves an access request. ' operationId: ApproveAccessRequest parameters: - $ref: '#/components/parameters/AccessRequestIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The access request approval has been accepted. 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_action' 401: $ref: '#/components/responses/401_action' 404: $ref: '#/components/responses/404_action' 409: $ref: '#/components/responses/409_action' 412: $ref: '#/components/responses/412_action' 429: $ref: '#/components/responses/429_action' 500: $ref: '#/components/responses/500_action' default: $ref: '#/components/responses/default_action' summary: Approves an access request. tags: - accessRequests x-related-resource: '#/definitions/AccessRequest' requestBody: content: application/json: schema: $ref: '#/components/schemas/ApproveAccessRequestDetails' description: Details regarding the approval of an access request created by the operator. required: true /accessRequests/{accessRequestId}/action/reject: post: description: 'Rejects an access request. ' operationId: RejectAccessRequest parameters: - $ref: '#/components/parameters/AccessRequestIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The access request rejection has been accepted. 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_action' 401: $ref: '#/components/responses/401_action' 404: $ref: '#/components/responses/404_action' 409: $ref: '#/components/responses/409_action' 412: $ref: '#/components/responses/412_action' 429: $ref: '#/components/responses/429_action' 500: $ref: '#/components/responses/500_action' default: $ref: '#/components/responses/default_action' summary: Rejects an access request. tags: - accessRequests x-related-resource: '#/definitions/AccessRequest' requestBody: content: application/json: schema: $ref: '#/components/schemas/RejectAccessRequestDetails' description: Details regarding the rejection of an access request created by the operator. required: true /accessRequests/{accessRequestId}/action/revoke: post: description: 'Revokes an already approved access request. ' operationId: RevokeAccessRequest parameters: - $ref: '#/components/parameters/AccessRequestIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The access request revocation has been accepted. 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_action' 401: $ref: '#/components/responses/401_action' 404: $ref: '#/components/responses/404_action' 409: $ref: '#/components/responses/409_action' 412: $ref: '#/components/responses/412_action' 429: $ref: '#/components/responses/429_action' 500: $ref: '#/components/responses/500_action' default: $ref: '#/components/responses/default_action' summary: Revokes an already approved access request. tags: - accessRequests x-related-resource: '#/definitions/AccessRequest' requestBody: content: application/json: schema: $ref: '#/components/schemas/RevokeAccessRequestDetails' description: Details regarding the revocation of an access request created by the operator. required: true /accessRequests/{accessRequestId}/auditLogReport: get: description: Gets the Audit Log Report for the given access requestId. operationId: GetAuditLogReport parameters: - $ref: '#/components/parameters/AccessRequestIdentifierPathParam' - $ref: '#/components/parameters/EnableProcessTreeQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Returns the Audit Log Report for the given id. 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/AuditLogReport' 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 the Audit Log Report for the given access requestId. tags: - accessRequests x-related-resource: '#/definitions/AuditLogReport' /accessRequests/{accessRequestId}/history: get: description: 'Returns a history of all status associated with the accessRequestId. ' operationId: ListAccessRequestHistories parameters: - $ref: '#/components/parameters/AccessRequestIdentifierPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: returns AccessRequestHistoryCollection object. 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/AccessRequestHistoryCollection' 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 history of all state transitions associated with the access request. tags: - accessRequests x-related-resource: '#/definitions/AccessRequest' components: parameters: PaginationTokenQueryParam: description: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. in: query name: page schema: type: string maxLength: 1024 minLength: 1 SortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated AccessRequestIdentifierPathParam: description: unique AccessRequest identifier in: path name: accessRequestId required: true schema: type: string CompartmentIdQueryParam: description: The ID of the compartment in which to list resources. in: query name: compartmentId required: true 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 PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 EnableProcessTreeQueryParam: description: To enable process tree computation in audit report in: query name: enableProcessTree required: false schema: type: integer default: 0 SortOrderQueryParam: description: The sort order to use, either 'asc' or 'desc'. in: query name: sortOrder x-obmcs-top-level-enum: '#/definitions/SortOrders' schema: type: string enum: - ASC - DESC default: DESC ResourceNameQueryParam: description: A filter to return only resources that match the given ResourceName. in: query name: resourceName x-default-description: 'null' schema: type: string maxLength: 64 minLength: 1 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 AccessRequestLifecycleStateQueryParam: description: A filter to return only resources whose lifecycleState matches the given AccessRequest lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/AccessRequestLifecycleStates' schema: type: string enum: - CREATED - APPROVALWAITING - PREAPPROVED - APPROVED - REJECTED - DEPLOYED - DEPLOYFAILED - UNDEPLOYED - UNDEPLOYFAILED - CLOSEFAILED - REVOKEFAILED - EXPIRYFAILED - REVOKING - REVOKED - EXTENDING - EXTENDED - EXTENSIONREJECTED - COMPLETING - COMPLETED - EXPIRED RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string schemas: 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 AccessRequestSummary: description: Summary of access request. properties: accessReasonSummary: description: Comment associated with the access request. type: string actionRequestsList: description: List of operator actions for which approval is sought by the operator user. items: type: string type: array compartmentId: description: The OCID of the compartment that contains the access request. 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. ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. ' type: object duration: description: Duration in hours for which access is sought on the target resource. type: integer extendDuration: description: Duration in hours for which extension access is sought on the target resource. type: integer freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. ' type: object id: description: The OCID of the access request. type: string isAutoApproved: description: Whether the access request was automatically approved. type: boolean lifecycleState: description: The current state of the AccessRequest. enum: - CREATED - APPROVALWAITING - PREAPPROVED - APPROVED - REJECTED - DEPLOYED - DEPLOYFAILED - UNDEPLOYED - UNDEPLOYFAILED - CLOSEFAILED - REVOKEFAILED - EXPIRYFAILED - REVOKING - REVOKED - EXTENDING - EXTENDED - EXTENSIONREJECTED - COMPLETING - COMPLETED - EXPIRED type: string x-obmcs-top-level-enum: '#/definitions/AccessRequestLifecycleStates' requestId: description: This is a system-generated identifier. type: string resourceId: description: "The OCID of the target resource associated with the access request. The operator raises an access request to get approval to \naccess the target resource.\n" type: string resourceName: description: The name of the target resource. type: string severity: description: Priority assigned to the access request by the operator enum: - S1 - S2 - S3 - S4 type: string x-obmcs-top-level-enum: '#/definitions/AccessRequestSeverities' subResourceList: description: The subresources requested for approval. items: type: string type: array timeOfCreation: description: 'Time when the access request was created by the operator user in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.Example: ''2020-05-22T21:10:29.600Z'' ' format: date-time type: string timeOfModification: description: 'Time when the access request was last modified in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.Example: ''2020-05-22T21:10:29.600Z'' ' format: date-time type: string required: - id - accessReasonSummary - resourceId type: object RejectAccessRequestDetails: description: Summary of why the access request was rejected. properties: approverComment: description: Comment by the approver explaining why the request is rejected. type: string type: object AccessRequest: description: "An Oracle operator raises access request when they need access to any infrastructure resource governed by Operator Access Control.\nThe access request identifies the target resource and the set of operator actions. Access request handling depends upon the Operator Control \nthat governs the target resource, and the set of operator actions listed for approval in the access request. If all of the operator actions \nlisted in the access request are in the pre-approved list in the Operator Control that governs the target resource, then the access request is \nautomatically approved. If not, then the access request requires explicit approval from the approver group specified by the Operator Control governing the target resource.\n\nYou can approve or reject an access request. You can also revoke the approval of an already approved access request. While creating an access request, \nthe operator specifies the duration of access. You have the option to approve the entire duration or reduce or even increase the time duration. \nAn operator can also request for an extension. The approval for such an extension is processed the same way the original access request was processed.\n" properties: accessReasonSummary: description: Summary comment by the operator creating the access request. type: string actionRequestsList: description: List of operator actions for which approval is sought by the operator user. items: type: string type: array approverComment: description: The last recent Comment entered by the approver of the request. type: string auditType: description: "Specifies the type of auditing to be enabled. There are two levels of auditing: command-level and keystroke-level. \nBy default, auditing is enabled at the command level i.e., each command issued by the operator is audited. When keystroke-level is chosen, \nin addition to command level logging, key strokes are also logged.\n" items: type: string type: array closureComment: description: The comment entered by the operator while closing the request. type: string compartmentId: description: The OCID of the compartment that contains the access request. 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. ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. ' type: object duration: description: Duration in hours for which access is sought on the target resource. type: integer extendDuration: description: Duration in hours for which extension access is sought on the target resource. type: integer freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. ' type: object id: description: The OCID of the access request. type: string isAutoApproved: description: Whether the access request was automatically approved. type: boolean lifecycleState: description: The current state of the AccessRequest. enum: - CREATED - APPROVALWAITING - PREAPPROVED - APPROVED - REJECTED - DEPLOYED - DEPLOYFAILED - UNDEPLOYED - UNDEPLOYFAILED - CLOSEFAILED - REVOKEFAILED - EXPIRYFAILED - REVOKING - REVOKED - EXTENDING - EXTENDED - EXTENSIONREJECTED - COMPLETING - COMPLETED - EXPIRED type: string x-obmcs-top-level-enum: '#/definitions/AccessRequestLifecycleStates' opctlAdditionalMessage: description: Additional message specific to the access request that can be specified by the approver at the time of approval. type: string opctlId: description: The OCID of the operator control governing the target resource. type: string opctlName: description: Name of the Operator control governing the target resource. type: string operatorId: description: 'A unique identifier associated with the operator who raised the request. This identifier can not be used directly to identify the operator. You need to provide this identifier if you would like Oracle to provide additional information about the operator action within Oracle tenancy. ' maxLength: 255 type: string reason: description: Summary reason for which the operator is requesting access on the target resource. maxLength: 255 minLength: 1 type: string requestId: description: This is an automatic identifier generated by the system which is easier for human comprehension. type: string resourceId: description: "The OCID of the target resource associated with the access request. The operator raises an access request to get approval to \naccess the target resource.\n" type: string resourceName: description: The name of the target resource. type: string severity: description: Priority assigned to the access request by the operator enum: - S1 - S2 - S3 - S4 type: string x-obmcs-top-level-enum: '#/definitions/AccessRequestSeverities' subResourceList: description: The subresources requested for approval. items: type: string type: array systemMessage: description: System message that will be displayed to the operator at login to the target resource. type: string timeOfCreation: description: 'Time when the access request was created in [RFC 3339](https://tools.ietf.org/html/rfc3339)timestamp format. Example: ''2020-05-22T21:10:29.600Z'' ' format: date-time type: string timeOfModification: description: 'Time when the access request was last modified in [RFC 3339](https://tools.ietf.org/html/rfc3339)timestamp format. Example: ''2020-05-22T21:10:29.600Z'' ' format: date-time type: string userId: description: The OCID of the user that last modified the access request. type: string workflowId: description: 'The OCID of the workflow associated with the access request. This is needed if you want to contact Oracle Support for a stuck access request or for an access request that encounters an internal error. ' items: type: string type: array required: - id - accessReasonSummary - resourceId type: object RevokeAccessRequestDetails: description: Summary of why the already approved access request was revoked. properties: approverComment: description: Comment specified by the approver explaining why the approval is revoked. type: string type: object AuditLogReport: description: The auditLog report details. properties: auditReportStatus: description: auditReportStatus for the accessRequestId enum: - NOTAVAILABLE - AVAILABLE - EXPIRED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/AuditReportStatus' processTree: description: Contains the process tree data type: string report: description: Contains the report data. type: string timeOfReportGeneration: description: 'Time when the audit report was generated [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.Example: ''2020-05-22T21:10:29.600Z'' ' format: date-time type: string required: - auditReportStatus AccessRequestHistoryCollection: description: Results of access request history search, which contains summary of the access request. properties: items: description: contains AccessRequestHistorySummary items: $ref: '#/components/schemas/AccessRequestHistorySummary' type: array required: - items type: object ApproveAccessRequestDetails: description: Details of the access request approval. properties: additionalMessage: description: Message that needs to be displayed to the Ops User. type: string approverComment: description: Comment by the approver during approval. type: string auditType: description: "Specifies the type of auditing to be enabled. There are two levels of auditing: command-level and keystroke-level. \nBy default, auditing is enabled at the command level i.e., each command issued by the operator is audited. When keystroke-level is chosen, \nin addition to command level logging, key strokes are also logged.\n" items: type: string type: array type: object AccessRequestCollection: description: Results of access request search, which contains summary of access request. properties: items: description: contains AccessRequestSummary items: $ref: '#/components/schemas/AccessRequestSummary' type: array required: - items type: object AccessRequestHistorySummary: description: Summary of access request status. properties: actionsList: description: List of operator actions for which approvals were requested by the operator. items: type: string type: array description: description: Reason or description about the cause of change. type: string duration: description: Duration for approval of request or extension depending on the type of action. type: integer isAutoApproved: description: Whether the access request was automatically approved. type: boolean lifecycleState: description: The current state of the AccessRequest. enum: - CREATED - APPROVALWAITING - PREAPPROVED - APPROVED - REJECTED - DEPLOYED - DEPLOYFAILED - UNDEPLOYED - UNDEPLOYFAILED - CLOSEFAILED - REVOKEFAILED - EXPIRYFAILED - REVOKING - REVOKED - EXTENDING - EXTENDED - EXTENSIONREJECTED - COMPLETING - COMPLETED - EXPIRED type: string x-obmcs-top-level-enum: '#/definitions/AccessRequestLifecycleStates' timeOfAction: description: 'Time when the respective action happened in [RFC 3339](https://tools.ietf.org/html/rfc3339)timestamp format. Example: ''2020-05-22T21:10:29.600Z'' ' format: date-time type: string userId: description: Approver who modified the access request. type: string type: object responses: 400_action: description: Bad 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/Error' default_action: description: Unknown Error 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/Error' 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' 401_action: description: Unauthorized 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/Error' 429_action: description: Too Many Requests 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/Error' 412_action: description: Precondition failed 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/Error' 409_action: description: Conflict 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/Error' 500_action: description: Internal Server Error 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/Error' 404_action: description: Not Found 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/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. format: float type: number 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. ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. ' 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. ' type: object x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.bmc.opctl