openapi: 3.2.0 info: description: 'Use the Managed Access API to approve access requests, create and manage templates, and manage resource approval settings. For more information, see [Managed Access Overview](https://docs.oracle.com/iaas/Content/managed-access/home.htm). Use the table of contents and search tool to explore the Managed Access API. ' title: Managed Access Partner API version: '20220126' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/f397c9292e6f977d1885091f8a6e9a9c3cdcb882c49d89bc55720e8eec0c02d1.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Managed Access 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/f397c9292e6f977d1885091f8a6e9a9c3cdcb882c49d89bc55720e8eec0c02d1.yaml what: the harvested document for Managed Access API servers: - url: http://127.0.0.1/20220126 - url: https://127.0.0.1/20220126 tags: - name: partner paths: /partners: get: description: 'Returns a list of Partners. ' operationId: ListPartners parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PartnerLifecycleStateQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/PartnerIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of PartnerSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PartnerCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all partners in a compartment tags: - partner x-related-resource: '#/definitions/PartnerCollection' post: description: 'Creates a new Partner. ' operationId: CreatePartner parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The Partner is created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: 'this contains the full URI for the get request, e.g. "https://iaas.us-phoenix-1.oraclecloud.com/20210331/lockbox/" ' 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/Partner' 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 Partner tags: - partner x-related-resource: '#/definitions/Partner' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePartnerDetails' description: Details for the new Partner. required: true /partners/{partnerId}: delete: description: Deletes a Partner resource by identifier operationId: DeletePartner parameters: - $ref: '#/components/parameters/PartnerIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: Partner is 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 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: Delete a provisioned Partner tags: - partner x-related-resource: '#/definitions/Partner' get: description: Gets a Partner by identifier operationId: GetPartner parameters: - $ref: '#/components/parameters/PartnerIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Partner 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/Partner' 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 Partner tags: - partner put: description: Updates the Partner operationId: UpdatePartner parameters: - $ref: '#/components/parameters/PartnerIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The Lockbox is updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Partner' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the Partner identified by the id tags: - partner x-related-resource: '#/definitions/Partner' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePartnerDetails' description: The information to be updated. required: true /partners/{partnerId}/actions/changeCompartment: post: description: Moves a Partner resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. operationId: ChangePartnerCompartment parameters: - $ref: '#/components/parameters/PartnerIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: Accepted the request. The Partner resource will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a resource into a different compartment. tags: - partner x-related-resource: '#/definitions/Partner' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangePartnerCompartmentDetails' description: The information to be updated. required: true components: schemas: UpdatePartnerDetails: description: The information to be updated. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Partner description type: string entityTypes: description: The entity types locked for this partner items: type: string type: array freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object maxHoursWaiting: description: Maximum hours a request spends waiting before being autocancelled maximum: 96 minimum: 1 type: integer maxRequestsPerResource: description: Maximum number of active requests per resource maximum: 150 minimum: 1 type: integer opsQueue: description: The jira-sd queue of the partner team type: string partnerApiCall: description: if disabled OMA does not invoke partner API enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/PartnerApiCall' phonebook: description: The phonebook id of the partner team type: string serviceEndpoint: description: The endpoint invoked by OMA to communicate with the partner service. Expects a service endpoint URL if 'partnerApiCall' is enabled. type: string 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 PartnerSummary: description: Summary of the Partner. properties: compartmentId: description: Compartment Identifier type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Partner description type: string entityTypes: description: The entity types locked for this partner items: type: string type: array freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: Unique identifier that is immutable on creation type: string lifecycleState: description: The current state of the Partner. enum: - ACTIVE - CREATING - UPDATING - DELETING - DELETED - FAILED type: string maxHoursWaiting: description: Maximum hours a request spends waiting before being autocancelled maximum: 96 minimum: 1 type: integer maxRequestsPerResource: description: Maximum number of active requests per resource maximum: 150 minimum: 1 type: integer name: description: Partner team name maxLength: 255 minLength: 1 type: string opsQueue: description: The jira-sd queue of the partner team type: string partnerApiCall: description: if disabled OMA does not invoke partner APIs enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/PartnerApiCall' phonebook: description: The phonebook id of the partner team type: string serviceEndpoint: description: The endpoint invoked by OMA to communicate with the partner service when 'partnerApiCall' is enabled type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the the Partner was created. An RFC3339 formatted datetime string format: date-time type: string timeUpdated: description: The time the Partner was updated. An RFC3339 formatted datetime string format: date-time type: string required: - id - name - compartmentId - description - entityTypes - lifecycleState - maxRequestsPerResource - maxHoursWaiting - phonebook - opsQueue - freeformTags - definedTags type: object Partner: description: Description of Partner. properties: compartmentId: description: Compartment Identifier type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Partner description type: string entityTypes: description: The entity types locked for this partner items: type: string type: array freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: Unique identifier that is immutable on creation type: string lifecycleState: description: The current state of the Partner. enum: - ACTIVE - CREATING - UPDATING - DELETING - DELETED - FAILED type: string maxHoursWaiting: description: Maximum hours a request spends waiting before being autocancelled maximum: 96 minimum: 1 type: integer maxRequestsPerResource: description: Maximum number of active requests per resource maximum: 150 minimum: 1 type: integer name: description: Partner team name maxLength: 255 minLength: 1 type: string opsQueue: description: The jira-sd queue of the partner team type: string partnerApiCall: description: if disabled OMA does not invoke partner API enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/PartnerApiCall' phonebook: description: The phonebook id of the partner team type: string serviceEndpoint: description: The endpoint invoked by OMA to communicate with the partner service when 'partnerApiCall' is enabled type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the the Partner was created. An RFC3339 formatted datetime string format: date-time type: string timeUpdated: description: The time the Partner was updated. An RFC3339 formatted datetime string format: date-time type: string required: - id - name - compartmentId - description - entityTypes - lifecycleState - maxRequestsPerResource - maxHoursWaiting - phonebook - opsQueue - freeformTags - definedTags type: object ChangePartnerCompartmentDetails: description: The information to be updated. properties: compartmentId: description: The unique identifier (OCID) of the compartment where the resource is located. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object PartnerCollection: description: Results of a partner search. Contains both PartnerSummary items and other information, such as metadata. properties: items: description: List of partners. items: $ref: '#/components/schemas/PartnerSummary' type: array required: - items type: object CreatePartnerDetails: description: The information about new Partner. properties: compartmentId: description: Compartment Identifier type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Partner description type: string entityTypes: description: The entity types locked for this partner items: type: string type: array freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object maxHoursWaiting: description: Maximum hours a request spends waiting before being autocancelled maximum: 96 minimum: 1 type: integer maxRequestsPerResource: description: Maximum number of active requests per resource maximum: 150 minimum: 1 type: integer name: description: Partner team name maxLength: 255 minLength: 1 type: string opsQueue: description: The jira-sd queue of the partner team type: string partnerApiCall: description: if disabled OMA does not invoke partner APIs enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/PartnerApiCall' phonebook: description: The phonebook id of the partner team type: string serviceEndpoint: description: The endpoint invoked by OMA to communicate with the partner service. Expects a service endpoint URL if 'partnerApiCall' is enabled. type: string required: - name - compartmentId - description - entityTypes - maxRequestsPerResource - maxHoursWaiting - phonebook - opsQueue type: object parameters: PaginationTokenQueryParam: description: A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. in: query name: page x-default-description: 'null' schema: type: string minLength: 1 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. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName - id default: timeCreated NameQueryParam: 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 PartnerIdentifierPathParam: description: unique Partner identifier in: path name: partnerId required: true schema: type: string CompartmentIdQueryParam: description: The ID of the compartment in which to list resources. in: query name: compartmentId x-default-description: 'null' schema: type: string IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 SortOrderQueryParam: description: The sort order to use, either 'ASC' or 'DESC'. in: query name: sortOrder x-default-description: 'The default value depends upon `sortBy`, and in general is ''DESC'' when sorting by time and ''ASC'' otherwise. ' x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 PartnerIdentifierQueryParam: description: unique Partner identifier in: query name: id x-default-description: 'null' schema: type: string PartnerLifecycleStateQueryParam: description: A filter to return only resources their lifecycleState matches the given lifecycleState. in: query name: lifecycleState x-default-description: 'null' x-obmcs-enumref: '#/definitions/Partner/lifecycleState' schema: type: string RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string location: description: 'this contains the full URI for the get request, e.g. "https://iaas.us-phoenix-1.oraclecloud.com/20210331/lockbox/" ' type: string opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' 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: compartmentId: description: The unique identifier (OCID) of the compartment where the resource is located. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.pic.lockbox