openapi: 3.2.0
info:
  description: "Use the Service Manager Proxy API to obtain information about SaaS environments provisioned by Service Manager. \nYou can get information such as service types and service environment URLs.\n"
  title: Service Manager Proxy API
  version: '20210914'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/c47bfe381302303d15621bf56241be88a7c3536563543bf5edefb5dab39b0401.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Service Manager Proxy 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/c47bfe381302303d15621bf56241be88a7c3536563543bf5edefb5dab39b0401.yaml
    what: the harvested document for Service Manager Proxy API
servers:
- url: http://127.0.0.1/20210914
- url: https://127.0.0.1/20210914
tags:
- name: serviceManagerProxy
paths:
  /serviceEnvironments:
    get:
      description: 'List the details of Software as a Service (SaaS) environments provisioned by Service Manager.

        Information includes the service instance endpoints and service definition details.

        '
      operationId: ListServiceEnvironments
      parameters:
      - $ref: '#/components/parameters/ServiceEnvironmentIdQueryParam'
      - $ref: '#/components/parameters/ServiceEnvironmentTypeQueryParam'
      - $ref: '#/components/parameters/CompartmentIdRequiredQueryParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/ServiceNameFilterQueryParam'
      responses:
        '200':
          description: List of all service environments.
          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/ServiceEnvironmentCollection'
        '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: List all the SAAS environments on Service Manager Proxy.
      tags:
      - serviceManagerProxy
      x-related-resource: '#/definitions/ServiceEnvironment'
  /serviceEnvironments/{serviceEnvironmentId}:
    get:
      description: 'Get the detailed information for a specific service environment.

        '
      operationId: GetServiceEnvironment
      parameters:
      - $ref: '#/components/parameters/ServiceEnvironmentIdPathParam'
      - $ref: '#/components/parameters/CompartmentIdRequiredQueryParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      responses:
        '200':
          description: Details about the specified environment.
          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/ServiceEnvironment'
        '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: Gets details about the service environment.
      tags:
      - serviceManagerProxy
      x-example: 'GET /20210914/serviceEnvironments/<var>&lt;serviceEnvironmentId&gt;</var>

        Host: smproxy.us-ashburn-1.ocs.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/ServiceEnvironment'
components:
  parameters:
    PaginationTokenQueryParam:
      description: The value of the `opc-next-page` response header from the previous "List" call.
      in: query
      name: page
      required: false
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 512
        minLength: 1
    SortByQueryParam:
      description: 'The field to sort by. Only one sort order may be provided. ID is default ordered as ascending.

        '
      in: query
      name: sortBy
      required: false
      schema:
        type: string
        enum:
        - ID
        default: ID
    ServiceEnvironmentIdPathParam:
      description: "The unique identifier associated with the service environment. \n\n**Note:** Not an [OCID](/Content/General/Concepts/identifiers.htm).\n"
      in: path
      name: serviceEnvironmentId
      required: true
      schema:
        type: string
    ServiceEnvironmentIdQueryParam:
      description: "The unique identifier associated with the service environment. \n\n**Note:** Not an [OCID](/Content/General/Concepts/identifiers.htm).\n"
      in: query
      name: serviceEnvironmentId
      required: false
      x-default-description: 'null'
      schema:
        type: string
    PaginationLimitQueryParam:
      description: 'How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.

        '
      in: query
      name: limit
      required: false
      schema:
        type: integer
        default: 30
        maximum: 1000
        minimum: 1
    CompartmentIdRequiredQueryParam:
      description: The [OCID](/Content/General/Concepts/identifiers.htm) for the compartment.
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
        maxLength: 255
        minLength: 1
    SortOrderQueryParam:
      description: The sort order to use, either `ASC` or `DESC`.
      in: query
      name: sortOrder
      required: false
      schema:
        type: string
        enum:
        - ASC
        - DESC
        default: DESC
    OpcRequestIdHeaderParam:
      description: 'Unique Oracle-assigned 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
    ServiceNameFilterQueryParam:
      description: The display name of the resource.
      in: query
      name: displayName
      required: false
      x-default-description: 'null'
      schema:
        type: string
    ServiceEnvironmentTypeQueryParam:
      description: "The environment's service definition type. \nFor example, \"RGBUOROMS\" is the service definition type for \"Oracle Retail Order Management Cloud Service\".\n"
      in: query
      name: serviceEnvironmentType
      required: false
      x-default-description: 'null'
      schema:
        type: string
  responses:
    '400':
      description: Bad Request
      headers:
        opc-request-id:
          description: 'Unique Oracle-assigned identifier for the request. If you need to contact

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

            '
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEntity'
    Default:
      description: An error has occurred.
      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/ErrorEntity'
    '404':
      description: Not Found
      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/ErrorEntity'
    '412':
      description: Precondition Failed
      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/ErrorEntity'
    '401':
      description: Not Authenticated
      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/ErrorEntity'
    '429':
      description: Too Many Requests
      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/ErrorEntity'
    '409':
      description: Conflict
      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/ErrorEntity'
    '500':
      description: Internal Server 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/ErrorEntity'
  schemas:
    ServiceDefinition:
      description: 'Details for a service definition.

        '
      properties:
        displayName:
          description: 'Display name of the service. For example, "Oracle Retail Order Management Cloud Service".

            '
          type: string
        shortDisplayName:
          description: 'Short display name of the service. For example, "Retail Order Management".

            '
          type: string
        type:
          description: "The service definition type. For example, a service definition type \"RGBUOROMS\" \nwould be for the service \"Oracle Retail Order Management Cloud Service\".\n"
          type: string
      required:
      - type
      - displayName
      - shortDisplayName
      type: object
    ServiceEnvironmentEndPointOverview:
      description: "An overview of service environment endpoints. \n"
      properties:
        description:
          description: Description of the environment link
          minLength: 1
          type: string
        environmentType:
          description: Service environment endpoint type.
          enum:
          - INSTANCE_URL_PROD
          - INSTANCE_URL_TEST
          - INSTANCE_URL_DEV
          - OTHER
          type: string
        url:
          description: Service environment instance URL.
          minLength: 1
          type: string
      required:
      - environmentType
      - url
      type: object
    ServiceEnvironmentSummary:
      description: Summary of service environment details.
      properties:
        compartmentId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) for the compartment.
          maxLength: 255
          minLength: 1
          type: string
        consoleUrl:
          description: The URL for the console.
          maxLength: 1000
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              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
        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: `{"CostCenter": "42"}`

            '
          type: object
        id:
          description: "Unqiue identifier for the entitlement related to the environment. \n\n**Note:** Not an [OCID](/Content/General/Concepts/identifiers.htm).\n"
          maxLength: 255
          minLength: 1
          type: string
        serviceDefinition:
          $ref: '#/components/schemas/ServiceDefinition'
        serviceEnvironmentEndpoints:
          description: Array of service environment end points.
          items:
            $ref: '#/components/schemas/ServiceEnvironmentEndPointOverview'
          type: array
        status:
          description: Status of the entitlement registration for the service.
          enum:
          - INITIALIZED
          - BEGIN_ACTIVATION
          - ACTIVE
          - BEGIN_SOFT_TERMINATION
          - SOFT_TERMINATED
          - BEGIN_TERMINATION
          - CANCELED
          - TERMINATED
          - BEGIN_DISABLING
          - BEGIN_ENABLING
          - BEGIN_MIGRATION
          - DISABLED
          - BEGIN_SUSPENSION
          - BEGIN_RESUMPTION
          - SUSPENDED
          - BEGIN_LOCK_RELOCATION
          - LOCKED_RELOCATION
          - BEGIN_RELOCATION
          - RELOCATED
          - BEGIN_UNLOCK_RELOCATION
          - UNLOCKED_RELOCATION
          - FAILED_LOCK_RELOCATION
          - FAILED_ACTIVATION
          - FAILED_MIGRATION
          - ACCESS_DISABLED
          - BEGIN_DISABLING_ACCESS
          - BEGIN_ENABLING_ACCESS
          - TRA_UNKNOWN
          type: string
          x-obmcs-top-level-enum: '#/definitions/ServiceEntitlementRegistrationStatus'
        subscriptionId:
          description: 'The unique subscription ID associated with the service environment ID.


            **Note:** Not an [OCID](/Content/General/Concepts/identifiers.htm).

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - id
      - subscriptionId
      - status
      - compartmentId
      - serviceDefinition
      type: object
    ErrorEntity:
      description: The model for the error entity.
      properties:
        code:
          description: A short error code that defines the error.
          maxLength: 255
          minLength: 0
          type: string
        message:
          description: A human-readable error string.
          maxLength: 1023
          minLength: 0
          type: string
      required:
      - code
      - message
      type: object
    ServiceEnvironment:
      description: "Detailed information about a service environment. \n\n**Note:** Service URL formats may vary from the provided example.\n"
      properties:
        compartmentId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) for the compartment.
          maxLength: 255
          minLength: 1
          type: string
        consoleUrl:
          description: The URL for the console.
          maxLength: 1000
          minLength: 1
          type: string
        id:
          description: "Unqiue identifier for the entitlement related to the environment. \n\n**Note:** Not an [OCID](/Content/General/Concepts/identifiers.htm).\n"
          maxLength: 255
          minLength: 1
          type: string
        serviceDefinition:
          $ref: '#/components/schemas/ServiceDefinition'
        serviceEnvironmentEndpoints:
          description: Array of service environment end points.
          items:
            $ref: '#/components/schemas/ServiceEnvironmentEndPointOverview'
          type: array
        status:
          description: Status of the entitlement registration for the service.
          enum:
          - INITIALIZED
          - BEGIN_ACTIVATION
          - ACTIVE
          - BEGIN_SOFT_TERMINATION
          - SOFT_TERMINATED
          - BEGIN_TERMINATION
          - CANCELED
          - TERMINATED
          - BEGIN_DISABLING
          - BEGIN_ENABLING
          - BEGIN_MIGRATION
          - DISABLED
          - BEGIN_SUSPENSION
          - BEGIN_RESUMPTION
          - SUSPENDED
          - BEGIN_LOCK_RELOCATION
          - LOCKED_RELOCATION
          - BEGIN_RELOCATION
          - RELOCATED
          - BEGIN_UNLOCK_RELOCATION
          - UNLOCKED_RELOCATION
          - FAILED_LOCK_RELOCATION
          - FAILED_ACTIVATION
          - FAILED_MIGRATION
          - ACCESS_DISABLED
          - BEGIN_DISABLING_ACCESS
          - BEGIN_ENABLING_ACCESS
          - TRA_UNKNOWN
          type: string
          x-obmcs-top-level-enum: '#/definitions/ServiceEntitlementRegistrationStatus'
        subscriptionId:
          description: 'The unique subscription ID associated with the service environment ID.


            **Note:** Not an [OCID](/Content/General/Concepts/identifiers.htm).

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - id
      - subscriptionId
      - status
      - compartmentId
      - serviceDefinition
      type: object
      x-example: "{\n \"id\": \"197530\",\n \"subscriptionId\": \"235791\"\n \"id\": \"<var>&lt;unique_ID&gt;</var>\"\n \"status\": \"ACTIVE\",\n \"compartmentId\": \"ocid1.compartment.oc1..<var>&lt;unique_ID&gt;</var>\",\n \"serviceDefinition\": {\n    \"type\": \"RGBUOROMS\",\n    \"displayName\": \"Oracle Retail Order Management Cloud Service\",\n    \"shortDisplayName\": \"Retail Order Management\"\n  },\n \"consoleUrl\": \"https://<var>&lt;example&gt;</var>.oraclecloud.com\",\n \"serviceEnvironmentEndpoints\" : [ {\n    \"environmentType\" : \"PROD\",\n    \"url\" : \"https://<var>&lt;example&gt;</var>.oraclecloud.com/RGBUOROMS/<var>&lt;entitlement_id&gt;</var>/prod\"\n   },\n   {\n    \"environmentType\" : \"TEST\",\n    \"url\" : \"https://<var>&lt;example&gt;</var>.oraclecloud.com/RGBUOROMS/<var>&lt;entitlement_id&gt;</var>/test\"\n   },\n   {\n    \"environmentType\" : \"DEV\",\n    \"url\" : \"https://<var>&lt;example&gt;</var>.oraclecloud.com/RGBUOROMS/<var>&lt;entitlement_id&gt;</var>/dev\"\n   }]\n }\n"
    ServiceEnvironmentCollection:
      description: "Collection of service environments. \n\n**Note:** Service URL formats may vary from the provided example.\n"
      properties:
        items:
          description: Collection of items.
          items:
            $ref: '#/components/schemas/ServiceEnvironmentSummary'
          type: array
      required:
      - items
      type: object
      x-example: "[\n  {\n    \"id\": \"198720\",\n    \"subscriptionId\": \"235791\",\n    \"id\": \"<var>&lt;unique_ID&gt;</var>\"\n    \"status\": \"ACTIVE\",\n    \"compartmentId\": \"ocid1.compartment.oc1..<var>&lt;unique_ID&gt;</var>\",\n    \"serviceDefinition\": {\n        \"type\": \"RGBUOROMS\",\n        \"displayName\": \"Oracle Retail Order Management Cloud Service\",\n        \"shortDisplayName\": \"Retail Order Management\"\n      },\n    \"consoleUrl\": \"https://<var>&lt;example&gt;</var>.oraclecloud.com\",\n    \"serviceEnvironmentEndpoints\" : [ {\n        \"environmentType\" : \"PROD\",\n        \"url\" : \"https://<var>&lt;example&gt;</var>.oraclecloud.com/RGBUOROMS/<var>&lt;entitlement_id&gt;</var>/prod\"\n      },\n      {\n        \"environmentType\" : \"TEST\",\n        \"url\" : \"https://<var>&lt;example&gt;</var>.oraclecloud.com/RGBUOROMS/<var>&lt;entitlement_id&gt;</var>/test\"\n      },\n      {\n        \"environmentType\" : \"DEV\",\n        \"url\" : \"https://<var>&lt;example&gt;</var>.oraclecloud.com/RGBUOROMS/<var>&lt;entitlement_id&gt;</var>/dev\"\n    }]\n  }\n]\n"
x-anchors:
  x-headers:
    etag:
      description: 'For optimistic concurrency control. See `if-match`.

        '
      type: string
    opc-next-page:
      description: 'For list pagination. When this header appears in the response, additional pages

        of results remain. For important details about how pagination works, see

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

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

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

        '
      type: string
    opc-work-request-id:
      description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

        '
      type: string
    retry-after:
      description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
      type: integer
  x-properties:
    definedTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string, integer, and boolean types are supported.

            '
          type: object
        description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

          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
    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: `{"CostCenter": "42"}`

        '
      type: object
    systemTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string, integer and boolean types are supported.

            '
          type: object
        description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.


          Example: `{"Free-tier-retained": "true"}`

          '
        type: object
      description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.


        Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

        '
      type: object