Acquia Subscriptions API

The Subscriptions API from Acquia — 22 operation(s) for subscriptions.

OpenAPI Specification

acquia-subscriptions-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  contact:
    name: Customer Experience Engineering (CXE)
    url: https://www.acquia.com
  description: "Acquia Cloud API\n\n# Compatibility\n\n## Stability\n\nThe response for all resource endpoints includes an `X-CloudAPI-Stability` header that indicates what changes, if any, Acquia will make to the resource and how changes will be communicated.\n\nThere are three levels of stability:\n\n* `prototype`: A prototype resource is experimental and major changes are likely. A prototype resource may not reach production.\n    * Compatible and emergency changes may be made with no advance notice\n    * Disruptive changes may be made with one week notice\n    * Deprecated resources will remain available for at least one month after deprecation\n* `development`: A resource that is unlikely to change, but is still being worked on, will be marked as in development. These resources are very likely to reach production.\n    * Compatible and emergency changes may be made with no advance notice\n    * Disruptive changes may be made with one month notice\n    * Deprecated resources will remain available for at least six months after deprecation\n* `production`: A production resource will not introduce breaking changes within a version, and any breaking changes between versions will be communicated ahead of time.\n\n## Deprecation\n\nOver time, endpoints may become obsolete and will be removed in the future. These endpoints will be marked with an `X-CloudAPI-Deprecated` header indicating the version in which they were deprecated and the reason for the deprecation. Deprecated endpoints may be removed in the next version of the resource.\n\n## Versioning\n\nAll resource endpoints are versioned within the API. Endpoints that have reached production will not introduce breaking changes between versions. Non-production endpoints will not version for changes.\n\nA specific version of an endpoint can be requested via the `Accept` header:\n\n    Accept: application/hal+json, version=2\n\nIf the version is not specified, the latest version of the endpoint will be used.\n\nStarting with version 3, we will support the current version of an endpoint and the previous version. Version 1 of the API is [provided elsewhere](https://cloudapi.acquia.com/).\n\n## Errors\n\nSome endpoints will return a 503 status when dependent services are unavailable:\n\n    application/hal+json\n    {\n        \"error\": \"system\",\n        \"message\": \"This action is currently unavailable. Please try again later.\"\n    }\n\n## Authentication\n\nAll Acquia Cloud API calls require authentication to work properly.\n\nLearn more: <a href='https://docs.acquia.com/acquia-cloud/develop/api/auth/' target='_blank'>https://docs.acquia.com/acquia-cloud/develop/api/auth/</a>\n\n### Example implementation\n\nAn example PHP script for making authenticated API requests can be found <a href='https://docs.acquia.com/resources/useful-references' target='_blank'>here</a>. This script uses the <a href='https://oauth2-client.thephpleague.com/' target='_blank'>League/oauth2-client</a> library, installed via Composer.\n"
  title: Acquia Cloud API Account Subscriptions API
  version: 2.0.0
  x-logo:
    altText: Acquia Cloud
    backgroundColor: '#FFFFFF'
    url: assets/cloud-platform.svg
servers: []
tags:
- name: Subscriptions
  x-displayName: Subscriptions
paths:
  /subscriptions:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      tags:
      - Subscriptions
      summary: Return a list of subscription.
      description: 'Filterable fields:

        * `from`

        * `to`

        * `sort`

        * `filter`

        * `limit`

        * `offset`


        Sortable fields:

        * `from`

        * `to`

        * `sort`

        * `filter`

        * `limit`

        * `offset`

        '
      operationId: getSubscriptions
      x-cli-name: subscriptions:list
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_from'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_to'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_sort'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_limit'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_offset'
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_subscriptions'
              example:
                total: 3
                _links:
                  self:
                    href: https://cloud.acquia.com/api/subscriptions
                  sort:
                    href: https://cloud.acquia.com/api/subscriptions{?sort}
                    templated: true
                  filter:
                    href: https://cloud.acquia.com/api/subscriptions{?filter}
                    templated: true
                  limit:
                    href: https://cloud.acquia.com/api/subscriptions{?limit}
                    templated: true
                  parent:
                    href: https://cloud.acquia.com/api/
                _embedded:
                  items:
                  - id: 123
                    uuid: faa297f3-f59a-4abc-8d71-904f51bcb1c5
                    name: Acquia Cloud Free Subscription
                    start_at: '2011-03-28T00:00:00'
                    expire_at: '2015-11-11T00:00:00'
                    product:
                      id: 1890149
                      name: Acquia Cloud Free
                      type: free
                    applications_total: 3
                    applications_used: 1
                    organization:
                      uuid: 39f38840-c494-4622-80a5-fc40269cb42d
                      name: Acquia Inc.
                    flags:
                      active: true
                      expired: true
                      zuora: false
                    _links:
                      self:
                        href: https://cloud.acquia.com/api/subscriptions/faa297f3-f59a-4abc-8d71-904f51bcb1c5
                    _embedded:
                      organization:
                        uuid: 39f38840-c494-4622-80a5-fc40269cb42d
                        name: Acquia Inc.
                        _links:
                          self:
                            href: https://cloud.acquia.com/api/organizations/39f38840-c494-4622-80a5-fc40269cb42d
                          parent:
                            href: https://cloud.acquia.com/api/organizations
                  - id: 222
                    uuid: 36496037-6eb5-482d-8549-e45e1718f2b7
                    name: My Acquia Subscription
                    start_at: '2012-05-15T12:00:00Z'
                    expire_at: '2015-05-15T12:00:00Z'
                    product:
                      id: 8999
                      name: Enterprise
                      type: enterprise
                    applications_total: 5
                    applications_used: 2
                    organization:
                      uuid: 93c97126-2870-47f0-9ffd-9a92033c443e
                      name: My Organization
                    flags:
                      active: true
                      expired: true
                      zuora: false
                    _links:
                      self:
                        href: https://cloud.acquia.com/api/subscriptions/36496037-6eb5-482d-8549-e45e1718f2b7
                    _embedded:
                      organization:
                        uuid: 93c97126-2870-47f0-9ffd-9a92033c443e
                        name: My Organization
                        _links:
                          self:
                            href: https://cloud.acquia.com/api/organizations/93c97126-2870-47f0-9ffd-9a92033c443e
                          parent:
                            href: https://cloud.acquia.com/api/organizations
                  - id: 333
                    uuid: 2d92f652-882c-458a-8183-4d9cef7c2fde
                    name: My Acquia Subscription 2
                    start_at: '2012-05-15T12:00:00Z'
                    expire_at: '2015-05-15T12:00:00Z'
                    product:
                      id: 8999
                      name: Enterprise
                      type: enterprise
                    applications_total: 5
                    applications_used: 2
                    organization:
                      uuid: 93c97126-2870-47f0-9ffd-9a92033c443e
                      name: My Organization
                    flags:
                      active: true
                      expired: true
                      zuora: false
                    _links:
                      self:
                        href: https://cloud.acquia.com/api/subscriptions/2d92f652-882c-458a-8183-4d9cef7c2fde
                    _embedded:
                      organization:
                        uuid: 93c97126-2870-47f0-9ffd-9a92033c443e
                        name: My Organization
                        _links:
                          self:
                            href: https://cloud.acquia.com/api/organizations/93c97126-2870-47f0-9ffd-9a92033c443e
                          parent:
                            href: https://cloud.acquia.com/api/organizations
        '404':
          description: Not Found
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
              examples:
                Not found:
                  value:
                    error: not_found
                    message: You do not have permission to view subscriptions.
  /subscriptions/{subscriptionUuid}:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      tags:
      - Subscriptions
      summary: Return details about a specific subscription.
      description: Return details about a specific subscription.
      operationId: getSubscription
      x-cli-name: subscriptions:find
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid'
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_subscription'
              example:
                id: 329876
                uuid: 8533debb-ae4e-427b-aa34-731719b4201a
                name: My Subscription
                start_at: '2015-05-13T00:00:00'
                expire_at: '2018-05-12T00:00:00'
                product:
                  id: 8999
                  name: Enterprise
                  type: enterprise
                applications_total: 10
                applications_used: 0
                organization:
                  uuid: 93c97126-2870-47f0-9ffd-9a92033c443e
                  name: My Organization
                flags:
                  active: true
                  expired: true
                  zuora: false
                _links:
                  self:
                    href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a
                  applications:
                    href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/applications
                  entitlements:
                    href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/entitlements
                  ides:
                    href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/ides
                  shield-acl:
                    href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/shield-acl
                  parent:
                    href: https://cloud.acquia.com/api/subscriptions
                _embedded:
                  organization:
                    uuid: 93c97126-2870-47f0-9ffd-9a92033c443e
                    name: My Organization
                    _links:
                      self:
                        href: https://cloud.acquia.com/api/organizations/93c97126-2870-47f0-9ffd-9a92033c443e
                      parent:
                        href: https://cloud.acquia.com/api/organizations
        '404':
          description: Not Found
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
              examples:
                No subscription or permission:
                  value:
                    error: not_found
                    message: The subscription you are trying to access does not exist, or you do not have permission to access it.
    put:
      tags:
      - Subscriptions
      summary: Modifies a subscription.
      description: Modifies a subscription.
      operationId: putSubscription
      x-cli-name: subscriptions:update
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The new subscription name.
                  maxLength: 255
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
              examples:
                Subscription updated:
                  value:
                    message: Subscription updated.
        '404':
          description: Not Found
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
              examples:
                Validation failed:
                  value:
                    error: not_found
                    message: The subscription you are trying to access does not exist, or you do not have permission to access it.
  /subscriptions/{subscriptionUuid}/applications:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      tags:
      - Subscriptions
      summary: Provides a list of applications that are a part of the subscription.
      description: 'Filterable fields:

        * `from`

        * `to`

        * `sort`

        * `filter`

        * `limit`

        * `offset`


        Sortable fields:

        * `from`

        * `to`

        * `sort`

        * `filter`

        * `limit`

        * `offset`

        '
      operationId: getSubscriptionApplications
      x-cli-name: subscriptions:application-list
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_sort'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_limit'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_offset'
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_subscription-applications'
              example:
                total: 2
                pagination:
                  total: 2
                  limit: 10
                  offset: 0
                _links:
                  self:
                    href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/applications
                  parent:
                    href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a
                  sort:
                    href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/applications{?sort}
                    templated: true
                  filter:
                    href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/applications{?filter}
                    templated: true
                  limit:
                    href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/applications{?limit}
                    templated: true
                _embedded:
                  items:
                  - id: 241643
                    uuid: a47ac10b-58cc-4372-a567-0e02b2c3d470
                    name: Sample application 1
                    hosting:
                      type: acp
                      id: devcloud:devcloud2
                    subscription:
                      uuid: f47ac10b-58cc-4372-a567-0e02b2c3d470
                      name: Sample subscription
                    organization:
                      uuid: 6a907396-abfd-4d01-9da6-64c8efc04519
                      name: Sample organization
                    flags:
                      remote_admin: true
                    status: normal
                    type: drupal
                    _links:
                      self:
                        href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470
                  - id: 954291
                    uuid: a47ac10b-58cc-4372-a567-0e02b2c3d471
                    name: Sample application 2
                    hosting:
                      type: free
                      id: devcloud:devcloud2
                    subscription:
                      uuid: f47ac10b-58cc-4372-a567-0e02b2c3d470
                      name: Sample subscription
                    organization:
                      uuid: 6a907396-abfd-4d01-9da6-64c8efc04519
                      name: Sample organization
                    flags:
                      remote_admin: false
                    status: provisioning
                    type: drupal
                    _links:
                      self:
                        href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d471
        '404':
          description: Not Found
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
              example:
                error: not_found
                message: You do not have permission to view applications.
  /subscriptions/{subscriptionUuid}/code-studio:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      tags:
      - Subscriptions
      summary: Retrieves Code Studio metadata for a subscription.
      description: Retrieves Code Studio metadata for a subscription.
      operationId: getCodeStudioSubscriptionMetadata
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid'
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_code-studio-subscription-metadata'
              example:
                _links:
                  self:
                    href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio
                  subscription:
                    href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342
                  parent:
                    href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342
                  users:
                    href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/users
                  applications:
                    href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/applications
                  code-studio:
                    href: https://code.acquia.com
                  code-studio-api:
                    href: https://code.acquia.com/api/v4
                _embedded:
                  subscription:
                    _links:
                      self:
                        href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342
                    uuid: e5bfb18f-2c6c-4534-bb9b-15ba73e17342
                    name: My Subscription
                status: active
        '403':
          description: Forbidden
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
              examples:
                No entitlement:
                  value:
                    error: forbidden
                    message: Code Studio is not available for this subscription.
        '404':
          description: Not Found
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
              examples:
                No subscription or permission:
                  value:
                    error: not_found
                    message: The subscription you are trying to access does not exist, or you do not have permission to access it.
    options:
      tags:
      - Subscriptions
      summary: Displays Code Studio options for a subscription.
      description: Displays Code Studio options for a subscription.
      operationId: optionsCodeStudio
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid'
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_code-studio-options'
              example:
                _links:
                  self:
                    href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio
                  parent:
                    href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342
                roles:
                  a9bdb481-63f4-4770-93ee-bf6c630238cf: Guest
                  c6c76597-dd30-4149-8a76-3c58d764bc66: Reporter
                  4a996644-5a6e-4403-9306-6c08cb212ee1: Developer
                  90abb6cc-f609-41db-a92d-1900b1c7d93f: Maintainer
                  e62722c0-64dc-4d87-88ac-9f7bef645572: Owner
        '403':
          description: Forbidden
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
              examples:
                No entitlement:
                  value:
                    error: forbidden
                    message: Code Studio is not available for this subscription.
        '404':
          description: Not Found
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
              examples:
                No subscription or permission:
                  value:
                    error: not_found
                    message: The subscription you are trying to access does not exist, or you do not have permission to access it.
  /subscriptions/{subscriptionUuid}/code-studio/actions/enable:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    post:
      tags:
      - Subscriptions
      summary: Enables Code Studio for a subscription.
      description: Enables and provisions Code Studio at the subscription level.
      operationId: postEnableCodeStudio
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid'
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
              example:
                _links:
                  self:
                    href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/actions/enable
                  notification:
                    href: https://cloud.acquia.com/api/notifications/34c7ed7e-2db8-433f-b6a8-96bc1080e3c9
                notification_id: 34c7ed7e-2db8-433f-b6a8-96bc1080e3c9
                message: Code Studio has been enabled for the Subscription.
        '403':
          description: Forbidden
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
              examples:
                No permission:
                  value:
                    error: forbidden
                    message: You do not have permission to enable Code Studio for this subscription.
        '404':
          description: Not Found
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
              examples:
                No subscription or permission:
                  value:
                    error: not_found
                    message: The subscription you are trying to access does not exist, or you do not have permission to access it.
  /subscriptions/{subscriptionUuid}/code-studio/applications:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      tags:
      - Subscriptions
      summary: Retrieves a list of Code Studio enabled applications for a subscription.
      description: Retrieves a list of Code Studio enabled applications for a subscription.
      operationId: getCodeStudioApplications
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid'
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_code-studio-applications'
              example:
                total: 1
                pagination:
                  limit: 10
                  total: 1
                  offset: 0
                _links:
                  parent:
                    href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342
                  code-studio:
                    href: https://code.acquia.com
                  code-studio-api:
                    href: https://code.acquia.com/api/v4
                  self:
                    href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/applications?offset=1
                  filter:
                    href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/applications?offset=1{&filter}
                    templated: true
                  sort:
                    href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/applications?offset=1{&sort}
                    templated: true
                _embedded:
                  items:
                  - _links:
                      self:
                        href: https://cloud.acquia.com/api/applications/b91be25b-8eba-4ff7-94c8-d51637da2343
                      project:
                        href: https://cloud.acquia.com/api/applications/b91be25b-8eba-4ff7-94c8-d51637da2343/code-studio
                      parent:
                        href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342
                    _embedded:
                      project:
                        _links:
                          self:
                            href: https://cloud.acquia.com/api/applications/b91be25b-8eba-4ff7-94c8-d51637da2343/code-studio
                          parent:
                            href: https://cloud.acquia.com/api/applications/b91be25b-8eba-4ff7-94c8-d51637da2343
                          code-studio:
                            href: https://code.acquia.com/path/to/project
                          code-studio-api:
                            href: https://code.acquia.com/api/v4/path/to/project
                        application_id: b91be25b-8eba-4ff7-94c8-d51637da2343
                        status: active
                    uuid: b91be25b-8eba-4ff7-94c8-d51637da2343
                    name: My Application
        '403':
          description: Forbidden
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
              examples:
                No entitlement:
                  value:
                    error: forbidden
                    message: Code Studio is not available for this subscription.
        '404':
          description: Not Found
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
              examples:
                No subscription or permission:
                  value:
                    error: not_found
                    message: The subscription you are trying to access does not exist, or you do not have permission to access it.
  /subscriptions/{subscriptionUuid}/code-studio/users:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      tags:
      - Subscriptions
      summary: Retrieves a list of users assigned to Code Studio for a subscription.
      description: Retrieves a list of users assigned to Code Studio for a subscription.
      operationId: getCodeStudioUsers
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid'
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_code-studio-users'
              example:
                total: 1
                pagination:
                  limit: 10
                  total: 1
                  offset: 0
                _links:
                  parent:
                    href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio
                  self:
                    href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/users
                  code-studio:
                    href: https://code.acquia.com
                  code-studio-api:
                    href: https://code.acquia.com/api/v4
                  filter:
                    href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/users{?filter}
                    templated: true
                  sort:
                    href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/users{?sort}
                    templated: true
                _embedded:
                  items:
                  - _links:
                      self:
                        href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/users/cc27c5b6-d641-4e72-8897-75874ecf82e6
                      parent:
                        href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/users
                      code-studio:
                        href: https://code.acquia.com
                      code-studio-api:
          

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