Oracle Subscribers API

The subscribers API from Oracle — 5 operation(s) for subscribers.

Documentation

📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/access-governance-cp/20220518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/adm/20220421/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/advisor/20200606/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ai-data-platform/20240831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/analytics/20190331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/announcements/0.0.1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/api-gateway/20190501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-config/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-control-plane/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-synthetic-monitoring/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-trace-explorer/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/audit/20190901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/autoscaling/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bastion/20210331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/batch/20251031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bigdata/20190531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/blockchain/20191010/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/budgets/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificates/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificatesmgmt/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cloud-guard/20200131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/clusterplacementgroups/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/compute-cloud-at-customer/20221208/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-instances/20210415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-registry/20180419/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/containerengine/20180222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cost-anomaly/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dashboard/20210731/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-catalog/20190325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-flow/20200129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-integration/20200430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-safe/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-science/20190101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-management/20201101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-migration/20230518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-multicloud-integrations/20240501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools/20201005/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools-runtime/20230222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datacc/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling-dp/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/delegate-access-control/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/devops/20210630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/digital-assistant/20190506/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/disaster-recovery/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dms/20211101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dns/20180115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/document-understanding/20221109/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/edsfu/20220528/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildelivery/20170907/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildeliverysubmission/20220926/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/events/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/filestorage/20171215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fleet-management/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functions/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functionsdocgenpbf/1.0/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fusion-applications/20211201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents-client/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-inference/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-nl2sql/20260325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generic/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/globally-distributed-database/20250101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/goldengate/20200407/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/healthchecks/20180501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iaas/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-domains/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-dp/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/incidentmanagement/20181231/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/instanceagent/20180530/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/integration/20190131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iot/20250531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/itas/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-java-download/20230601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms/20210610/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-utils/20250521/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/kafka/20240901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/key/release/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/language/20221001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/licensemanager/20220430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits-increase/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits/20181025/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/loadbalancer/20170115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logan-api-spec/20200601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-dataplane/20200831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-management/20200531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-search/20190909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/lustre/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managed-access/20220126/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/management-agent/20200202/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managementdashboard/20200901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/marketplace/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mngdmac/20250320/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/monitoring/20180401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/multicloud-omhub-cp/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mysql/20190415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/NetMonitor/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20230501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/networkloadbalancer/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/nosql-database/20190828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/OCB/20220509/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occ/20230515/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occds/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occm/20231107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocicache/20220315/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocm/20220919/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opa/20210621/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opensearch/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operations-insights/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operatoraccesscontrol/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/oracle-api-access-control/20241130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20230401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20200801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/osmh/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/postgresql/20220915/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/psasvc/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/publisher/20241201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/queue/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/recovery-service/20210216/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/registry/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-analytics/20241031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-discovery-monitoring-control-api/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-scheduler/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resourcemanager/20180917/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/rover/20201210/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/s3objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/scanning/20210215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/search/20180409/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretmgmt/20180608/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretretrieval/20190301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secure-desktops/20220618/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/security-attribute/20240815/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/self/20260129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/service-catalog/20210527/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/serviceconnectors/20200909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/smp/20210914/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/speech/20220101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/stack-monitoring/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/streaming/20180418/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/threat-intel/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage/20200107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage-proxy/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vision/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder/20210601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder-studio/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20230701/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waa/20211230/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waas/20181116/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waf/20210930/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/wlms/20241101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/workrequests/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing-tools/20240301/

Specifications

OpenAPI Specification

oracle-subscribers-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: 'API for the API Gateway service. Use this API to manage gateways, deployments, and related items.

    For more information, see

    [Overview of API Gateway](/iaas/Content/APIGateway/Concepts/apigatewayoverview.htm).

    '
  title: Gateway Subscribers API
  version: '20190501'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/4a7a190925fb30298864e9aee04c85cfd197a64c6eca47f749c72b5d9b9046ba.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the API Gateway 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/4a7a190925fb30298864e9aee04c85cfd197a64c6eca47f749c72b5d9b9046ba.yaml
    what: the harvested document for API Gateway API
servers:
- url: http://127.0.0.1/20190501
- url: https://127.0.0.1/20190501
tags:
- name: subscribers
paths:
  /subscribers:
    get:
      description: Returns a list of subscribers.
      operationId: ListSubscribers
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/SubscriberLifecycleStateQueryParam'
      - $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 SubscriberSummary 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
                default: 'null'
            opc-prev-page:
              description: 'For list pagination. When this header appears in the response,

                additional pages of results were seen previously. For important details

                about how pagination works, see

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

                '
              schema:
                type: string
                default: 'null'
            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
                default: 'null'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriberCollection'
        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 subscribers in a compartment
      tags:
      - subscribers
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/Subscriber'
    post:
      description: Creates a new subscriber.
      operationId: CreateSubscriber
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        201:
          description: The subscriber is being created.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
                default: 'null'
            location:
              description: 'Location of the resource.

                '
              schema:
                type: string
                default: 'null'
            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
                default: 'null'
            opc-work-request-id:
              description: 'The OCID of the work request. Use

                [GetWorkRequest](#/en/iaas/20190501/WorkRequests/GetWorkRequest) with

                this id to track the status

                of the request.

                '
              schema:
                type: string
                default: 'null'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscriber'
        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 subscriber.
      tags:
      - subscribers
      x-obmcs-client-retries-enabled: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSubscriberDetails'
        description: Details for the new subscriber.
        required: true
  /subscribers/{subscriberId}:
    delete:
      description: Deletes the subscriber with the given identifier.
      operationId: DeleteSubscriber
      parameters:
      - $ref: '#/components/parameters/SubscriberIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: The subscriber 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
                default: 'null'
            opc-work-request-id:
              description: 'The OCID of the work request. Use

                [GetWorkRequest](#/en/iaas/20190501/WorkRequests/GetWorkRequest) with

                this id to track the status

                of the request.

                '
              schema:
                type: string
                default: 'null'
        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 subscriber.
      tags:
      - subscribers
      x-related-resource: '#/definitions/Subscriber'
    get:
      description: Gets a subscriber by identifier.
      operationId: GetSubscriber
      parameters:
      - $ref: '#/components/parameters/SubscriberIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the subscriber with the given identifier.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
                default: 'null'
            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
                default: 'null'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscriber'
        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 subscriber.
      tags:
      - subscribers
      x-obmcs-client-retries-enabled: true
    put:
      description: Updates the subscriber with the given identifier.
      operationId: UpdateSubscriber
      parameters:
      - $ref: '#/components/parameters/SubscriberIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: The subscriber 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
                default: 'null'
            opc-work-request-id:
              description: 'The OCID of the work request. Use

                [GetWorkRequest](#/en/iaas/20190501/WorkRequests/GetWorkRequest) with

                this id to track the status

                of the request.

                '
              schema:
                type: string
                default: 'null'
        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: Update the subscriber.
      tags:
      - subscribers
      x-related-resource: '#/definitions/Subscriber'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSubscriberDetails'
        description: The information to be updated.
        required: true
  /subscribers/{subscriberId}/actions/addLock:
    post:
      description: Adds a lock to a Subscriber resource.
      operationId: AddSubscriberLock
      parameters:
      - description: 'Unique identifier for the request.

          If you need to contact Oracle about a particular request, please provide the request ID.

          '
        in: header
        name: opc-request-id
        required: false
        schema:
          type: string
      - description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`

          parameter to the value of the etag from a previous GET or POST response for that resource. The resource

          will be updated or deleted only if the etag you provide matches the resource''s current etag value.

          '
        in: header
        name: if-match
        schema:
          type: string
      - $ref: '#/components/parameters/SubscriberIdentifierPathParam'
      - $ref: '#/components/parameters/AddResourceLockDetailsBodyParam'
      responses:
        200:
          description: Lock is added.
          headers:
            etag:
              description: 'etag for the returned Subscriber resource.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

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

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscriber'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Adds a lock to a Subscriber resource.
      tags:
      - subscribers
      x-related-resource: '#/definitions/Subscriber'
  /subscribers/{subscriberId}/actions/changeCompartment:
    post:
      description: Changes the subscriber compartment.
      operationId: ChangeSubscriberCompartment
      parameters:
      - $ref: '#/components/parameters/SubscriberIdentifierPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: The subscriber's compartment will be changed.
          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
                default: 'null'
            opc-work-request-id:
              description: 'The OCID of the work request. Use

                [GetWorkRequest](#/en/iaas/20190501/WorkRequests/GetWorkRequest) with

                this id to track the status

                of the request.

                '
              schema:
                type: string
                default: 'null'
        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: Change the subscriber compartment.
      tags:
      - subscribers
      x-related-resource: '#/definitions/Subscriber'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeSubscriberCompartmentDetails'
        description: Details of the target compartment.
        required: true
  /subscribers/{subscriberId}/actions/removeLock:
    post:
      description: Removes a lock from a Subscriber resource.
      operationId: RemoveSubscriberLock
      parameters:
      - description: 'Unique identifier for the request.

          If you need to contact Oracle about a particular request, please provide the request ID.

          '
        in: header
        name: opc-request-id
        required: false
        schema:
          type: string
      - description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`

          parameter to the value of the etag from a previous GET or POST response for that resource. The resource

          will be updated or deleted only if the etag you provide matches the resource''s current etag value.

          '
        in: header
        name: if-match
        schema:
          type: string
      - $ref: '#/components/parameters/SubscriberIdentifierPathParam'
      - $ref: '#/components/parameters/RemoveResourceLockDetailsBodyParam'
      responses:
        200:
          description: Lock is removed.
          headers:
            etag:
              description: 'etag for the returned Subscriber resource.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

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

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscriber'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Removes a lock to a Subscriber resource.
      tags:
      - subscribers
      x-related-resource: '#/definitions/Subscriber'
components:
  schemas:
    ClientSummary:
      description: A summary of a client.
      properties:
        name:
          description: The client name.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - name
      type: object
    ResourceLock:
      description: 'Resource locks are used to prevent certain APIs from being called for the resource.

        A full lock prevents both updating the resource and deleting the resource. A delete

        lock prevents deleting the resource.

        '
      properties:
        message:
          description: 'A message added by the creator of the lock. This is typically used to give an

            indication of why the resource is locked.

            '
          type: string
        relatedResourceId:
          description: 'The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.

            '
          type: string
        timeCreated:
          description: When the lock was created.
          format: date-time
          type: string
        type:
          description: Type of the lock.
          enum:
          - FULL
          - DELETE
          type: string
      required:
      - type
      type: object
    Error:
      description: Error Information.
      properties:
        code:
          description: A short error code that defines the error, meant for programmatic parsing.
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
      type: object
    RemoveResourceLockDetails:
      description: 'Used to remove a resource lock.

        Resource locks are used to prevent certain APIs from being called for the resource.

        A full lock prevents both updating the resource and deleting the resource. A delete

        lock prevents deleting the resource.

        '
      properties:
        type:
          description: Type of the lock.
          enum:
          - FULL
          - DELETE
          type: string
      required:
      - type
      type: object
    SubscriberSummary:
      description: A summary of a subscriber.
      properties:
        clients:
          description: The clients belonging to this subscriber.
          items:
            $ref: '#/components/schemas/ClientSummary'
          maxItems: 10
          minItems: 0
          type: array
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the

            resource is created.

            '
          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](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: 'A user-friendly name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.


            Example: `My new resource`

            '
          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](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        id:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the resource.

            '
          maxLength: 255
          minLength: 1
          type: string
        lifecycleDetails:
          description: 'A message describing the current state in more detail.

            For example, can be used to provide actionable information for a

            resource in a Failed state.

            '
          type: string
        lifecycleState:
          description: The current state of the subscriber.
          type: string
          x-obmcs-enumref: '#/definitions/Subscriber/lifecycleState'
        locks:
          description: Locks associated with this resource.
          items:
            $ref: '#/components/schemas/ResourceLock'
          maxItems: 2
          type: array
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string 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: '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 time this resource was created. An RFC3339 formatted datetime string.
          format: date-time
          type: string
        timeUpdated:
          description: The time this resource was last updated. An RFC3339 formatted datetime string.
          format: date-time
          type: string
        usagePlans:
          description: 'An array of [OCID](/Content/General/Concepts/identifiers.htm)s of usage

            plan resources.

            '
          items:
            maxLength: 255
            minLength: 0
            type: string
          maxItems: 20
          minItems: 0
          type: array
      required:
      - id
      - compartmentId
      - clients
      - usagePlans
      - lifecycleState
      - timeCreated
      - timeUpdated
      type: object
    Client:
      description: A Client.
      properties:
        name:
          description: The name of the client. Must be unique within a subscriber.
          maxLength: 255
          minLength: 1
          type: string
        token:
          description: The token for the client. Must be unique within a tenancy.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - name
      - token
      type: object
    ChangeSubscriberCompartmentDetails:
      description: The new compartment details for the subscriber.
      properties:
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the

            resource is created.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
      type: object
    CreateSubscriberDetails:
      description: Information about a new subscriber.
      properties:
        clients:
          description: The clients belonging to this subscriber.
          items:
            $ref: '#/components/schemas/Client'
          maxItems: 10
          minItems: 0
          type: array
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the

            resource is created.

            '
          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](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: 'A user-friendly name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.


            Example: `My new resource`

            '
          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](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        locks:
          description: Locks associated with this resource.
          items:
            $ref: '#/components/schemas/AddResourceLockDetails'
          maxItems: 1
          type: array
        usagePlans:
          description: 'An array of [OCID](/Content/General/Concepts/identifiers.htm)s of usage

            plan resources.

            '
          items:
            maxLength: 255
            minLength: 0
            type: string
          maxItems: 20
          minItems: 0
          type: array
      required:
      - compartmentId
      - clients
      - usagePlans
      type: object
    SubscriberCollection:
      description: Collection of subscriber summaries.
      properties:
        items:
          description: Subscriber summaries.
          items:
            $ref: '#/components/schemas/SubscriberSummary'
          type: array
      required:
      - items
      type: object
    UpdateSubscriberDetails:
      description: The information to be updated.
      properties:
        clients:
          description: The clients belonging to the subscriber.
          items:
            $ref: '#/components/schemas/Client'
          maxItems: 10
          minItems: 0
          type: array
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a

              namespace.


              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a

            namespace. For more information, see

            [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: 'A user-friendly name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.


            Example: `My new resource`

            '
          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](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        usagePlans:
          description: 'An array of [OCID](/Content/General/Concepts/identifiers.htm)s of usage

            plan resources.

            '
          items:
            maxLength: 255
            minLength: 0
            type: string
          maxItems: 20
          minItems: 0
          type: array
      type: object
    Subscriber:
      description: 'A subscriber, which encapsulates a number of clients and usage plans that they are subscribed to.

        '
      properties:
        clients:
          description: The clients belonging to this subscriber.
          items:
            $ref: '#/components/schemas/Client'
          maxItems: 10
          minItems: 0
          type: array
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the

            resource is created.

            '
          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](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: 'A user-friendly name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.


            Example: `My new resource`

            '
          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](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        id:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the resource.

            '
          maxLength: 255
          minLength: 1
          type: string
        lifecycleDetails:
          description: 'A message describing the current state in more detail.

            For example, can be used to provide actionable information for a

            resource in a Failed state.

            '
     

# --- truncated at 32 KB (45 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-subscribers-api-openapi.yml