openapi: 3.2.0 info: description: "Oracle Delegate Access Control allows customers of Oracle Exadata Database Service on Cloud@Customer (ExaDB-C@C) and Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D) to delegate management of their Exadata resources operators outside their tenancies. \nWith Delegate Access Control, Support Providers can deliver managed services using comprehensive and robust tooling built on the OCI platform. \nCustomers maintain control over who has access to the delegated resources in their tenancy and what actions can be taken. \nEnterprises managing resources across multiple tenants can use Delegate Access Control to streamline management tasks.\nUsing logging service, customers can view a near real-time audit report of all actions performed by a Service Provider operator. \n" title: Oracle Delegate Access Control API version: '20230801' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/a8a2c21c4173be02e12261ac766b55eea1f176c7edf194b4f291fcfd45e75529.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Oracle Delegate 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/a8a2c21c4173be02e12261ac766b55eea1f176c7edf194b4f291fcfd45e75529.yaml what: the harvested document for Oracle Delegate Access Control API servers: - url: http://127.0.0.1/20230801 - url: https://127.0.0.1/20230801 tags: - name: delegateAccessControl paths: /delegatedResourceAccessRequests: get: description: 'Lists all Delegated Resource Access Requests in the compartment. Note that only one of lifecycleState or requestStatus query parameter can be used. ' operationId: ListDelegatedResourceAccessRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DelegationControlIdentifierQueryParam' - $ref: '#/components/parameters/DelegatedResourceAccessRequestResourceIdQueryParam' - $ref: '#/components/parameters/DelegatedResourceAccessRequestLifecycleStateQueryParam' - $ref: '#/components/parameters/DelegatedResourceAccessRequestStatusQueryParam' - $ref: '#/components/parameters/TimeStartQueryParam' - $ref: '#/components/parameters/TimeEndQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/DelegatedResourceAccessRequestSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Returns DelegatedResourceAccessRequestSummaryCollection. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' 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/DelegatedResourceAccessRequestSummaryCollection' 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 Delegated Resource Access Requests in the compartment. tags: - delegateAccessControl x-related-resource: '#/definitions/DelegatedResourceAccessRequest' /delegatedResourceAccessRequests/{delegatedResourceAccessRequestId}: get: description: Gets details of a Delegated Resource Access Request. operationId: GetDelegatedResourceAccessRequest parameters: - $ref: '#/components/parameters/DelegatedResourceAccessRequestIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Returns the Delegated Resource Access 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/DelegatedResourceAccessRequest' 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 GetDelegatedResourceAccessRequest tags: - delegateAccessControl x-related-resource: '#/definitions/DelegatedResourceAccessRequest' /delegatedResourceAccessRequests/{delegatedResourceAccessRequestId}/actions/approve: post: description: 'Approves a Delegated Resource Access Request. ' operationId: ApproveDelegatedResourceAccessRequest parameters: - $ref: '#/components/parameters/DelegatedResourceAccessRequestIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The Delegated Resource 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: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' 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: Approves a Delegated Resource Access Request. tags: - delegateAccessControl x-related-resource: '#/definitions/DelegatedResourceAccessRequest' requestBody: content: application/json: schema: $ref: '#/components/schemas/ApproveDelegatedResourceAccessRequestDetails' description: Details regarding the approval of a Delegated Resource Access Request created by the support operator. required: true /delegatedResourceAccessRequests/{delegatedResourceAccessRequestId}/actions/reject: post: description: 'Rejects a Delegated Resource Access Request. ' operationId: RejectDelegatedResourceAccessRequest parameters: - $ref: '#/components/parameters/DelegatedResourceAccessRequestIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The Delegated Resource 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: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' 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: Rejects a Delegated Resource Access Request. tags: - delegateAccessControl x-related-resource: '#/definitions/DelegatedResourceAccessRequest' requestBody: content: application/json: schema: $ref: '#/components/schemas/RejectDelegatedResourceAccessRequestDetails' description: Details regarding the rejection of a Delegated Resource Access Request created by the support operator. required: true /delegatedResourceAccessRequests/{delegatedResourceAccessRequestId}/actions/revoke: post: description: 'Revokes an already approved Delegated Resource Access Request. ' operationId: RevokeDelegatedResourceAccessRequest parameters: - $ref: '#/components/parameters/DelegatedResourceAccessRequestIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The Delegated Resource 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: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' 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: Revokes an already approved Delegated Resource Access Request. tags: - delegateAccessControl x-related-resource: '#/definitions/DelegatedResourceAccessRequest' requestBody: content: application/json: schema: $ref: '#/components/schemas/RevokeDelegatedResourceAccessRequestDetails' description: Details regarding the revocation of a Delegated Resource Access Request created by the support operator. required: true /delegatedResourceAccessRequests/{delegatedResourceAccessRequestId}/actions/serviceProviderInteractionRequest: post: description: 'Posts query for additional information for the given Delegated Resource Access Request. ' operationId: ServiceProviderInteractionRequest parameters: - $ref: '#/components/parameters/DelegatedResourceAccessRequestIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The query for additional information was posted successfully. 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' 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: Posts query for additional information for the given Delegated Resource Access Request. tags: - delegateAccessControl x-related-resource: '#/definitions/DelegatedResourceAccessRequest' requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceProviderInteractionRequestDetails' description: Details containing Query for additional information provided by Customer. required: true /delegatedResourceAccessRequests/{delegatedResourceAccessRequestId}/delegatedResourceAccessRequestAuditLogReport: get: description: Gets the audit log report for the given Delegated Resource Access Request. operationId: GetDelegatedResourceAccessRequestAuditLogReport parameters: - $ref: '#/components/parameters/DelegatedResourceAccessRequestIdentifierPathParam' - $ref: '#/components/parameters/EnableProcessTreeQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Returns the AuditLogReport 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/DelegatedResourceAccessRequestAuditLogReport' 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 Delegated Resource Access Request. tags: - delegateAccessControl x-related-resource: '#/definitions/DelegatedResourceAccessRequestAuditLogReport' /delegatedResourceAccessRequests/{delegatedResourceAccessRequestId}/history: get: description: 'Returns a history of all status associated with the Delegated Resource Access RequestId. ' operationId: ListDelegatedResourceAccessRequestHistories parameters: - $ref: '#/components/parameters/DelegatedResourceAccessRequestIdentifierPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/DelegatedResourceAccessRequestHistorySortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Returns DelegatedResourceAccessRequestHistoryCollection object. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' 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/DelegatedResourceAccessRequestHistoryCollection' 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 Delegated Resource Access Request. tags: - delegateAccessControl x-related-resource: '#/definitions/DelegatedResourceAccessRequest' /delegatedResourceAccessRequests/{delegatedResourceAccessRequestId}/serviceProviderInteractions: get: description: 'Lists the MoreInformation interaction between customer and support operators. ' operationId: ListServiceProviderInteractions parameters: - $ref: '#/components/parameters/DelegatedResourceAccessRequestIdentifierPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Returns ServiceProviderInteractionCollection object. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' 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/ServiceProviderInteractionCollection' 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 the MoreInformation interaction between customer and support operators. tags: - delegateAccessControl x-related-resource: '#/definitions/DelegatedResourceAccessRequest' /delegationControls: get: description: 'Lists the Delegation Controls in the compartment. ' operationId: ListDelegationControls parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DelegationControlLifecycleStateQueryParam' - $ref: '#/components/parameters/DelegationControlDisplayNameQueryParam' - $ref: '#/components/parameters/DelegationControlResourceTypeQueryParam' - $ref: '#/components/parameters/DelegationControlResourceIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Returns DelegationControlSummaryCollection object. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' 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/DelegationControlSummaryCollection' 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 the Delegation Controls in the compartment. tags: - delegateAccessControl x-related-resource: '#/definitions/DelegationControl' post: description: 'Creates a Delegation Control. ' operationId: CreateDelegationControl parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Creates the Delegation Control object. headers: content-location: description: URI of the resource schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: URI of the resource schema: type: string format: uri-reference 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: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DelegationControl' 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 Delegation Control tags: - delegateAccessControl x-related-resource: '#/definitions/DelegationControl' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDelegationControlDetails' description: Details for the new Delegation Control. required: true /delegationControls/{delegationControlId}: delete: description: "Deletes a Delegation Control. You cannot delete a Delegation Control if it is assigned to govern any target resource currently or in the future.\nIn that case, first, delete all of the current and future assignments before deleting the Delegation Control. A Delegation Control that was previously assigned to a target \nresource is marked as DELETED following a successful deletion. However, it is not completely deleted from the system. This is to ensure auditing information for the accesses \ndone under the Delegation Control is preserved for future needs. The system purges the deleted Delegation Control only when all of the audit data associated with the \nDelegation Control are also deleted. Therefore, you cannot reuse the name of the deleted Delegation Control until the system purges the Delegation Control.\n" operationId: DeleteDelegationControl parameters: - $ref: '#/components/parameters/DelegationControlIdentifierPathParam' - $ref: '#/components/parameters/DeleteDelegationControlDescQueryParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Delegation Control object 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: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 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: Deletes a Delegation Control. tags: - delegateAccessControl x-related-resource: '#/definitions/DelegationControl' get: description: Gets the Delegation Control associated with the specified Delegation Control ID. operationId: GetDelegationControl parameters: - $ref: '#/components/parameters/DelegationControlIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Returns the Delegation Control object 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/DelegationControl' 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 the Delegation Control associated with the specified Delegation Control ID. tags: - delegateAccessControl x-related-resource: '#/definitions/DelegationControl' put: description: 'Updates the existing DelegationControl for a given Delegation Control ID. ' operationId: UpdateDelegationControl parameters: - $ref: '#/components/parameters/DelegationControlIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Updates and returns the Delegation Control object with the updated details headers: content-location: description: URI of the resource schema: type: string format: uri-reference 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: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DelegationControl' 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: Updates the existing DelegationControl for a given Delegation Control ID. tags: - delegateAccessControl x-related-resource: '#/definitions/DelegationControl' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDelegationControlDetails' description: Details for the new DelegationControl. required: true /delegationControls/{delegationControlId}/actions/changeCompartment: post: description: 'Moves the Delegation Control resource into a different compartment. When provided, ''If-Match'' is checked against ''ETag'' values of the resource. ' operationId: ChangeDelegationControlCompartment parameters: - $ref: '#/components/parameters/DelegationControlIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Delegation Control resource will be moved to the new 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 opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' 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: Moves the Delegation Control resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource. tags: - delegateAccessControl x-related-resource: '#/definitions/DelegationControl' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeDelegationControlCompartmentDetails' description: Moves the Delegation Control resource into a different compartment. required: true /delegationControls/{delegationControlId}/resources: get: description: 'Returns a list of resources associated with the Delegation Control. ' operationId: ListDelegationControlResources parameters: - $ref: '#/components/parameters/DelegationControlIdentifierPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Returns DelegationControlResourceCollection object. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' 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/DelegationControlResourceCollection' 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 resources associated with the Delegation Control. tags: - delegateAccessControl x-related-resource: '#/definitions/DelegationControl' /delegationSubscriptions: get: description: 'Lists the Delegation Subscriptions in Delegation Control. ' operationId: ListDelegationSubscriptions parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DelegationSubscriptionLifecycleStateQueryParam' - $ref: '#/components/parameters/DelegationSubscriptionDisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/DelegationSubscriptionSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Returns DelegationSubscriptionSummaryCollection object. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' 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/DelegationSubscriptionSummaryCollection' 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 the Delegation Subscriptions in Delegation Control. tags: - delegateAccessControl x-related-resource: '#/definitions/DelegationSubscription' post: description: 'Creates Delegation Subscription in Delegation Control. ' operationId: CreateDelegationSubscription parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request for creating Delegation Subscription in Delegation Control. headers: content-location: description: URI of the resource schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: URI of the resource schema: type: string format: uri-reference 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: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DelegationSubscription' 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: Creates Delegation Subscription in Delegation Control. tags: - delegateAccessControl x-related-resource: '#/definitions/DelegationSubscription' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDelegationSubscriptionDetails' description: Details for creating Delegation Subscription in Delegation Control. required: true /delegationSubscriptions/{delegationSubscriptionId}: delete: description: eletes an Delegation Subscription in Delegation Control. operationId: DeleteDelegationSubscription parameters: - $ref: '#/components/parameters/DelegationSubscriptionIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Delegation Subscription 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: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 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: Deletes an Delegation Subscription in Delegation Control. tags: - delegateAccessControl x-related-resource: '#/definitions/DelegationSubscription' get: description: Gets a DelegationSubscription by identifier operationId: GetDelegationSubscription parameters: - $ref: '#/components/parameters/DelegationSubscriptionIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the DelegationSubscription with the given id 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/DelegationSubscription' 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 DelegationSubscription tags: - delegateAccessControl put: description: 'Updates the existing DelegationSubscription for a given Delegation Subscription ID. ' operationId: UpdateDelegationSubscription parameters: - $ref: '#/components/parameters/DelegationSubscriptionIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The DelegationSubscription will be updated. headers: content-location: description: URI of the resource schema: type: string format: uri-reference 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: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DelegationSubscription' 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: Updates the existing DelegationSubscription for a given Delegation Subscription ID. tags: - delegateAccessControl x-related-resource: '#/definitions/DelegationSubscription' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDelegationSubscriptionDetails' description: Details for the DelegationSubscription to be updated. required: true /delegationSubscriptions/{delegationSubscriptionId}/actions/changeCompartment: post: description: 'Moves the Delegation Subscription resource into a different compartment. When provided, ''If-Match'' is checked against ''ETag'' values of the resource. ' operationId: ChangeDelegationSubscriptionCompartment parameters: - $ref: '#/components/parameters/DelegationSubscriptionIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Delegation Subscription resource will be moved to the new 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 opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' 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: Moves the Delegation Subscription resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource. tags: - delegateAccessControl x-related-resource: '#/definitions/DelegationSubscription' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeDelegationSubscriptionCompartmentDetails' description: Moves the Delegation Subscription resource into a different compartment. required: true /serviceProviderActions: get: description: 'Lists all the ServiceProviderActions available in the system. ' operationId: ListServiceProviderActions parameters: - $ref: '#/components/parameters/ServiceProviderActionNameQueryParam' - $ref: '#/components/parameters/DelegationControlResourceTypeQueryParam' - $ref: '#/components/parameters/ServiceProviderServiceTypeQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ServiceProviderActionLifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ServiceProviderActionSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Returns ServiceProviderActionSummaryCollection object. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' 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/ServiceProviderActionSummaryCollection' 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 the Service Provider Actions available in the system. You need to use these Service Provider Actions when you define a Delegation Control. tags: - delegateAccessControl x-related-resource: '#/definitions/ServiceProviderAction' /serviceProviderActions/{serviceProviderActionId}: get: description: Gets the Service Provider Action associated with the specified Service Provider Action ID. operationId: GetServiceProviderAction parameters: - $ref: '#/components/parameters/ServiceProviderActionPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Returns the ServiceProviderAction for the given id 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/ServiceProviderAction' 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 ServiceProviderAction tags: - delegateAccessControl x-related-resource: '#/definitions/ServiceProviderAction' /serviceProviders: get: description: 'Lists the Service Providers. ' operationId: ListServiceProviders parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ServiceProviderLifecycleStateQueryParam' - $ref: '#/components/parameters/ServiceProviderNameQueryParam' - $ref: '#/components/parameters/ServiceProviderResourceTypeQueryParam' - $ref: '#/components/parameters/ServiceProviderTypeQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ServiceProviderSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Returns ServiceProviderSummaryCollection object. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' 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/ServiceProviderSummaryCollection' 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 the Service Providers. tags: - delegateAccessControl x-related-resource: '#/definitions/ServiceProvider' /serviceProviders/{serviceProviderId}: get: description: Gets a ServiceProvider by identifier operationId: GetServiceProvider parameters: - $ref: '#/components/parameters/ServiceProviderIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the ServiceProvider with the given id 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/ServiceProvider' 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 ServiceProvider tags: - delegateAccessControl components: parameters: ServiceProviderActionPathParam: description: Unique Oracle supplied identifier associated with the Service Provider Action. in: path name: serviceProviderActionId required: true schema: type: string DeleteDelegationControlDescQueryParam: description: Reason why this Delegation Control is deleted. in: query name: description x-default-description: 'null' schema: type: string maxLength: 255 minLength: 0 ServiceProviderNameQueryParam: description: A filter to return Service Provider resources that match the given name. in: query name: name x-default-description: 'null' schema: type: string maxLength: 255 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, default is timeCreated. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated DelegationControlDisplayNameQueryParam: description: A filter to return Delegation Control resources that match the given display name. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 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 minLength: 1 TimeEndQueryParam: description: 'Query end time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd parameters cannot be used together. ' in: query name: timeEnd x-default-description: End time for query in UTC (yyyy-MM-ddThh:mm:ssZ) schema: type: string format: date-time ServiceProviderLifecycleStateQueryParam: description: A filter to return only Service Provider resources whose lifecycleState matches the given Service Provider lifecycle state. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/ServiceProvider/lifecycleState' schema: type: string CompartmentIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. in: query name: compartmentId required: true x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 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 ServiceProviderActionNameQueryParam: description: A filter to return only resources that match the entire name given. in: query name: name x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 ServiceProviderIdentifierPathParam: description: unique Service Provider identifier in: path name: serviceProviderId required: true schema: type: string EnableProcessTreeQueryParam: description: Set to true to enable process tree computation in audit report in: query name: isProcessTreeEnabled required: false schema: type: boolean default: false PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 DelegationControlIdentifierQueryParam: description: unique Delegation Control identifier in: query name: delegationControlId required: false schema: type: string DelegationSubscriptionLifecycleStateQueryParam: description: A filter to return only Delegation Subscription resources whose lifecycleState matches the given Delegation Subscription lifecycle state. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/DelegationSubscription/lifecycleState' schema: type: string ServiceProviderResourceTypeQueryParam: description: A filter to return only Service Provider resources whose supported resource type matches the given resource type. in: query name: supportedResourceType required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/DelegationControlResourceType' schema: type: string enum: - VMCLUSTER - CLOUDVMCLUSTER ServiceProviderActionSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending. If no value is specified, default is timeCreated. ' in: query name: sortBy schema: type: string enum: - timeCreated - name default: timeCreated TimeStartQueryParam: description: 'Query start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd parameters cannot be used together. ' in: query name: timeStart x-default-description: Start time for query in UTC (yyyy-MM-ddThh:mm:ssZ) schema: type: string format: date-time 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 DelegationControlResourceIdQueryParam: description: A filter to return Delegation Control resources that match the given resource ID. in: query name: resourceId x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 DelegationControlIdentifierPathParam: description: unique Delegation Control identifier in: path name: delegationControlId required: true schema: type: string maxLength: 255 minLength: 1 ServiceProviderSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending. If no value is specified, timeCreated is default. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated DelegationControlLifecycleStateQueryParam: description: A filter to return only Delegation Control resources whose lifecycleState matches the given Delegation Control lifecycle state. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/DelegationControl/lifecycleState' schema: type: string ServiceProviderServiceTypeQueryParam: description: A filter to return only resources that match the given Service Provider service type. in: query name: serviceProviderServiceType required: false x-default-description: 'null' style: form explode: true schema: type: array items: enum: - TROUBLESHOOTING - ASSISTED_PATCHING type: string x-obmcs-top-level-enum: '#/definitions/ServiceProviderServiceType' DelegatedResourceAccessRequestIdentifierPathParam: description: Unique Delegated Resource Access Request identifier in: path name: delegatedResourceAccessRequestId required: true schema: type: string DelegatedResourceAccessRequestSortByQueryParam: 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, default is timeCreated. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated DelegationSubscriptionIdentifierPathParam: description: unique Delegation Subscription identifier in: path name: delegationSubscriptionId required: true schema: type: string ServiceProviderActionLifecycleStateQueryParam: description: A filter to return only resources whose lifecycleState matches the given Service Provider Action lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/ServiceProviderAction/lifecycleState' schema: type: string DelegatedResourceAccessRequestResourceIdQueryParam: description: A filter to return only Delegated Resource Access Requests for the given resource identifier. in: query name: resourceId required: false schema: type: string DelegationControlResourceTypeQueryParam: description: A filter to return only resources that match the given resource type. in: query name: resourceType required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/DelegationControlResourceType' schema: type: string enum: - VMCLUSTER - CLOUDVMCLUSTER DelegationSubscriptionSortByQueryParam: 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 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 ServiceProviderTypeQueryParam: description: A filter to return only Service Provider resources whose provider type matches the given provider type. in: query name: serviceProviderType required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/ServiceProvider/serviceProviderType' schema: type: string RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string DelegatedResourceAccessRequestLifecycleStateQueryParam: description: A filter to return only Delegated Resource Access Requests whose lifecycleState matches the given Delegated Resource Access Request lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/DelegatedResourceAccessRequest/lifecycleState' schema: type: string DelegatedResourceAccessRequestHistorySortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timestamp is descending. If no value is specified, timestamp is default. ' in: query name: sortBy schema: type: string enum: - timestamp default: timestamp DelegatedResourceAccessRequestStatusQueryParam: description: A filter to return only Delegated Resource Access Requests whose status matches the given Delegated Resource Access Request status. in: query name: requestStatus required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/DelegatedResourceAccessRequestStatus' schema: type: string enum: - CREATED - APPROVAL_WAITING - OPERATOR_ASSIGNMENT_WAITING - PREAPPROVED - APPROVED - APPROVED_FOR_FUTURE - REJECTED - DEPLOYED - DEPLOY_FAILED - UNDEPLOYED - UNDEPLOY_FAILED - CLOSE_FAILED - REVOKE_FAILED - EXPIRY_FAILED - REVOKING - REVOKED - EXTENDING - EXTENDED - EXTENSION_REJECTED - EXTENSION_FAILED - COMPLETING - COMPLETED - EXPIRED DelegationSubscriptionDisplayNameQueryParam: description: A filter to return Delegation Subscription resources that match the given display name. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 schemas: DelegationSubscription: description: 'Details of the Delegation Subscription. ' properties: compartmentId: description: The OCID of the compartment that contains the Delegation Subscription. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'Description of the Delegation Subscription. ' type: string displayName: description: Display name maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: Unique identifier for the Delegation Subscription. type: string lifecycleState: description: The current lifecycle state of the Service Provider. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED type: string lifecycleStateDetails: description: Description of the current lifecycle state in more detail. type: string serviceProviderId: description: Unique identifier of the Service Provider. type: string subscribedServiceType: description: Subscribed Service Provider Service Type. enum: - TROUBLESHOOTING - ASSISTED_PATCHING type: string x-obmcs-top-level-enum: '#/definitions/ServiceProviderServiceType' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'Time when the Service Provider was created expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z'' ' format: date-time type: string timeUpdated: description: 'Time when the Service Provider was last modified expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z'' ' format: date-time type: string required: - id - serviceProviderId - subscribedServiceType type: object CreateDelegationControlDetails: description: 'While creating the Delegation Control, specify how Service Provider Actions are approved and the users who have the privilege of approving the Service Provider Actions associated with the Delegation Control. You must specify which Service Provider Actions must be pre-approved. The rest of the Service Provider Actions associated with the Delegation Control will require an explicit approval from the users selected either through the approver groups or individually. You must name your Delegation Control appropriately so it reflects the resources that will be governed by the Delegation Control. Neither the Delegation Controls nor their assignments to resources are visible to the support operators. ' properties: compartmentId: description: The OCID of the compartment that contains this Delegation Control. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object delegationSubscriptionIds: description: List of Delegation Subscription OCID that are allowed for this Delegation Control. The allowed subscriptions will determine the available Service Provider Actions. Only support operators for the allowed subscriptions are allowed to create Delegated Resource Access Request. items: maxLength: 255 minLength: 1 type: string minItems: 1 type: array description: description: Description of the Delegation Control. maxLength: 400 type: string displayName: description: Name of the Delegation Control. The name does not need to be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isAutoApproveDuringMaintenance: description: Set to true to allow all Delegated Resource Access Request to be approved automatically during maintenance. type: boolean notificationMessageFormat: description: The format of the OCI Notification messages for this Delegation Control. type: string x-obmcs-enumref: '#/definitions/DelegationControl/notificationMessageFormat' notificationTopicId: description: The OCID of the OCI Notification topic to publish messages related to this Delegation Control. maxLength: 255 minLength: 1 type: string numApprovalsRequired: default: 1 description: number of approvals required. maximum: 2 minimum: 1 type: integer preApprovedServiceProviderActionNames: description: 'List of pre-approved Service Provider Action names. The list of pre-defined Service Provider Actions can be obtained from the ListServiceProviderActions API. Delegated Resource Access Requests associated with a resource governed by this Delegation Control will be automatically approved if the Delegated Resource Access Request only contain Service Provider Actions in the pre-approved list. ' items: maxLength: 255 minLength: 1 type: string type: array resourceIds: description: The OCID of the selected resources that this Delegation Control is applicable to. items: maxLength: 255 minLength: 1 type: string maxItems: 10 minItems: 1 type: array resourceType: description: Resource type for which the Delegation Control is applicable to. enum: - VMCLUSTER - CLOUDVMCLUSTER type: string x-obmcs-top-level-enum: '#/definitions/DelegationControlResourceType' vaultId: description: The OCID of the OCI Vault that will store the secrets containing the SSH keys to access the resource governed by this Delegation Control by Delegate Access Control Service. This property is required when resourceType is CLOUDVMCLUSTER. Delegate Access Control Service will generate the SSH keys and store them as secrets in the OCI Vault. maxLength: 255 minLength: 1 type: string vaultKeyId: description: The OCID of the Master Encryption Key in the OCI Vault specified by vaultId. This key will be used to encrypt the SSH keys to access the resource governed by this Delegation Control by Delegate Access Control Service. This property is required when resourceType is CLOUDVMCLUSTER. maxLength: 255 minLength: 1 type: string required: - displayName - compartmentId - resourceIds - resourceType - delegationSubscriptionIds - notificationTopicId - notificationMessageFormat type: object DelegatedResourceAccessRequestApprovalDetails: description: 'Approval info for initial access or extension of a Delegated Resource Access Request ' properties: approvalAction: description: Indicated whether the request is approved or rejected. enum: - APPROVE - REJECT type: string approvalType: description: approval type, initial or extension enum: - INITIAL - EXTENSION type: string approverAdditionalMessage: description: Additional message specified by the approver of the request. type: string approverComment: description: Comment specified by the approver of the request. type: string approverId: description: User ID of the approver. type: string timeApprovedForAccess: description: Access start time that is actually approved by the customer in [RFC 3339](https://tools.ietf.org/html/rfc3339)timestamp format, e.g. '2020-05-22T21:10:29.600Z'. format: date-time type: string required: - approverComment type: object ServiceProviderInteractionSummary: description: Summary of customer and operator conversation. properties: message: description: The information exchanged between the customer and the operator. type: string messageIdentifier: description: The unique identifier of the message within the scope of the associated access request. type: string timestamp: description: 'Time when the conversation happened in [RFC 3339](https://tools.ietf.org/html/rfc3339)timestamp format, e.g. ''2020-05-22T21:10:29.600Z''. ' format: date-time type: string userId: description: ID of the customer or operator who is part of this conversation. For operator, this field is null. type: string userName: description: Name of the customer or operator who is part of this conversation. For operator, the name is "Operator". type: string userType: description: Indicates whether the user is a customer or an operator. enum: - CUSTOMER - OPERATOR type: string type: object ServiceProviderActionSummary: description: Details of the Service Provider Action. Service provider actions are pre-defined set of commands available to the support operator on different layers of the infrastructure. properties: component: description: Name of the component for which the Service Provider Action is applicable. type: string customerDisplayName: description: Display Name of the Service Provider Action. type: string description: description: 'Description of the Service Provider Action in terms of associated risk profile, and characteristics of the operating system commands made available to the support operator under this Service Provider Action. ' type: string id: description: Unique identifier assigned by Oracle to a Service Provider Action. type: string isSshAccessAllowed: description: Indicates whether the service provider action allows SSH access. type: boolean lifecycleState: description: The current lifecycle state of the Service Provider Action. type: string x-obmcs-enumref: '#/definitions/ServiceProviderAction/lifecycleState' name: description: Name of the Service Provider Action. type: string resourceType: description: resourceType for which the ServiceProviderAction is applicable enum: - VMCLUSTER - CLOUDVMCLUSTER type: string x-obmcs-top-level-enum: '#/definitions/DelegationControlResourceType' serviceProviderServiceTypes: description: List of Service Provider Service Types that this Service Provider Action is applicable to. items: enum: - TROUBLESHOOTING - ASSISTED_PATCHING type: string x-obmcs-top-level-enum: '#/definitions/ServiceProviderServiceType' type: array required: - id - name type: object ServiceProvider: description: 'Details of the Service Provider. Service provider offers services to the customer to support the delegated resources. ' properties: compartmentId: description: The OCID of the compartment that contains the Service Provider. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'Description of the Service Provider. ' maxLength: 400 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: Unique identifier for the Service Provider. type: string lifecycleState: description: The current lifecycle state of the Service Provider. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED type: string lifecycleStateDetails: description: Description of the current lifecycle state in more detail. type: string name: description: Unique name of the Service Provider. type: string serviceProviderType: description: Service Provider type. enum: - ORACLE_PROVIDED type: string serviceTypes: description: Types of services offered by this provider. items: enum: - TROUBLESHOOTING - ASSISTED_PATCHING type: string x-obmcs-top-level-enum: '#/definitions/ServiceProviderServiceType' minItems: 1 type: array supportedResourceTypes: description: Resource types for which this provider will provide service. Default to all if not specified. items: enum: - VMCLUSTER - CLOUDVMCLUSTER type: string x-obmcs-top-level-enum: '#/definitions/DelegationControlResourceType' minItems: 1 type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'Time when the Service Provider was created expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z'' ' format: date-time type: string timeUpdated: description: 'Time when the Service Provider was last modified expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z'' ' format: date-time type: string required: - id - name - serviceProviderType - serviceTypes - supportedResourceTypes 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 DelegationControlResourceSummary: description: Details of the resources that this Delegation Control is applicable to. properties: id: description: OCID of the resource. maxLength: 255 minLength: 1 type: string resourceStatus: description: The current status of the resource in Delegation Control. enum: - CREATED - APPLYING - APPLIED - APPLY_FAILED - UPDATING - UPDATE_FAILED - DELETING - DELETED - DELETION_FAILED type: string type: object UpdateDelegationControlDetails: description: Information about the new Delegation Control. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object delegationSubscriptionIds: description: List of Delegation Subscription OCID that are allowed for this Delegation Control. The allowed subscriptions will determine the available Service Provider Actions. Only support operators for the allowed subscriptions are allowed to create Delegated Resource Access Request. items: maxLength: 255 minLength: 1 type: string minItems: 1 type: array description: description: Description of the Delegation Control. maxLength: 400 type: string displayName: description: Name of the Delegation Control. The name does not need to be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isAutoApproveDuringMaintenance: description: Set to true to allow all Delegated Resource Access Request to be approved automatically during maintenance. type: boolean notificationMessageFormat: description: The format of the OCI Notification messages for this Delegation Control. type: string x-obmcs-enumref: '#/definitions/DelegationControl/notificationMessageFormat' notificationTopicId: description: The OCID of the OCI Notification topic to publish messages related to this Delegation Control. maxLength: 255 minLength: 1 type: string numApprovalsRequired: default: 1 description: number of approvals required. maximum: 2 minimum: 1 type: integer preApprovedServiceProviderActionNames: description: 'List of pre-approved Service Provider Action names. The list of pre-defined Service Provider Actions can be obtained from the ListServiceProviderActions API. Delegated Resource Access Requests associated with a resource governed by this Delegation Control will be automatically approved if the Delegated Resource Access Request only contain Service Provider Actions in the pre-approved list. ' items: maxLength: 255 minLength: 1 type: string type: array resourceIds: description: The OCID of the selected resources that this Delegation Control is applicable to. items: maxLength: 255 minLength: 1 type: string maxItems: 10 minItems: 1 type: array type: object ServiceProviderInteractionCollection: description: Results of access request additionalInfo search, which contains details of the conversation between customer and operator. properties: items: description: contains ServiceProviderInteractionSummary items: $ref: '#/components/schemas/ServiceProviderInteractionSummary' type: array required: - items type: object ServiceProviderAction: description: "Details of the Service Provider Action. Service provider actions are a pre-defined set of commands available to the support operator on different layers of the infrastructure. Although the groupings may differ depending on the infrastructure layers, \nthe groups are designed to enable the support operator access to commands to resolve a specific set of issues.\n" properties: component: description: Name of the infrastructure layer associated with the Service Provider Action. type: string customerDisplayName: description: Display Name of the Service Provider Action. type: string description: description: 'Description of the Service Provider Action in terms of associated risk profile, and characteristics of the operating system commands made available to the support operator under this Service Provider Action. ' type: string id: description: Unique Oracle assigned identifier for the Service Provider Action. type: string isSshAccessAllowed: description: Indicates whether the service provider action allows SSH access. type: boolean lifecycleState: description: The current lifecycle state of the Service Provider Action. enum: - ACTIVE - INACTIVE type: string name: description: Unique name of the Service Provider Action. type: string properties: description: Fine grained properties associated with the Delegation Control. items: $ref: '#/components/schemas/ServiceProviderActionProperties' type: array resourceType: description: resourceType for which the ServiceProviderAction is applicable enum: - VMCLUSTER - CLOUDVMCLUSTER type: string x-obmcs-top-level-enum: '#/definitions/DelegationControlResourceType' serviceProviderServiceTypes: description: List of Service Provider Service Types that this Service Provider Action is applicable to. items: enum: - TROUBLESHOOTING - ASSISTED_PATCHING type: string x-obmcs-top-level-enum: '#/definitions/ServiceProviderServiceType' type: array required: - id - name type: object ApproveDelegatedResourceAccessRequestDetails: description: Details of the Delegated Resource Access Request approval. properties: additionalMessage: description: Message that needs to be displayed to the operator. maxLength: 500 type: string approverComment: description: Comment by the approver during approval. maxLength: 500 minLength: 1 type: string timeApprovedForAccess: description: 'Access start time that is actually approved by the customer in [RFC 3339](https://tools.ietf.org/html/rfc3339)timestamp format, e.g. ''2020-05-22T21:10:29.600Z''. ' format: date-time type: string type: object RevokeDelegatedResourceAccessRequestDetails: description: Summary of why the already approved Delegated Resource Access Request was revoked. properties: approverComment: description: Comment specified by the approver explaining why the approval is revoked. maxLength: 500 minLength: 1 type: string type: object DelegationControl: description: 'Delegation Control enables you to grant, audit, or revoke the access Oracle has to your Exadata Cloud infrastructure, and obtain audit reports of all actions taken by a human operator, in a near real-time manner. ' properties: compartmentId: description: The OCID of the compartment that contains the Delegation Control. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object delegationSubscriptionIds: description: List of Delegation Subscription OCID that are allowed for this Delegation Control. The allowed subscriptions will determine the available Service Provider Actions. Only support operators for the allowed subscriptions are allowed to create Delegated Resource Access Request. items: maxLength: 255 minLength: 1 type: string minItems: 1 type: array description: description: Description of the Delegation Control. type: string displayName: description: Name of the Delegation Control. The name does not need to be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the Delegation Control. type: string isAutoApproveDuringMaintenance: description: Set to true to allow all Delegated Resource Access Request to be approved automatically during maintenance. type: boolean lifecycleState: description: The current lifecycle state of the Delegation Control. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED - NEEDS_ATTENTION type: string lifecycleStateDetails: description: Description of the current lifecycle state in more detail. type: string notificationMessageFormat: description: The format of the OCI Notification messages for this Delegation Control. enum: - JSON - HTML type: string notificationTopicId: description: The OCID of the OCI Notification topic to publish messages related to this Delegation Control. maxLength: 255 minLength: 1 type: string numApprovalsRequired: default: 1 description: number of approvals required. maximum: 2 minimum: 1 type: integer preApprovedServiceProviderActionNames: description: 'List of pre-approved Service Provider Action names. The list of pre-defined Service Provider Actions can be obtained from the ListServiceProviderActions API. Delegated Resource Access Requests associated with a resource governed by this Delegation Control will be automatically approved if the Delegated Resource Access Request only contain Service Provider Actions in the pre-approved list. ' items: maxLength: 255 minLength: 1 type: string type: array resourceIds: description: The OCID of the selected resources that this Delegation Control is applicable to. items: maxLength: 255 minLength: 1 type: string type: array resourceType: description: Resource type for which the Delegation Control is applicable to. enum: - VMCLUSTER - CLOUDVMCLUSTER type: string x-obmcs-top-level-enum: '#/definitions/DelegationControlResourceType' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'Time when the Delegation Control was created expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z'' ' format: date-time type: string timeDeleted: description: 'Time when the Delegation Control was deleted expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339)timestamp format, e.g. ''2020-05-22T21:10:29.600Z''. Note a deleted Delegation Control still stays in the system, so that you can still audit Service Provider Actions associated with Delegated Resource Access Requests raised on target resources governed by the deleted Delegation Control. ' format: date-time type: string timeUpdated: description: 'Time when the Delegation Control was last modified expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z'' ' format: date-time type: string vaultId: description: The OCID of the OCI Vault that will store the secrets containing the SSH keys to access the resource governed by this Delegation Control by Delegate Access Control Service. This property is required when resourceType is CLOUDVMCLUSTER. Delegate Access Control Service will generate the SSH keys and store them as secrets in the OCI Vault. maxLength: 255 minLength: 1 type: string vaultKeyId: description: The OCID of the Master Encryption Key in the OCI Vault specified by vaultId. This key will be used to encrypt the SSH keys to access the resource governed by this Delegation Control by Delegate Access Control Service. This property is required when resourceType is CLOUDVMCLUSTER. maxLength: 255 minLength: 1 type: string required: - id - displayName - compartmentId - resourceType type: object ChangeDelegationControlCompartmentDetails: description: Details of the new compartment to contain the Delegation Control. properties: compartmentId: description: The OCID of the new compartment to contain the Delegation Control. maxLength: 255 minLength: 1 type: string DelegatedResourceAccessRequest: description: "A support operator raises Delegated Resource Access Request when they need access to any infrastructure resource governed by Delegation Control.\nThe Delegated Resource Access Request identifies the target resource and the set of Service Provider Actions. Delegated Resource Access Request handling depends upon the Delegation Control \nthat governs the target resource, and the set of Service Provider Actions listed for approval in the Delegated Resource Access Request. If all of the Service Provider Actions \nlisted in the Delegated Resource Access Request are in the pre-approved list in the Delegation Control that governs the target resource, then the Delegated Resource Access Request is \nautomatically approved. If not, then the Delegated Resource Access Request requires explicit approval from the approver group specified by the Delegation Control governing the target resource.\n\nYou can approve or reject a Delegated Resource Access Request. You can also revoke the approval of an already approved Delegated Resource Access Request. While creating a Delegated Resource Access Request, \nthe support operator specifies the duration of access. You have the option to approve the entire duration or reduce or even increase the time duration. \nA support operator can also request for an extension. The approval for such an extension is processed the same way the original Delegated Resource Access Request was processed.\n" properties: approvalInfo: description: In case of single approval, this will have only one item. Else, a list of approvals. items: $ref: '#/components/schemas/DelegatedResourceAccessRequestApprovalDetails' type: array auditTypes: description: "Specifies the type of auditing to be enabled. There are two levels of auditing: command-level and keystroke-level. \nBy default, both command-level and keystroke-level auditing are enabled, i.e. commands and key strokes issued by the support operator are logged.\n" items: enum: - COMMAND_AUDIT - COMMAND_KEYSTROKE_AUDIT type: string x-obmcs-top-level-enum: '#/definitions/DelegatedResourceAccessRequestAuditType' type: array closureComment: description: The comment entered by the support operator while closing the request. type: string compartmentId: description: The OCID of the compartment that contains the Delegated Resource Access Request. type: string databaseNameList: description: List of Database unique names for which access is requested. This parameter is required for DLGT_MGMT_SYS_MAINT_ACCESS cage when database access in needed. items: maxLength: 30 minLength: 1 type: string maxItems: 10 type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object delegationControlId: description: The OCID of the Delegation Control governing the target resource. type: string delegationSubscriptionIds: description: List of Delegation Subscription OCID that are associated with this Delegated Resource Access Request based on the service types being requested. items: maxLength: 255 minLength: 1 type: string type: array description: description: Detailed description of this Delegated Resource Access Request. type: string displayName: description: Display name. This is generated by the system automatically. type: string durationInHours: description: Duration in hours for which access is sought on the target resource. type: integer extendDurationInHours: description: Duration in hours for which extension access is sought on the target resource. type: integer freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the Delegated Resource Access Request. type: string isAutoApproved: description: Set to true if the request is approved automatically based on preApprovedServiceProviderActionNames or isAutoApproveDuringMaintenance in the associated Delegation Control. type: boolean isPendingMoreInfo: description: Indicates if the delegated resource access request is waiting on more information from the operator type: boolean lifecycleState: description: The current lifecycle state of the Delegated Resource Access Request. enum: - ACCEPTED - IN_PROGRESS - WAITING - FAILED - SUCCEEDED - CANCELING - CANCELED - NEEDS_ATTENTION type: string lifecycleStateDetails: description: Description of the current lifecycle state in more detail. type: string numExtensionApprovals: description: Number of extension approvals that have been obtained so far. type: integer numInitialApprovals: description: Number of initial approvals that have been obtained so far. type: integer providedServiceTypes: description: List of Service Provider Service Types being provided by the support operator user. items: enum: - TROUBLESHOOTING - ASSISTED_PATCHING type: string x-obmcs-top-level-enum: '#/definitions/ServiceProviderServiceType' type: array reasonForRequest: description: A short description explaining why this Delegated Resource Access Request is needed by the support operator. type: string requestStatus: description: The current status of the Delegated Resource Access Request. enum: - CREATED - APPROVAL_WAITING - OPERATOR_ASSIGNMENT_WAITING - PREAPPROVED - APPROVED - APPROVED_FOR_FUTURE - REJECTED - DEPLOYED - DEPLOY_FAILED - UNDEPLOYED - UNDEPLOY_FAILED - CLOSE_FAILED - REVOKE_FAILED - EXPIRY_FAILED - REVOKING - REVOKED - EXTENDING - EXTENDED - EXTENSION_REJECTED - EXTENSION_FAILED - COMPLETING - COMPLETED - EXPIRED type: string x-obmcs-top-level-enum: '#/definitions/DelegatedResourceAccessRequestStatus' requestedActionNames: description: List of Service Provider Action names for which approval is sought by the support operator user. The list of pre-defined Service Provider Actions can be obtained from the ListServiceProviderActions API. items: maxLength: 255 minLength: 1 type: string type: array requesterType: description: Requester type enum: - OPERATOR - CUSTOMER - SYSTEM type: string x-obmcs-top-level-enum: '#/definitions/DelegatedResourceAccessRequesterType' resourceId: description: "The OCID of the target resource associated with the Delegated Resource Access Request. The support operator raises a Delegated Resource Access Request to get approval to \naccess the target resource.\n" type: string resourceName: description: "The name of the target resource associated with the Delegated Resource Access Request. The support operator raises a Delegated Resource Access Request to get approval to \naccess the target resource.\n" type: string resourceType: description: Resource type for which the associated Delegation Control is applicable to. enum: - VMCLUSTER - CLOUDVMCLUSTER type: string x-obmcs-top-level-enum: '#/definitions/DelegationControlResourceType' severity: description: Priority assigned to the Delegated Resource Access Request by the support operator enum: - S1 - S2 - S3 - S4 type: string x-obmcs-top-level-enum: '#/definitions/DelegatedResourceAccessRequestSeverity' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object ticketNumbers: description: A list of ticket numbers related to this Delegated Resource Access Request, e.g. Service Request (SR) number and JIRA ticket number. items: type: string type: array timeAccessRequested: description: Requested access start time in UTC. format: date-time type: string timeCreated: description: 'Time when the Delegated Resource Access Request was created in [RFC 3339](https://tools.ietf.org/html/rfc3339)timestamp format, e.g. ''2020-05-22T21:10:29.600Z''. ' format: date-time type: string timeUpdated: description: 'Time when the Delegated Resource Access Request was last modified in [RFC 3339](https://tools.ietf.org/html/rfc3339)timestamp format, e.g. ''2020-05-22T21:10:29.600Z''. ' format: date-time type: string required: - id - compartmentId - reasonForRequest - description - resourceId type: object DelegatedResourceAccessRequestSummary: description: Summary of Delegated Resource Access Request. properties: compartmentId: description: The OCID of the compartment that contains the Delegated Resource Access Request. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object delegationControlId: description: The OCID of the Delegation Control governing the target resource. type: string displayName: description: Display name. This is generated by the system automatically. type: string durationInHours: description: Duration in hours for which access is sought on the target resource. type: integer extendDurationInHours: description: Duration in hours for which extension access is sought on the target resource. type: integer freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the Delegated Resource Access Request. type: string isAutoApproved: description: Set to true if the request is approved automatically based on preApprovedServiceProviderActionNames or isAutoApproveDuringMaintenance in the associated Delegation Control. type: boolean lifecycleState: description: The current lifecycle state of the Delegated Resource Access Request. type: string x-obmcs-enumref: '#/definitions/DelegatedResourceAccessRequest/lifecycleState' lifecycleStateDetails: description: Description of the current lifecycle state in more detail. type: string reasonForRequest: description: A short description explaining why this Delegated Resource Access Request is needed by the support operator. type: string requestStatus: description: The current status of the Delegated Resource Access Request. enum: - CREATED - APPROVAL_WAITING - OPERATOR_ASSIGNMENT_WAITING - PREAPPROVED - APPROVED - APPROVED_FOR_FUTURE - REJECTED - DEPLOYED - DEPLOY_FAILED - UNDEPLOYED - UNDEPLOY_FAILED - CLOSE_FAILED - REVOKE_FAILED - EXPIRY_FAILED - REVOKING - REVOKED - EXTENDING - EXTENDED - EXTENSION_REJECTED - EXTENSION_FAILED - COMPLETING - COMPLETED - EXPIRED type: string x-obmcs-top-level-enum: '#/definitions/DelegatedResourceAccessRequestStatus' requestedActionNames: description: List of Service Provider Action names for which approval is sought by the support operator user. The list of pre-defined Service Provider Actions can be obtained from the ListServiceProviderActions API. items: maxLength: 255 minLength: 1 type: string type: array requesterType: description: Requester type enum: - OPERATOR - CUSTOMER - SYSTEM type: string x-obmcs-top-level-enum: '#/definitions/DelegatedResourceAccessRequesterType' resourceId: description: "The OCID of the target resource associated with the Delegated Resource Access Request. The support operator raises a Delegated Resource Access Request to get approval to \naccess the target resource.\n" type: string resourceName: description: "The name of the target resource associated with the Delegated Resource Access Request. The support operator raises a Delegated Resource Access Request to get approval to \naccess the target resource.\n" type: string resourceType: description: Resource type for which the associated Delegation Control is applicable to. enum: - VMCLUSTER - CLOUDVMCLUSTER type: string x-obmcs-top-level-enum: '#/definitions/DelegationControlResourceType' severity: description: Priority assigned to the Delegated Resource Access Request by the support operator enum: - S1 - S2 - S3 - S4 type: string x-obmcs-top-level-enum: '#/definitions/DelegatedResourceAccessRequestSeverity' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object ticketNumbers: description: A list of ticket numbers related to this Delegated Resource Access Request, e.g. Service Request (SR) number and JIRA ticket number. items: type: string type: array timeAccessRequested: description: Requested access start time in UTC. format: date-time type: string timeCreated: description: 'Time when the Delegated Resource Access Request was created by the support operator user in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z''. ' format: date-time type: string timeUpdated: description: 'Time when the Delegated Resource Access Request was last modified in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z''. ' format: date-time type: string required: - id - compartmentId - reasonForRequest - resourceId - delegationControlId type: object DelegatedResourceAccessRequestHistorySummary: description: Summary of Delegated Resource Access Request status changes. properties: comment: description: Comment about the status change. type: string lifecycleState: description: The current lifecycle state of the Delegated Resource Access Request. type: string x-obmcs-enumref: '#/definitions/DelegatedResourceAccessRequest/lifecycleState' requestStatus: description: The current status of the Delegated Resource Access Request. enum: - CREATED - APPROVAL_WAITING - OPERATOR_ASSIGNMENT_WAITING - PREAPPROVED - APPROVED - APPROVED_FOR_FUTURE - REJECTED - DEPLOYED - DEPLOY_FAILED - UNDEPLOYED - UNDEPLOY_FAILED - CLOSE_FAILED - REVOKE_FAILED - EXPIRY_FAILED - REVOKING - REVOKED - EXTENDING - EXTENDED - EXTENSION_REJECTED - EXTENSION_FAILED - COMPLETING - COMPLETED - EXPIRED type: string x-obmcs-top-level-enum: '#/definitions/DelegatedResourceAccessRequestStatus' timestamp: description: 'Time when the respective action happened in [RFC 3339](https://tools.ietf.org/html/rfc3339)timestamp format, e.g. ''2020-05-22T21:10:29.600Z''. ' format: date-time type: string userId: description: ID of user who modified the Delegated Resource Access Request. For operator, this field is "Operator". type: string type: object DelegationControlSummaryCollection: description: Results of Delegation Control search, which contains summary of the Delegation Control. properties: items: description: contains DelegationControlSummary items: $ref: '#/components/schemas/DelegationControlSummary' type: array required: - items type: object DelegatedResourceAccessRequestSummaryCollection: description: Results of Delegated Resource Access Request search, which contains summary of Delegated Resource Access Request. properties: items: description: contains DelegatedResourceAccessRequestSummary items: $ref: '#/components/schemas/DelegatedResourceAccessRequestSummary' type: array required: - items type: object ChangeDelegationSubscriptionCompartmentDetails: description: Details of the new compartment to contain the Delegation Subscription. properties: compartmentId: description: The OCID of the new compartment to contain the Delegation Subscription. maxLength: 255 minLength: 1 type: string DelegationSubscriptionSummaryCollection: description: List of DelegationSubscriptionSummary objects. properties: items: description: List of DelegationSubscriptionSummary objects. items: $ref: '#/components/schemas/DelegationSubscriptionSummary' type: array required: - items type: object ServiceProviderInteractionRequestDetails: description: Details for asking operator to provide more information. properties: moreInfoDetails: description: Questions for operator to provide more information. maxLength: 500 minLength: 1 type: string type: object CreateDelegationSubscriptionDetails: description: 'Details for creating the Delegation Subscription. ' properties: compartmentId: description: The OCID of the compartment that contains the Delegation Subscription. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'Description of the Delegation Subscription. ' maxLength: 400 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object serviceProviderId: description: Unique identifier of the Service Provider. maxLength: 255 minLength: 1 type: string subscribedServiceType: description: Subscribed Service Provider Service Type. enum: - TROUBLESHOOTING - ASSISTED_PATCHING type: string x-obmcs-top-level-enum: '#/definitions/ServiceProviderServiceType' required: - compartmentId - serviceProviderId - subscribedServiceType type: object DelegationControlResourceCollection: description: List of DelegationControlResourceSummary objects. properties: items: description: List of DelegationControlResourceSummary objects. items: $ref: '#/components/schemas/DelegationControlResourceSummary' type: array required: - items type: object DelegatedResourceAccessRequestAuditLogReport: description: The audit log report details. properties: auditReportStatus: description: Status of the audit report enum: - NOTAVAILABLE - AVAILABLE - EXPIRED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/AuditReportStatus' processTree: description: The process tree data type: string report: description: Audit log report. type: string timeReportGenerated: description: 'Time when the audit report was generated [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z'' ' format: date-time type: string required: - auditReportStatus type: object DelegationControlSummary: description: Summary of the Delegation Control. properties: compartmentId: description: The OCID of the compartment that contains the Delegation Control. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: Name of the Delegation Control. The name does not need to be unique. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the Delegation Control. type: string lifecycleState: description: The current lifecycle state of the Delegation Control. type: string x-obmcs-enumref: '#/definitions/DelegationControl/lifecycleState' lifecycleStateDetails: description: Description of the current lifecycle state in more detail. type: string resourceType: description: resourceType for which the Delegation Control is applicable enum: - VMCLUSTER - CLOUDVMCLUSTER type: string x-obmcs-top-level-enum: '#/definitions/DelegationControlResourceType' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'Time when the Delegation Control was created, expressed in [RFC 3339] (https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z''. ' format: date-time type: string timeDeleted: description: 'Time when the Delegation Control was deleted, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z''. ' format: date-time type: string timeUpdated: description: 'Time when the Delegation Control was last modified, expressed in [RFC 3339] (https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z''. ' format: date-time type: string required: - id - displayName - compartmentId - resourceType type: object DelegationSubscriptionSummary: description: 'Summary of the Delegation Subscription. ' properties: compartmentId: description: The OCID of the compartment that contains the Delegation Subscription. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: Display name maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: Unique identifier for the Delegation Subscription. type: string lifecycleState: description: The current lifecycle state of the Service Provider. type: string x-obmcs-enumref: '#/definitions/DelegationSubscription/lifecycleState' lifecycleStateDetails: description: Description of the current lifecycle state in more detail. type: string serviceProviderId: description: Unique identifier of the Service Provider. type: string subscribedServiceType: description: Subscribed Service Provider Service Type. enum: - TROUBLESHOOTING - ASSISTED_PATCHING type: string x-obmcs-top-level-enum: '#/definitions/ServiceProviderServiceType' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'Time when the Service Provider was created expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z'' ' format: date-time type: string timeUpdated: description: 'Time when the Service Provider was last modified expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z'' ' format: date-time type: string required: - id - serviceProviderId - subscribedServiceType type: object ServiceProviderSummary: description: 'Summary of the Service Provider. Service provider offers services to the customer to support the delegated resources. ' properties: compartmentId: description: The OCID of the compartment that contains the Service Provider. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: Unique identifier for the Service Provider. type: string lifecycleState: description: The current lifecycle state of the Service Provider. type: string x-obmcs-enumref: '#/definitions/ServiceProvider/lifecycleState' lifecycleStateDetails: description: Description of the current lifecycle state in more detail. type: string name: description: Unique name of the Service Provider. type: string serviceProviderType: description: Service Provider type. type: string x-obmcs-enumref: '#/definitions/ServiceProvider/serviceProviderType' serviceTypes: description: Types of services offered by this provider. items: enum: - TROUBLESHOOTING - ASSISTED_PATCHING type: string x-obmcs-top-level-enum: '#/definitions/ServiceProviderServiceType' type: array supportedResourceTypes: description: Resource types for which this provider will provide service. Default to all if not specified. items: enum: - VMCLUSTER - CLOUDVMCLUSTER type: string x-obmcs-top-level-enum: '#/definitions/DelegationControlResourceType' type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'Time when the Service Provider was created expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z'' ' format: date-time type: string timeUpdated: description: 'Time when the Service Provider was last modified expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z'' ' format: date-time type: string required: - id - name type: object ServiceProviderActionProperties: description: Details of the properties of Service Provider Action. properties: name: description: Name of the property type: string value: description: value of the property type: string type: object DelegatedResourceAccessRequestHistoryCollection: description: List of Delegated Resource Access Request status transitions. properties: items: description: List of DelegatedResourceAccessRequestHistorySummary objects. items: $ref: '#/components/schemas/DelegatedResourceAccessRequestHistorySummary' type: array required: - items type: object ServiceProviderSummaryCollection: description: List of ServiceProviderSummary objects. properties: items: description: List of ServiceProviderSummary objects. items: $ref: '#/components/schemas/ServiceProviderSummary' type: array required: - items type: object ServiceProviderActionSummaryCollection: description: List of ServiceProviderActionSummary resources. properties: items: description: contains ServiceProviderActionSummary items: $ref: '#/components/schemas/ServiceProviderActionSummary' type: array required: - items type: object RejectDelegatedResourceAccessRequestDetails: description: Summary of why the Delegated Resource Access Request was rejected. properties: approverComment: description: Comment by the approver explaining why the request is rejected. maxLength: 500 minLength: 1 type: string type: object UpdateDelegationSubscriptionDetails: description: 'Details for updating the Delegation Subscription. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'Description of the Delegation Subscription. ' maxLength: 400 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object type: object 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' x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' 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: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' 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: content-location: description: URI of the resource format: uri-reference type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object location: description: URI of the resource format: uri-reference type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.db.dactl