openapi: 3.2.0
info:
  description: 'Use the PrivateServiceAccess Control Plane API to manage Private Service Access (PSA) endpoints. PSA endpoints are used to create private access between resources in a VCN or on-premises and services in Oracle services network. For important details about how PSA endpoints work, see [Access to Oracle Services: Private Service Access Endpoints](/iaas/Content/Network/Concepts/private-service-access.htm).

    '
  title: Control Plane Private Service Access API
  version: '20240301'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/65cc8fc2350635aafa4e47c88ed2cc8569f7895c01c2cfb1cee48f3d6ce87846.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the PrivateServiceAccess Control Plane 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/65cc8fc2350635aafa4e47c88ed2cc8569f7895c01c2cfb1cee48f3d6ce87846.yaml
    what: the harvested document for PrivateServiceAccess Control Plane API
servers:
- url: http://127.0.0.1/20240301
- url: https://127.0.0.1/20240301
tags:
- name: privateServiceAccess
paths:
  /privateServiceAccess:
    get:
      description: 'List the Private Service Access endpoints in the specified compartment. You can optionally filter the list by

        specifying the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a subnet in the VCN.

        '
      operationId: ListPrivateServiceAccesses
      parameters:
      - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
      - $ref: '#/components/parameters/LifecycleStateOptionalQueryParam'
      - $ref: '#/components/parameters/DisplayNameOptionalQueryParam'
      - $ref: '#/components/parameters/IdOptionalQueryParam'
      - $ref: '#/components/parameters/VcnIdOptionalQueryParam'
      - $ref: '#/components/parameters/ServiceIdOptionalQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A page of `PrivateServiceAccessSummary` objects.
          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/PrivateServiceAccessCollection'
        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 PrivateServiceAccess.
      tags:
      - privateServiceAccess
      x-related-resource: '#/definitions/PrivateServiceAccessCollection'
    post:
      description: 'Creates a Private Service Access endpoint in the specified subnet (in the VCN) and the specified

        compartment for a particular service.

        '
      operationId: CreatePrivateServiceAccess
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        201:
          description: Accepted the request. The Private Service Access endpoint will be created.
          headers:
            content-location:
              description: Same as location.
              schema:
                type: string
                format: uri-reference
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            location:
              description: 'URL for the created Private Service Access endpoint. The Private Service Access endpoint OCID is generated after this request is sent.

                '
              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/PrivateServiceAccess'
        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 PrivateServiceAccess.
      tags:
      - privateServiceAccess
      x-related-resource: '#/definitions/PrivateServiceAccess'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePrivateServiceAccessDetails'
        description: Details used to create the new Private Service Access endpoint.
        required: true
  /privateServiceAccess/{privateServiceAccessId}:
    delete:
      description: Deletes a Private Service Access endpoint.
      operationId: DeletePrivateServiceAccess
      parameters:
      - $ref: '#/components/parameters/PrivateServiceAccessIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The `PrivateServiceAccess` 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 PrivateServiceAccess.
      tags:
      - privateServiceAccess
      x-related-resource: '#/definitions/PrivateServiceAccess'
    get:
      description: Gets information about a Private Service Access endpoint.
      operationId: GetPrivateServiceAccess
      parameters:
      - $ref: '#/components/parameters/PrivateServiceAccessIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The `PrivateServiceAccess` object information was retrieved.
          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/PrivateServiceAccess'
        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 PrivateServiceAccess
      tags:
      - privateServiceAccess
    put:
      description: Updates a Private Service Access endpoint.
      operationId: UpdatePrivateServiceAccess
      parameters:
      - $ref: '#/components/parameters/PrivateServiceAccessIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The `PrivateServiceAccess` object will be updated.
          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'
        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: Updates a PrivateServiceAccess.
      tags:
      - privateServiceAccess
      x-related-resource: '#/definitions/PrivateServiceAccess'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePrivateServiceAccessDetails'
        description: 'The Private Service Access endpoint information to update.

          '
        required: true
  /privateServiceAccess/{privateServiceAccessId}/actions/changeCompartment:
    post:
      description: 'Moves a Private Service Access endpoint to a different compartment within the same tenancy. For information about moving resources between

        compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

        '
      operationId: ChangePrivateServiceAccessCompartment
      parameters:
      - $ref: '#/components/parameters/PrivateServiceAccessIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: Accepted the request. The Private Service Access endpoint 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
            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
        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 PrivateServiceAccess into a different compartment.
      tags:
      - privateServiceAccess
      x-related-resource: '#/definitions/PrivateServiceAccess'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangePrivateServiceAccessCompartmentDetails'
        description: The information to be updated.
        required: true
  /psaServices:
    get:
      description: 'List the OCI services available in the Private Service Access catalog for the region, sorted by service name.

        '
      operationId: ListPsaServices
      parameters:
      - $ref: '#/components/parameters/DisplayNameOptionalQueryParam'
      - $ref: '#/components/parameters/ServiceIdOptionalQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortByDisplayNameQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A page of `PsaServiceSummary` objects.
          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/PsaServiceCollection'
        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: Lists PsaServiceSummary.
      tags:
      - privateServiceAccess
      x-obmcs-client-retries-enabled: true
  /psaWorkRequests:
    get:
      description: 'Lists the PrivateServiceAccess work requests in a compartment.

        '
      operationId: ListPsaWorkRequests
      parameters:
      - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
      - $ref: '#/components/parameters/WorkRequestIdQueryParam'
      - $ref: '#/components/parameters/WorkRequestStatusQueryParam'
      - $ref: '#/components/parameters/ResourceIdentifierQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/WorkRequestSortByQueryParam'
      responses:
        200:
          description: The list of PrivateServiceAccess work requests was retrieved.
          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/WorkRequestSummaryCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: List PSA work requests
      tags:
      - privateServiceAccess
      x-related-resource: '#/definitions/WorkRequest'
  /psaWorkRequests/{workRequestId}:
    delete:
      description: Cancels a PrivateServiceAccess work request.
      operationId: CancelPsaWorkRequest
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: The PrivateServiceAccess work request will be canceled.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Cancel PSA work request
      tags:
      - privateServiceAccess
      x-related-resource: '#/definitions/WorkRequest'
    get:
      description: Gets the details of a PrivateServiceAccess work request.
      operationId: GetPsaWorkRequest
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The PrivateServiceAccess work request was retrieved.
          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
            retry-after:
              description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkRequest'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Get PSA work request status
      tags:
      - privateServiceAccess
      x-related-resource: '#/definitions/WorkRequest'
  /psaWorkRequests/{workRequestId}/errors:
    get:
      description: 'Lists the errors for a PrivateServiceAccess work request.

        '
      operationId: ListPsaWorkRequestErrors
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/WorkRequestLogAndErrorSortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      responses:
        200:
          description: The list of PrivateServiceAccess work request errors was retrieved.
          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/WorkRequestErrorCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: List PSA work request errors
      tags:
      - privateServiceAccess
      x-related-resource: '#/definitions/WorkRequestError'
  /psaWorkRequests/{workRequestId}/logs:
    get:
      description: 'Lists the logs for a PrivateServiceAccess work request.

        '
      operationId: ListPsaWorkRequestLogs
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/WorkRequestLogAndErrorSortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      responses:
        200:
          description: The list of PrivateServiceAccess work request logs.
          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/WorkRequestLogEntryCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: List PSA work request logs
      tags:
      - privateServiceAccess
      x-related-resource: '#/definitions/WorkRequestLogEntry'
components:
  parameters:
    PrivateServiceAccessIdPathParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `PrivateServiceAccess` object.
      in: path
      name: privateServiceAccessId
      required: true
      schema:
        type: string
    PaginationTokenQueryParam:
      description: 'For list pagination. The value of the opc-next-page response header from the previous

        "List" call. For important details about how pagination works, see

        [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      in: query
      name: page
      schema:
        type: string
        minLength: 1
    SortByQueryParam:
      description: "The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.     \n"
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeCreated
        - displayName
        default: timeCreated
    ResourceIdentifierQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource affected by the work request.
      in: query
      name: resourceId
      x-default-description: 'null'
      schema:
        type: string
    IfMatchHeader:
      description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the

        `if-match` parameter to the value of the etag from a previous GET or POST response for

        that resource. The resource will be updated or deleted only if the etag you provide

        matches the resource''s current etag value.

        '
      in: header
      name: if-match
      required: false
      schema:
        type: string
    WorkRequestStatusQueryParam:
      description: A filter to return only the resources that match the given lifecycle state.
      in: query
      name: status
      required: false
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/OperationStatus'
      schema:
        type: string
        enum:
        - ACCEPTED
        - IN_PROGRESS
        - WAITING
        - NEEDS_ATTENTION
        - FAILED
        - SUCCEEDED
        - CANCELLING
        - CANCELLED
    PaginationLimitQueryParam:
      description: 'For list pagination. The maximum number of results per page, or items to return in a

        paginated "List" call. For important details about how pagination works, see

        [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      in: query
      name: limit
      schema:
        type: integer
        default: 10
        maximum: 1000
        minimum: 1
    VcnIdOptionalQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN.
      in: query
      name: vcnId
      required: false
      schema:
        type: string
        maxLength: 255
        minLength: 1
    SortByDisplayNameQueryParam:
      description: 'The field to sort by. Only one sort order may be provided. Default order for `displayName` is descending.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - displayName
        default: displayName
    WorkRequestIdPathParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
      in: path
      name: workRequestId
      required: true
      schema:
        type: string
    DisplayNameOptionalQueryParam:
      description: A filter to return only resources that match the given display name exactly.
      in: query
      name: displayName
      required: false
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    WorkRequestIdQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
      in: query
      name: workRequestId
      x-default-description: 'null'
      schema:
        type: string
    SortOrderQueryParam:
      description: The sort order to use, either ascending (`ASC`) or descending (`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
    WorkRequestLogAndErrorSortByQueryParam:
      description: 'The field to sort by. Only one sort order may be provided. Default order for `timeCreated` is descending.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeCreated
        default: timeCreated
    ServiceIdOptionalQueryParam:
      description: The unique identifier of the OCI service.
      in: query
      name: serviceId
      required: false
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    LifecycleStateOptionalQueryParam:
      description: 'A filter to return only resources that match the given lifecycle state. The

        state value is case-insensitive.

        '
      in: query
      name: lifecycleState
      required: false
      x-default-description: 'null'
      x-obmcs-enumref: '#/definitions/PrivateServiceAccess/lifecycleState'
      schema:
        type: string
    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 running 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 removed 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
    WorkRequestSortByQueryParam:
      description: 'The field to sort by. Only one sort order may be provided. Default order for `timeAccepted` is descending.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeAccepted
        default: timeAccepted
    RequestIdHeader:
      description: 'Unique Oracle-assigned identifier for the request. If you need to contact

        Oracle about a particular request, please provide the request ID.

        The only valid characters for request IDs are letters, numbers,

        underscore, and dash.

        '
      in: header
      name: opc-request-id
      schema:
        type: string
    CompartmentIdOptionalQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
      in: query
      name: compartmentId
      x-default-description: 'null'
      schema:
        type: string
    IdOptionalQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource.
      in: query
      name: id
      required: false
      x-default-description: 'null'
      schema:
        type: string
  schemas:
    CreatePrivateServiceAccessDetails:
      description: Details required to create a Private Service Access endpoint.
      properties:
        compartmentId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the

            Private Service Access endpoint.

            '
          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: 'A description of this private service accesss endpoint.

            '
          maxLength: 400
          minLength: 1
          type: string
        displayName:
          description: 'A user-friendly name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          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
        ipv4Ip:
          description: 'The private IPv4 address (in the VCN) that represents the access point for the

            associated service.

            '
          maxLength: 255
          minLength: 1
          type: string
          x-default-description: 'null'
        nsgIds:
          description: "A list of the [OCID](/iaas/Content/General/Concepts/identifiers.htm)s of the network security groups (NSGs) to add the private \nservice access's VNIC to. \nFor more information about NSGs, see\n[NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/).\n"
          items:
            maxLength: 255
            minLength: 1
            type: string
          maxItems: 5
          type: array
          uniqueItems: true
        securityAttributes:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces).

              '
            type: object
          description: '[Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels

            for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm)

            (ZPR) policy to control access to ZPR-supported resources.


            Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}`

            '
          type: object
        serviceId:
          description: 'A unique identifier for the service the Private Service Access endpoint was created for.

            '
          maxLength: 255
          minLength: 1
          type: string
        subnetId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN''s

            subnet where the Private Service Access endpoint''s VNIC will reside.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
      - subnetId
      - serviceId
      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 message.
          type: string
      required:
      - code
      - message
    PsaServiceSummary:
      description: 'An OCI service summary, that is used as a catalog for creating Private Service Access endpoints.

        '
      properties:
        description:
          description: 'A description of the OCI service.

            '
          maxLength: 400
          minLength: 1
          type: string
        displayName:
          description: 'A user-friendly name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        fqdns:
          description: 'The public facing service FQDNs, which are used to access the service.


            Example: `xyz.oraclecloud.com`

            '
          items:
            maxLength: 255
            minLength: 1
            type: string
          maxItems: 10
          type: array
          uniqueItems: true
        id:
          description: 'A unique OCI service identifier.


            Example: `object-storage-api`

            '
          maxLength: 255
          minLength: 1
          type: string
        isV6Enabled:
          default: false
          description: 'This optional field will indicate that whether the service is IPv6 enabled.

            '
          type: boolean
      required:
      - id
      - displayName
      - fqdns
      type: object
    PrivateServiceAccessCollection:
      description: Results of a `privateServiceAccess` search. Contains both `PrivateServiceAccessSummary` items and other information, such as metadata.
      properties:
        items:
          description: List of privateServiceAccess.
          items:
            $ref: '#/components/schemas/PrivateServiceAccessSummary'
          type: array
      required:
      - items
      type: object
    PrivateServiceAccess:
      description: 'Private Service Access (PSA) endpoints are a new way to create private accesss to Oracle services. For important details about how PSA endpoints work, see [Access to Oracle Services: Private Service Access Endpoints](/iaas/Content/Network/Concepts/private-service-access.htm).

        '
      properties:
        compartmentId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the

            Private Service Access endpoint.

            '
          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: 'A description of this Private Service Access endpoint.

            '
          maxLength: 400
          minLength: 1
          type: string
        displayName:
          description: 'A user-friendly name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        fqdns:
          description: 'The Private Service Access endpoint''s FQDN, which can be used to access the associated service.


            Example: `xyz.oraclecloud.com`

            '
          items:
            maxLength: 255
            minLength: 1
            type: string
          maxItems: 10
          type: array
          uniqueItems: true
        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](/iaas/Content/General/Concepts/identifiers.htm) of the Private Service Access endpoint.

            '
          maxLength: 255
          minLength: 1
          type: string
        ipv4Ip:
          description: 'The private IPv4 address (in the VCN) that represents the access point for the

            associated service.

            '
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: The Private Service Access endpoint's current lifecycle state.
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - DELETING
          - DELETED
          - FAILED
          type: string
        nsgIds:
          description: 'A list of the OCIDs of the network security groups that the Private Service Access endpoint''s VNIC belongs to.

            For more information about NSGs, see

            [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/).

            '
          items:
            maxLength: 255
            minLength: 1
            type: string
          maxItems: 5
          type: array
          uniqueItems: true
        securityAttributes:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces).

              '
            type: object
          description: '[Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels

            for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm)

            (ZPR) policy to control access to ZPR-supported resources.


            Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}`

            '
          type: object
        serviceId:
          description: 'A unique identifier for the service for which the Private Service Access endpoint was created.

            '
          maxLength: 255
          minLength: 1
          type: string
        subnetId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet that the Private Service Access endpoint belongs to.

            '
          maxLength: 255
          minLength: 1
          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
        timeCreated:
          description: 'The date and time the Private Service Access endpoint was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).


            Example: `2016-08-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the Private Service Access endpoint was last updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).


            Example: `2016-08-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        vcnId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN that the private

            service access endpoint belongs to.

            '
          maxLength: 255
          minLength: 1
          type: string
        vnicId:
          description: 'An [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Private Service Access endpoint''s VNIC, which

            resides in the Private Service Access endpoint''s VCN.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - displayName
      - compartmentId
      - id
      - vcnId
      - subnetId
      - vnicId
      - lifecycleState
      - serviceId
      - fqdns
      type: object
    WorkRequestResource:
      description: A resource created or operated on by a work request.
      properties:
        actionType:
          description: 'The way in which this resource is affected by the operation tracked in the work request.

            A resource being created, updated, or deleted remains in the IN_PROGRESS state until

            work is complete for that resource, at which point it transitions to CREATED, UPDATED,

            or DELETED, respectively.

            '
          enum:
          - CREATED
          - UPDATED
          - DELETED
          - IN_PROGRESS
          - RELATED
          - FAILED
          type: string
          x-obmcs-top-level-enum: '#/definitions/ActionType'
        entityType:
          description: The resource type that the work request affects.
          type: string
        entityUri:
          description: The URI path that you can use for a GET request to access the resource metadata.
          type: string
        identifier:
          description: An [OCID](/iaas/Content/General/Concepts/identifiers.htm) or other unique identifier for the resource.
          type: string
        metadata:
          additionalProperties:
            type: string
          description: Additional information that helps to explain the resource.
          enum:
          - IS_DRY_RUN
          type: object
          x-obmcs-top-level-enum: '#/definitions/WorkRequestResourceMetadataKey'
      required:
      - actionType
      - entityType
      - identifier
    WorkRequestSummaryCollection:
      description: A list of work requests. Can contain both work requests and other information, such as metadata.
      properties:
        items:
          description: A list of work requests.
          items:
            $ref: '#/components/schemas/WorkRequestSummary'
          type: array
      required:
      - items
      type: object
    WorkRequestErrorCollection:
      description: A list of work request errors. Can contain both errors and other information, such as metadata.
      properties:
        items:
          description: A list of work request errors.
          items:
            $ref: '#/components/schemas/WorkRequestError'
          type: array
      required:
      - items
      type: object
    PrivateServiceAccessSummary:
      description: 'A summary of Private Service Access endpoint information. This object is returned when listing private service accesses.

        '
      properties:
        compartmentId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the

            Private Service Access endpoint.

            '
          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: 'A description of this Private Service Access endpoint.

            '
          maxLength: 400
          minLength: 1
          type: string
        displayName:
          description: 'A user-friendly name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        fqdns:
          description: 'The Private Service Access endpoint''s IPv4 FQDNs, which can be used to access the associated service.


            Example: `xyz.oraclecloud.com`

            '
          items:
            maxLength: 255
            minLength: 1
            type: string
          maxItems: 10
          type: array
          uniqueItems: true
        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](/iaas/Content/General/Concepts/identifiers.htm) of the Private Service Access endpoint.

            '
          maxLength: 255
          minLength: 1
          type: string
        ipv4Ip:
          description: 'The private IP address (in the VCN) that represents the access point for the

            associated service.

            '
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: The Private Service Access endpoint's current lifecycle state.
          type: string
          x-obmcs-enumref: '#/definitions/PrivateServiceAccess/lifecycleState'
        nsgIds:
          description: 'A list of the [OCID](/iaas/Content/General/Concepts/identifiers.htm)s of the network security groups that the Private Service Access endpoint''s VNIC belongs to.

            For more information about NSGs, see

            [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/).

            '
          items:
            maxLength: 255
            minLength: 1
            type: string
          maxItems: 5
          type: array
          uniqueItems: true
        securityAttributes:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces).

              '
            type: object
          description: '[Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels

            for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm)

            (ZPR) policy to control access to ZPR-supported resources.


            Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}`

            '
          type: object
        serviceId:
          description: 'A unique identifier for the service associated with the Private Service Access endpoint.

            '
          maxLength: 255
          minLength: 1
          type: string
        subnetId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet that the Private Service Access endpoint

            belongs to.

            '
          maxLength: 255
          minLength: 1
          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
        timeCreated:
          description: 'The date and time the Private Service Access endpoint was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).


            Example: `2016-08-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the Private Service Access endpoint was last updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).


            Example: `2016-08-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        vcnId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN that the private

            service access endpoint belongs to.

            '
          maxLength: 255
          minLength: 1
          type: string
        vnicId:
          description: 'An [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Private Service Access endpoint''s VNIC, which

            resides in the Private Service Access endpoint''s VCN.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - displayName
      - compartmentId
      - id
      - vcnId
      - subnetId
      - vnicId
      - lifecycleState
      - serviceId
      - fqdns
      type: object
    PsaServiceCollection:
      description: Results of a `psaServices` search. Contains `PsaServiceSummary` items.
      properties:
        items:
          description: List of `PsaServiceSummary` items.
          items:
            $ref: '#/components/schemas/PsaServiceSummary'
          type: array
      required:
      - items
      type: object
    WorkRequestSummary:
      description: Summary information about an asynchronous work request.
      properties:
        compartmentId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request.

            '
          type: string
        id:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
          type: string
        operationType:
          description: The asynchronous operation tracked by this work request.
          enum:
          - CREATE_PRIVATE_SERVICE_ACCESS
          - UPDATE_PRIVATE_SERVICE_ACCESS
          - DELETE_PRIVATE_SERVICE_ACCESS
          - MOVE_PRIVATE_SERVICE_ACCESS
          type: string
          x-obmcs-top-level-enum: '#/definitions/OperationType'
        percentComplete:
          description: 'Shows the progress of the operation tracked by the work request, as a percentage of the total work

            that must be performed.

            '
          format: float
          type: number
        resources:
          description: The resources that are affected by this work request.
          items:
            $ref: '#/components/schemas/WorkRequestResource'
          type: array
        status:
          description: The status of the work request.
          enum:
          - ACCEPTED
          - IN_PROGRESS
          - WAITING
          - NEEDS_ATTENTION
          - FAILED
          - SUCCEEDED
          - CANCELLING
          - CANCELLED
          type: string
          x-obmcs-top-level-enum: '#/definitions/OperationStatus'
        timeAccepted:
          description: 'The date and time the work request was created, in the format defined by

            [RFC 3339](https://tools.ietf.org/html/rfc3339).

            '
          format: date-time
          type: string
        timeFinished:
          description: 'The date and time the work request was finished, in the format defined by

            [RFC 3339](https://tools.ietf.org/rfc/rfc3339).

            '
          format: date-time
          type: string
        timeStarted:
          description: 'The date and time the work request was started, in the format defined by

            [RFC 3339](https://tools.ietf.org/html/rfc3339).

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the work request was updated, in the format defined by

            [RFC 3339](https://tools.ietf.org/rfc/rfc3339).

            '
          format: date-time
          type: string
      required:
      - operationType
      - status
      - id
      - compartmentId
      - resources
      - percentComplete
      - timeAccepted
    WorkRequestError:
      description: An error encountered while performing an operation that is tracked by a work request.
      properties:
        code:
          description: 'A machine-usable code for the error that occurred. For a list of error codes, see

            [API Errors](/iaas/Content/API/References/apierrors.htm).

            '
          type: string
        message:
          description: A human-readable error message.
          type: string
        timestamp:
          description: 'The date and time the error occurred, in the format defined by

            [RFC 3339](https://tools.ietf.org/html/rfc3339).

            '
          format: date-time
          type: string
      required:
      - code
      - message
      - timestamp
    UpdatePrivateServiceAccessDetails:
      description: Details needed to update a Private Service Access endpoint.
      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: 'A description of this Private Service Access endpoint.

            '
          maxLength: 400
          minLength: 1
          type: string
        displayName:
          description: 'A user-friendly name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          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
        nsgIds:
          description: 'A list of the [OCID](/iaas/Content/General/Concepts/identifiers.htm)s of the network security groups (NSGs) to add the private service access''s VNIC to.

            For more information about NSGs, see

            [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/).

            '
          items:
            maxLength: 255
            minLength: 1
            type: string
          maxItems: 5
          type: array
          uniqueItems: true
        securityAttributes:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces).

              '
            type: object
          description: '[Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels

            for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm)

            (ZPR) policy to control access to ZPR-supported resources.


            Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}`

            '
          type: object
      type: object
    ChangePrivateServiceAccessCompartmentDetails:
      description: The configuration details needed for the move operation.
      properties:
        compartmentId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment

            into which the Private Service Access endpoint should be moved.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
      type: object
    WorkRequestLogEntry:
      description: A log message from performing an operation that is tracked by a work request.
      properties:
        message:
          description: A human-readable log message.
          type: string
        timestamp:
          description: 'The date and time the log message was written, in the format defined by

            [RFC 3339](https://tools.ietf.org/html/rfc3339).

            '
          format: date-time
          type: string
      required:
      - message
      - timestamp
    WorkRequestLogEntryCollection:
      description: A list of work request logs. Can contain both logs and other information, such as metadata.
      properties:
        items:
          description: A list of work request log entries.
          items:
            $ref: '#/components/schemas/WorkRequestLogEntry'
          type: array
      required:
      - items
      type: object
    WorkRequest:
      description: 'An asynchronous work request. Work requests help you monitor long-running operations. When you start a long-running operation,

        the service creates a work request. A work request is an activity log that lets you track each step in the operation''s

        progress. Each work request has an OCID that lets you interact with it programmatically and use it for automation.

        '
      properties:
        compartmentId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request.

            '
          type: string
        id:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
          type: string
        operationType:
          description: The asynchronous operation tracked by this work request.
          enum:
          - CREATE_PRIVATE_SERVICE_ACCESS
          - UPDATE_PRIVATE_SERVICE_ACCESS
          - DELETE_PRIVATE_SERVICE_ACCESS
          - MOVE_PRIVATE_SERVICE_ACCESS
          type: string
          x-obmcs-top-level-enum: '#/definitions/OperationType'
        percentComplete:
          description: 'Shows the progress of the operation tracked by the work request, as a percentage of the total work

            that must be performed.

            '
          format: float
          type: number
        resources:
          description: The resources that are affected by the work request.
          items:
            $ref: '#/components/schemas/WorkRequestResource'
          type: array
        status:
          description: The status of the work request.
          enum:
          - ACCEPTED
          - IN_PROGRESS
          - WAITING
          - NEEDS_ATTENTION
          - FAILED
          - SUCCEEDED
          - CANCELLING
          - CANCELLED
          type: string
          x-obmcs-top-level-enum: '#/definitions/OperationStatus'
        timeAccepted:
          description: 'The date and time the work request was created, in the format defined by

            [RFC 3339](https://tools.ietf.org/html/rfc3339).

            '
          format: date-time
          type: string
        timeFinished:
          description: 'The date and time the work request was finished, in the format defined by

            [RFC 3339](https://tools.ietf.org/rfc/rfc3339).

            '
          format: date-time
          type: string
        timeStarted:
          description: 'The date and time the work request was started, in the format defined by

            [RFC 3339](https://tools.ietf.org/html/rfc3339).

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the work request was updated, in the format defined by

            [RFC 3339](https://tools.ietf.org/rfc/rfc3339).

            '
          format: date-time
          type: string
      required:
      - operationType
      - status
      - id
      - compartmentId
      - resources
      - percentComplete
      - timeAccepted
  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:
    displayName:
      description: 'A user-friendly name. Does not have to be unique, and it''s changeable.

        Avoid entering confidential information.

        '
      maxLength: 255
      minLength: 1
      type: string
    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:
    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
    securityAttributes:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag.

            '
          type: object
        description: 'Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces).

          '
        type: object
      description: '[Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels

        for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm)

        (ZPR) policy to control access to ZPR-supported resources.


        Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}`

        '
      type: object
    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-obmcs-endpoint-service-name: psasvc
x-oracle-package: com.oracle.pic.psa