openapi: 3.0.0
info:
  version: 2015-07-09
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Workspaces API
  description: <fullname>Amazon API Gateway</fullname> <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: apigateway
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: https://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: http://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
- url: https://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Workspaces
  description: The **Workspaces** endpoints enable you to manage your [workspaces](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/creating-workspaces/). The Workspaces endpoints let you manage your workspaces. Workspaces enable you to organize your Postman work and collaborate with teammates.
paths:
  /workspaces:
    get:
      summary: APIs.io Engineering Platform Get all workspaces
      description: 'Gets all [workspaces](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/creating-workspaces/). The response includes your workspaces and any workspaces that you have access to.


        **Note:**


        This endpoint''s response contains the visibility field. Visibility determines who can access the workspace:

        - `personal` — Only you can access the workspace.

        - `team` — All team members can access the workspace.

        - `private` — Only invited team members can access the workspace ([**Professional** and **Enterprise** plans only](https://www.postman.com/pricing)).

        - `public` — Everyone can access the workspace.

        - `partner` — Only invited team members and [partners](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/) can access the workspace ([**Professional** and **Enterprise** plans only](https://www.postman.com/pricing)).

        '
      operationId: getWorkspaces
      tags:
      - Workspaces
      responses:
        '200':
          $ref: '#/components/responses/getWorkspaces'
        '401':
          $ref: '#/components/responses/common401Error'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
      parameters:
      - $ref: '#/components/parameters/workspaceTypeQuery'
      - $ref: '#/components/parameters/workspaceCreatedBy'
      - $ref: '#/components/parameters/workspaceIncludeQuery'
    post:
      summary: APIs.io Engineering Platform Create a workspace
      description: 'Creates a new [workspace](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/creating-workspaces/).


        **Note:**


        This endpoint returns a 403 `Forbidden` response if the user does not have permission to create workspaces. [Admins and Super Admins](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles) can configure workspace permissions to restrict users and/or user groups from creating workspaces or require approvals for the creation of team workspaces.


        ### Important


        We deprecated linking collections or environments between workspaces. We do not recommend that you do this.


        If you have a linked collection or environment, note the following:

        - The endpoint does not create a clone of a collection or environment.

        - Any changes you make to a linked collection or environment changes them in all workspaces.

        - If you delete a collection or environment linked between workspaces, the system deletes it in all the workspaces.

        '
      operationId: createWorkspace
      tags:
      - Workspaces
      requestBody:
        $ref: '#/components/requestBodies/createWorkspace'
      responses:
        '200':
          $ref: '#/components/responses/createWorkspace'
        '400':
          $ref: '#/components/responses/workspace400ErrorMalformedRequest'
        '401':
          $ref: '#/components/responses/common401Error'
        '403':
          $ref: '#/components/responses/workspace403ErrorUnauthorized'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
  /workspaces-roles:
    get:
      summary: APIs.io Engineering Platform Get all roles
      description: 'Gets information about all roles in a workspace, based on the team''s [plan](https://www.postman.com/pricing/).

        '
      operationId: getAllWorkspaceRoles
      tags:
      - Workspaces
      responses:
        '200':
          $ref: '#/components/responses/getAllWorkspaceRoles'
        '401':
          $ref: '#/components/responses/api401ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/common403ErrorPermissions'
        '500':
          $ref: '#/components/responses/common500ErrorInternalServer'
  /workspaces/{workspaceId}:
    parameters:
    - $ref: '#/components/parameters/workspaceId'
    get:
      summary: APIs.io Engineering Platform Get a workspace
      description: 'Gets information about a workspace.


        **Note:**


        This endpoint''s response contains the `visibility` field. [Visibility](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#changing-workspace-visibility) determines who can access the workspace:

        - `personal` — Only you can access the workspace.

        - `team` — All team members can access the workspace.

        - `private` — Only invited team members can access the workspace ([**Professional** and **Enterprise** plans only](https://www.postman.com/pricing)).

        - `public` — Everyone can access the workspace.

        - `partner` — Only invited team members and [partners](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/) can access the workspace ([**Professional** and **Enterprise** plans only](https://www.postman.com/pricing)).


        ### Important


        We have deprecated the `name` and `uid` responses in the following array of objects:

        - `collections`

        - `environments`

        - `mocks`

        - `monitors`

        - `apis`

        '
      operationId: getWorkspace
      tags:
      - Workspaces
      responses:
        '200':
          $ref: '#/components/responses/getWorkspace'
        '401':
          $ref: '#/components/responses/common401Error'
        '404':
          $ref: '#/components/responses/workspace404ErrorNotFound'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
      parameters:
      - $ref: '#/components/parameters/workspaceIncludeQuery'
    put:
      summary: APIs.io Engineering Platform Update a workspace
      description: 'Updates a workspace.


        ### Important


        We deprecated linking collections or environments between workspaces. We do not recommend that you do this.


        If you have a linked collection or environment, note the following:

        - The endpoint does not create a clone of a collection or environment.

        - Any changes you make to a linked collection or environment changes them in all workspaces.

        - If you delete a collection or environment linked between workspaces, the system deletes it in all the workspaces.

        '
      operationId: updateWorkspace
      tags:
      - Workspaces
      requestBody:
        $ref: '#/components/requestBodies/updateWorkspace'
      responses:
        '200':
          $ref: '#/components/responses/updateWorkspace'
        '400':
          $ref: '#/components/responses/workspace400ErrorMalformedRequest'
        '403':
          $ref: '#/components/responses/workspace403Error'
        '404':
          $ref: '#/components/responses/instanceNotFoundWorkspace'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
    delete:
      summary: APIs.io Engineering Platform Delete a workspace
      description: 'Deletes an existing workspace.


        ### Important


        If you delete a workspace that has a linked collection or environment with another workspace, this will delete the collection and environment in all workspaces.

        '
      operationId: deleteWorkspace
      tags:
      - Workspaces
      responses:
        '200':
          $ref: '#/components/responses/deleteWorkspace'
        '400':
          $ref: '#/components/responses/workspace400Error'
        '401':
          $ref: '#/components/responses/common401Error'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
  /workspaces/{workspaceId}/global-variables:
    parameters:
    - $ref: '#/components/parameters/workspaceId'
    get:
      summary: APIs.io Engineering Platform Get global variables
      description: Gets a workspace's global [variables](https://learning.postman.com/docs/sending-requests/variables/#variable-scopes).
      operationId: getWorkspaceGlobalVariables
      tags:
      - Workspaces
      responses:
        '200':
          $ref: '#/components/responses/getWorkspaceGlobalVariables'
        '500':
          $ref: '#/components/responses/globalVariables500Error'
    put:
      summary: APIs.io Engineering Platform Update global variables
      description: Updates and replaces a workspace's global [variables](https://learning.postman.com/docs/sending-requests/variables/#variable-scopes). This endpoint replaces all existing global variables with the variables you pass in the request body.
      operationId: updateWorkspaceGlobalVariables
      tags:
      - Workspaces
      requestBody:
        $ref: '#/components/requestBodies/updateWorkspaceGlobalVariables'
      responses:
        '200':
          $ref: '#/components/responses/updateWorkspaceGlobalVariables'
        '500':
          $ref: '#/components/responses/globalVariables500Error'
  /workspaces/{workspaceId}/roles:
    parameters:
    - $ref: '#/components/parameters/workspaceId'
    patch:
      summary: APIs.io Engineering Platform Update user or user group roles
      description: 'Updates the roles of [users](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles) or [user groups](https://learning.postman.com/docs/collaborating-in-postman/user-groups/) in a workspace. To get a list of roles, use the `GET /workspace-roles` endpoint.


        **Note:**


        - To use SCIM IDs, include the `identifierType=scim` header when you call this endpoint. To get SCIM user IDs, include the `include=scim` query parameter when calling the GET `/workspaces/{workspaceId}` or GET `/workspaces` endpoints.

        - You cannot set roles for users in personal and partner workspaces.

        - This endpoint does not support the external [Partner or Guest roles](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles).

        - This endpoint is restricted to 50 operations per call.

        - The request body must contain one unique action per user or user group. For example, you cannot add and remove multiple roles for a user in the same request body.

        '
      operationId: updateWorkspaceRoles
      tags:
      - Workspaces
      requestBody:
        $ref: '#/components/requestBodies/updateWorkspaceRoles'
      responses:
        '200':
          $ref: '#/components/responses/updateWorkspaceRoles'
        '400':
          $ref: '#/components/responses/workspaceRoles400Error'
        '401':
          $ref: '#/components/responses/unauthorizedError'
        '403':
          $ref: '#/components/responses/common403ErrorPermissions'
        '404':
          $ref: '#/components/responses/resourceNotFound404Error'
        '422':
          $ref: '#/components/responses/workspaceRoles422UnsupportRoleError'
        '500':
          $ref: '#/components/responses/common500ErrorInternalServer'
      parameters:
      - $ref: '#/components/parameters/identifierType'
    get:
      summary: APIs.io Engineering Platform Get a workspace's roles
      description: 'Gets the roles of users and user groups in a workspace:

        - `Viewer` — Can view, fork, and export workspace resources.

        - `Editor` — Can create and edit workspace resources.

        - `Admin` — Can manage workspace details and members.

        '
      operationId: getWorkspaceRoles
      tags:
      - Workspaces
      responses:
        '200':
          $ref: '#/components/responses/getWorkspaceRoles'
        '401':
          $ref: '#/components/responses/unauthorizedError'
        '403':
          $ref: '#/components/responses/common403ErrorPermissions'
        '404':
          $ref: '#/components/responses/resourceNotFound404Error'
        '500':
          $ref: '#/components/responses/common500ErrorInternalServer'
      parameters:
      - $ref: '#/components/parameters/workspaceIncludeScimQuery'
components:
  responses:
    getWorkspaces:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              workspaces:
                type: array
                items:
                  type: object
                  description: Information about the workspace.
                  properties:
                    id:
                      type: string
                      description: The workspace's ID.
                      example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9
                    name:
                      type: string
                      description: The workspace's name.
                      example: Team Workspace
                    type:
                      type: string
                      description: The type of workspace.
                      enum:
                      - personal
                      - team
                      - private
                      - public
                      - partner
                      example: team
                    visibility:
                      type: string
                      description: 'The workspace''s visibility. [Visibility](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#changing-workspace-visibility) determines who can access the workspace:

                        - `personal` — Only you can access the workspace.

                        - `team` — All team members can access the workspace.

                        - `private` — Only invited team members can access the workspace ([**Professional** and **Enterprise** plans only](https://www.postman.com/pricing)).

                        - `public` — Everyone can access the workspace.

                        - `partner` — Only invited team members and [partners](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/) can access the workspace ([**Professional** and **Enterprise** plans only](https://www.postman.com/pricing)).

                        '
                      enum:
                      - personal
                      - team
                      - private
                      - public
                      - partner
                      example: team
                    createdBy:
                      type: integer
                      description: The user who created the workspace. The response only returns workspaces that you have access to.
                      example: 12345678
                    scim:
                      type: object
                      description: An object containing SCIM user IDs. This object only returns if you pass the `include=scim` query parameter.
                      properties:
                        createdBy:
                          type: string
                          description: The SCIM user ID of the user who created the workspace.
                          example: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99
          examples:
            Successful Response:
              value:
                workspaces:
                - id: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9
                  name: My Workspace
                  createdBy: 12345678
                  type: personal
                  visibility: personal
                - id: a0f46158-1529-11ee-be56-0242ac120002
                  name: Private Workspace
                  createdBy: 12345678
                  type: team
                  visibility: private
                - id: f8801e9e-03a4-4c7b-b31e-5db5cd771696
                  name: Team Workspace
                  createdBy: 12345678
                  type: team
                  visibility: team
                - id: 74dbfab8-1529-11ee-be56-0242ac120002
                  name: Public Workspace
                  createdBy: 12345678
                  type: team
                  visibility: public
                - id: 74dbfab8-1529-11ee-be56-0242ac120002
                  name: Partner Workspace
                  createdBy: 12345678
                  type: team
                  visibility: partner
            Include SCIM IDs:
              value:
                workspaces:
                - id: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9
                  name: My Workspace
                  type: personal
                  visibility: personal
                  createdBy: 12345678
                  scim:
                    createdBy: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99
    deleteWorkspace:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              workspace:
                type: object
                description: Information about the deleted workspace.
                properties:
                  id:
                    type: string
                    description: The workspace's ID.
                    example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9
          example:
            workspace:
              id: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9
    globalVariables500Error:
      description: Internal Server Error
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                format: uri-reference
                description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
                example: https://api.postman.com/problems/servererror
              title:
                type: string
                description: A short summary of the problem.
                example: Internal server error
              detail:
                type: string
                description: Information about the error.
                example: Details about the error
          example:
            type: https://api.postman.com/problems/servererror
            title: Internal server error
            detail: Details about the error
    instanceNotFoundWorkspace:
      description: Instance Not Found
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: instanceNotFoundError
                  message:
                    type: string
                    description: The error message.
                    example: The specified workspace does not exist.
          example:
            error:
              name: instanceNotFoundError
              message: The specified workspace does not exist.
    workspace400ErrorMalformedRequest:
      description: Workspace Not Found
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              name:
                type: string
                description: The error name.
                example: malformedRequestError
              message:
                type: string
                description: The error message.
                example: '''workspace'' object missing in the request'
          example:
            name: malformedRequestError
            message: '''workspace'' object missing in the request'
    api401ErrorUnauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                format: uri-reference
                description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
                example: https://api.postman.com/problems/unauthorized
              title:
                type: string
                description: A short summary of the problem.
                example: Unauthorized
              detail:
                type: string
                description: Information about the error.
                example: An API key must be provided in the request header or query string
              status:
                type: number
                format: http-status-code
                description: The error's HTTP status code.
                example: 401
              instance:
                type: string
                description: The URI reference that identifies the specific occurrence of the problem.
                example: /collections/12ece9e1-2abf-4edc-8e34-de66e74114d2/requests/%7B%7BrequestId%7D%7D
          example:
            type: https://api.postman.com/problems/unauthorized
            title: Unauthorized
            detail: An API key must be provided in the request header or query string
            status: 401
            instance: /collections/12ece9e1-2abf-4edc-8e34-de66e74114d2/requests/%7B%7BrequestId%7D%7D
    workspace403Error:
      description: Forbidden
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: forbiddenError
                  message:
                    type: string
                    description: The error message.
                    example: You do not have access to update this workspace.
          examples:
            forbiddenError:
              value:
                error:
                  name: forbiddenError
                  message: You do not have access to update this workspace.
            cannotConvertToPublicWorkspace:
              value:
                error:
                  name: cannotConvertFromPublicWorkspace
                  message: Can not convert workspaces to public workspaces for team user. First convert to team.
            cannotConvertFromPublicWorkspace:
              value:
                error:
                  name: cannotConvertFromPublicWorkspace
                  message: Can not convert workspaces from public workspaces for team user. First convert to team.
    updateWorkspaceGlobalVariables:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            description: Information about the workspace's updated global variables.
            properties:
              values:
                type: array
                description: A list of the workspace's global variables.
                items:
                  $ref: '#/components/schemas/globalVariable'
          example:
            values:
            - key: api-key
              type: secret
              value: PMAK-XXXX
              enabled: true
            - key: collection_uid
              type: default
              value: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
              enabled: true
    getWorkspaceGlobalVariables:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            description: Information about the workspace's global variables.
            properties:
              values:
                type: array
                description: A list of the workspace's global variables.
                items:
                  $ref: '#/components/schemas/globalVariable'
          example:
            values:
            - key: api-key
              type: secret
              value: PMAK-XXXX
              enabled: true
            - key: collection_uid
              type: default
              value: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
              enabled: true
    common403ErrorPermissions:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                format: uri-reference
                description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
                example: https://api.postman.com/problems/forbidden
              title:
                type: string
                description: A short summary of the problem.
                example: Resource cannot be accessed
              detail:
                type: string
                description: Information about the error.
                example: Inadequate permissions. Resource access forbidden.
              status:
                type: number
                format: http-status-code
                description: The error's HTTP status code.
                example: 403
          example:
            type: https://api.postman.com/problems/forbidden
            title: Resource cannot be accessed
            detail: Inadequate permissions. Resource access forbidden.
            status: 403
    workspace400Error:
      description: Not Found
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: instanceNotFoundError
                  message:
                    type: string
                    description: The error message.
                    example: The specified workspace does not exist.
          example:
            error:
              name: instanceNotFoundError
              message: The specified workspace does not exist.
    common500ErrorInternalServer:
      description: Internal Server Error
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                format: uri-reference
                description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
                example: https://api.postman.com/problems/internal-server-error
              title:
                type: string
                description: A short summary of the problem.
                example: Internal Sever Error
              detail:
                type: string
                description: An explanation about the problem.
                example: Internal Sever Error
              status:
                type: integer
                format: http-status-code
                description: The HTTP status code generated by the origin server.
                example: 500
          example:
            type: https://api.postman.com/problems/internal-server-error
            title: Internal Server Error
            detail: Internal Server Error
            status: 500
    workspace404ErrorNotFound:
      description: Not Found
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: workspaceNotFoundError
                  message:
                    type: string
                    description: The error message.
                    example: Workspace not found
                  statusCode:
                    type: number
                    format: http-status-code
                    description: The error's HTTP status code.
                    example: 404
          example:
            error:
              name: workspaceNotFoundError
              message: Workspace not found
              statusCode: 404
    resourceNotFound404Error:
      description: Not Found
      content:
        application/json:
          schema:
            type: object
            properties:
              type:
                type: string
                format: uri-reference
                description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
                example: https://api.postman.com/problems/not-found
              title:
                type: string
                description: A short summary of the problem.
                example: Resource not found
              detail:
                type: string
                description: Information about the error.
                example: ''
              status:
                type: number
                format: http-status-code
                description: The error's HTTP status code.
                example: 404
          example:
            type: https://api.postman.com/problems/not-found
            title: Resource not found
            detail: ''
            status: 404
    workspaceRoles400Error:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              type:
                type: string
                description: The error type.
                example: invalidParamError
              title:
                type: string
                description: A short summary of the problem.
                example: body.roles[0] should have required property 'op'
              detail:
                type: string
                description: Information about the error.
                example: ''
              status:
                type: number
                format: http-status-code
                description: The error's HTTP status code.
                example: 400
          example:
            type: invalidParamError
            title: body.roles[0] should have required property 'op'
            detail: ''
            status: 400
    common401Error:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                format: uri-reference
                description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
                example: https://api.postman.com/problems/unauthorized
              title:
                type: string
                description: A short summary of the problem.
                example: Unauthorized
              detail:
                type: string
                description: Information about the error.
                example: Unauthorized
              status:
                type: integer
                format: http-status-code
                description: The error's HTTP status code.
                example: 401
          example:
            type: https://api.postman.com/problems/unauthorized
            title: Unauthorized
            detail: Unauthorized
            status: 401
    createWorkspace:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              workspace:
                type: object
                description: Information about the created workspace.
                properties:
                  id:
                    type: string
                    description: The workspace's ID.
                    example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9
                  name:
                    type: string
                    description: The workspace's name.
                    example: Test Workspace
          example:
            workspace:
              id: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9
              name: Team Workspace
    common500ErrorServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: serverError
                  message:
                    type: string
                    description: The error message.
                    example: An error has occurred on the server.
          example:
            error:
              name: serverError
              message: An error has occurred on the server.
    unauthorizedError:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                format: uri-reference
                description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
                example: https://api.postman.com/problems/unauthorized
              title:
                type: string
                description: A short summary of the problem.
                example: Unauthorized
              detail:
                type: string
                description: Information about the error.
                example: An API key must be provided in the request header or query string
              status:
                type: number
                format: http-status-code
                description: The error's HTTP status code.
                example: 401
          example:
            type: https://api.postman.com/problems/unauthorized
            title: Unauthorized
            detail: An API key must be provided in the request header or query string
            status: 401
    updateWorkspaceRoles:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              roles:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: The role's ID.
                      example: '1'
                    user:
                      type: array
                      description: A list of user IDs assigned to the role.
                      items:
                        type: string
                        description: The user's ID or SCIM ID.
                        example: '12345678'
                    group:
                      type: array
                      description: A list of user group IDs assigned to the role.
                      items:
                        type: string
                        description: The user group's ID or SCIM ID.
                        example: 561631fq14ed41872a8eea4c8aa2b38cda9749812cc55c00
                    displayName:
                      type: string
                      description: The role's display name.
                      enum:
                      - Admin
                      - Viewer
                      - Editor
                      example: Viewer
          examples:
            Update User Role:
              $ref: '#/components/examples/userRoleUpdated'
            Update Role with SCIM ID:
              $ref: '#/components/examples/userRoleUpdatedSCIMId'
            Update Role and Group with SCIM IDs:
              $ref: '#/components/examples/userRoleGroupUpdatedSCIMId'
    getWorkspaceRoles:
      description: Successful Response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/getWorkspaceRoles'
          examples:
            Successful Response:
              $ref: '#/components/examples/workspaceRoles'
            Return SCIM IDs:
              $ref: '#/components/examples/workspaceRolesScimIds'
    workspaceRoles422UnsupportRoleError:
      description: Partner and Personal Workspace Roles Unsupported
      content:
        application/json:
          schema:
            type: object
            properties:
              detail:
                type: string
                description: Information about the error.
                example: Roles are not supported for personal and partner workspaces.
              link:
                type: string
                description: The error type.
                example: https://api.postman.com/problems/unprocessable-entity
              status:
                type: number
                format: http-status-code
                description: The error's HTTP status code.
                example: 422
              title:
                type: string
                description: A short summary of the problem.
                example: Cannot process the request.
          example:
            detail: Roles are not supported for personal and partner workspaces.
            link: https://api.postman.com/problems/unprocessable-entity
            status: 422
            title: Cannot process the request.
    updateWorkspace:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              workspace:
                type: object
                description: Information about the updated workspace.
                properties:
                  id:
                    type: string
                    description: The workspace's ID.
                    example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9
                  name:
                    type: string
                    description: The workspace's name.
                    example: Test Workspace
          example:
            workspace:
              id: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9
              name: Test Workspace
    getWorkspace:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              workspace:
                type: object
                description: Information about the workspace.
                properties:
                  id:
                    type: string
                    description: The workspace's ID.
                    example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9
                  name:
                    type: string
                    description: The workspace's name.
                    example: Team Workspace
                  type:
                    type: string
                    description: The type of workspace.
                    enum:
                    - personal
                    - team
                    - private
                    - public
                    - partner
                    example: team
                  description:
                    type: string
                    description: The workspace's description.
                    example: This is a team workspace.
                  visibility:
                    type: string
                    description: 'The workspace''s visibility. [Visibility](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#changing-workspace-visibility) determines who can access the workspace:

                      - `personal` — Only you can access the workspace.

                      - `team` — All team members can access the workspace.

                      - `private` — Only invited team members can access the workspace ([**Professional** and **Enterprise** plans only](https://www.postman.com/pricing)).

                      - `public` — Everyone can access the workspace.

                      - `partner` — Only invited team members and [partners](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/) can access the workspace ([**Professional** and **Enterprise** plans only](https://www.postman.com/pricing)).

                      '
                    enum:
                    - personal
                    - team
                    - private
                    - public
                    - partner
                    example: team
                  createdBy:
                    type: string
                    description: The user ID of the user who created the workspace.
                    example: '12345678'
                  updatedBy:
                    type: string
                    description: The user ID of the user who last updated the workspace.
                    example: '12345678'
                  createdAt:
                    type: string
                    format: date-time
                    description: The date and time at which the workspace was created.
                    example: '2022-07-06T16:18:32.000Z'
                  updatedAt:
                    type: string
                    format: date-time
                    description: The date and time at which the workspace was last updated.
                    example: '2022-07-06T20:55:13.000Z'
                  collections:
                    type: array
                    description: The workspace's collections.
                    items:
                      type: object
                      description: Information about the collection.
                      properties:
                        id:
                          type: string
                          description: The collection's ID.
                          example: 12ece9e1-2abf-4edc-8e34-de66e74114d2
                        name:
                          type: string
                          description: The collection's name.
                          example: Test Collection
                          deprecated: true
                        uid:
                          type: string
                          format: uid
                          description: The collection's unique ID.
                          example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
                          deprecated: true
                  environments:
                    type: array
                    description: The workspace's environments.
                    items:
                      type: object
                      description: Information about the environment.
                      properties:
                        id:
                          type: string
                          description: The environment's ID.
                          example: 5daabc50-8451-43f6-922d-96b403b4f28e
                        name:
                          type: string
                          description: The environment's name.
                          example: Test Environment
                          deprecated: true
                        uid:
                          type: string
                          format: uid
                          description: The environment's unique ID.
                          example: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e
                          deprecated: true
                  mocks:
                    type: array
                    description: The workspace's mock servers.
                    items:
                      type: object
                      description: Information about the mock server.
                      properties:
                        id:
                          type: string
                          description: The mock server's ID.
                          example: e3d951bf-873f-49ac-a658-b2dcb91d3289
                        name:
                          type: string
                          description: The mock server's name.
                          example: Test Mock
                          deprecated: true
                        uid:
                          type: string
                          format: uid
                          description: The mock server's unique ID.
                          example: 12345678-e3d951bf-873f-49ac-a658-b2dcb91d3289
                          deprecated: true
                        deactivated:
                          type: boolean
                          description: If true, the mock server is not active. Mock servers deactivate when a linked collection or environment is deleted.
                          example: false
                  monitors:
                    type: array
                    description: The workspace's monitors.
                    items:
                      type: object
                      description: Information about the monitor.
                      properties:
                        id:
                          type: string
                          description: The monitor's ID.
                          example: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1
                        name:
                          type: string
                          description: The monitor's name.
                          example: Test Environment
                          deprecated: true
                        uid:
                          type: string
                          format: uid
                          description: The monitor's unique ID.
                          example: 12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1
                          deprecated: true
                  apis:
                    type: array
                    description: The workspace's APIs.
                    items:
                      type: object
                      description: Information about the API.
                      properties:
                        id:
                          type: string
                          description: The API's ID.
                          example: 387c2863-6ee3-4a56-8210-225f774edade
                        name:
                          type: string
                          description: The API's name.
                          example: Test API
                          deprecated: true
                        uid:
                          type: string
                          format: uid
                          description: The API's unique ID.
                          example: 12345678-387c2863-6ee3-4a56-8210-225f774edade
                          deprecated: true
                  scim:
                    type: object
                    description: An object containing SCIM user IDs. This object only returns if you pass the `include=scim` query parameter.
                    properties:
                      createdBy:
                        type: string
                        description: The SCIM user ID of the user who created the workspace.
                        example: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99
                      updatedBy:
                        type: string
                        description: The SCIM user ID of the user who last updated the workspace.
                        example: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99
          examples:
            Successful Response:
              value:
                workspace:
                  id: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9
                  name: Team Workspace
                  type: team
                  description: This is a team workspace.
                  visibility: team
                  createdBy: '12345678'
                  updatedBy: '12345678'
                  createdAt: '2022-07-06T16:18:32.000Z'
                  updatedAt: '2022-07-06T20:55:13.000Z'
                  collections:
                  - id: 12ece9e1-2abf-4edc-8e34-de66e74114d2
                    name: Test Collection
                    uid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
                  environments:
                  - id: 5daabc50-8451-43f6-922d-96b403b4f28e
                    name: Test Environment
                    uid: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e
                  mocks:
                  - id: e3d951bf-873f-49ac-a658-b2dcb91d3289
                    name: Test Mock
                    uid: 12345678-e3d951bf-873f-49ac-a658-b2dcb91d3289
                    deactivated: false
                  monitors:
                  - id: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1
                    name: Test Monitor
                    uid: 12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1
                  apis:
                  - id: 387c2863-6ee3-4a56-8210-225f774edade
                    name: Test API
                    uid: 12345678-387c2863-6ee3-4a56-8210-225f774edade
            Include SCIM IDs:
              value:
                workspace:
                  id: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9
                  name: Team Workspace
                  type: team
                  description: This is a team workspace.
                  visibility: team
                  createdBy: '12345678'
                  updatedBy: '12345678'
                  createdAt: '2022-07-06T16:18:32.000Z'
                  updatedAt: '2022-07-06T20:55:13.000Z'
                  collections:
                  - id: 12ece9e1-2abf-4edc-8e34-de66e74114d2
                    name: Test Collection
                    uid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
                  environments:
                  - id: 5daabc50-8451-43f6-922d-96b403b4f28e
                    name: Test Environment
                    uid: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e
                  mocks:
                  - id: e3d951bf-873f-49ac-a658-b2dcb91d3289
                    name: Test Mock
                    uid: 12345678-e3d951bf-873f-49ac-a658-b2dcb91d3289
                    deactivated: false
                  monitors:
                  - id: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1
                    name: Test Monitor
                    uid: 12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1
                  apis:
                  - id: 387c2863-6ee3-4a56-8210-225f774edade
                    name: Test API
                    uid: 12345678-387c2863-6ee3-4a56-8210-225f774edade
                  scim:
                    createdBy: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99
                    updatedBy: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99
    getAllWorkspaceRoles:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              roles:
                type: object
                description: Information about the workspace's [user roles](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles).
                properties:
                  user:
                    type: array
                    description: The list of user roles in the workspace.
                    items:
                      type: object
                      description: Information about the user role.
                      properties:
                        id:
                          type: string
                          description: The role's ID.
                          example: '1'
                        description:
                          type: string
                          description: The role's description.
                          example: Can manage people and all resources
                        displayName:
                          type: string
                          description: The role's display name.
                          example: Admin
                  usergroup:
                    type: array
                    description: Information about the workspace's [user group roles](https://learning.postman.com/docs/collaborating-in-postman/user-groups/).
                    items:
                      type: object
                      description: Information about the user group in the workspace.
                      properties:
                        id:
                          type: string
                          description: The role's ID.
                          example: '1'
                        description:
                          type: string
                          description: The role's description.
                          example: Can manage people and all resources
                        displayName:
                          type: string
                          description: The role's display name.
                          example: Admin
          example:
            roles:
              user:
              - id: '3'
                displayName: Admin
                description: Can manage workspace details and members.
              - id: '1'
                displayName: Viewer
                description: Can view, fork, and export workspace resources.
              - id: '2'
                displayName: Editor
                description: Can create and edit workspace resources.
              usergroup:
              - id: '3'
                displayName: Admin
                description: Can manage workspace details and members.
              - id: '1'
                displayName: Viewer
                description: Can view, fork, and export workspace resources.
              - id: '2'
                displayName: Editor
                description: Can create and edit workspace resources.
    workspace403ErrorUnauthorized:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  status:
                    type: number
                    format: http-status-code
                    description: The error's HTTP status code.
                    example: 403
                  name:
                    type: string
                    description: The error name.
                    example: forbiddenError
                  message:
                    type: string
                    description: The error message.
                    example: You are not authorized to perform this action
                  detail:
                    type: string
                    description: Information about the error.
                    example: You do not have permission to create team workspaces.
                  instance:
                    type: string
                    description: The URI reference that identifies the specific occurrence of the problem.
                    example: ''
          example:
            error:
              status: 403
              name: forbiddenError
              message: You are not authorized to perform this action
              detail: You do not have permission to create team workspaces.
              instance: ''
  parameters:
    workspaceIncludeScimQuery:
      name: include
      in: query
      description: 'Include the following information in the endpoint''s response:

        - `scim` — Return IDs as SCIM user and group IDs.

        '
      schema:
        type: string
        example: scim
        enum:
        - scim
    workspaceId:
      name: workspaceId
      in: path
      required: true
      description: The workspace's ID.
      schema:
        $ref: '#/components/schemas/workspaceId'
    workspaceIncludeQuery:
      name: include
      in: query
      description: 'Include the following information in the endpoint''s response:

        - `mocks:deactivated` — Include all deactivated mock servers in the response.

        - `scim` — Return the SCIM user IDs of the workspace creator and who last modified it.

        '
      schema:
        type: string
        example: mocks:deactivated
        enum:
        - mocks:deactivated
        - scim
    identifierType:
      name: identifierType
      in: header
      description: Use SCIM user IDs instead of Postman user IDs.
      schema:
        type: string
        example: scim
    workspaceTypeQuery:
      name: type
      in: query
      description: The type of workspace to filter the response by.
      schema:
        type: string
        example: team
        enum:
        - personal
        - team
        - private
        - public
        - partner
    workspaceCreatedBy:
      name: createdBy
      in: query
      description: Return only workspaces created by a specific user ID. For multiple users, pass this value as a comma-separated list of user IDs. The response only returns workspaces that you have access to.
      schema:
        type: integer
        example: 12345678
  requestBodies:
    updateWorkspaceRoles:
      content:
        application/json-patch+json:
          schema:
            type: object
            properties:
              roles:
                type: array
                items:
                  type: object
                  required:
                  - op
                  - path
                  - value
                  properties:
                    op:
                      type: string
                      description: The operation to perform on the path.
                      example: add
                    path:
                      type: string
                      description: The resource to perform the action on.
                      enum:
                      - /user
                      - /usergroup
                      example: /user
                    value:
                      type: array
                      items:
                        type: object
                        required:
                        - id
                        - role
                        description: Information about the updated user or user group role.
                        properties:
                          id:
                            type: string
                            description: The user or user group ID. To use SCIM IDs for users or groups, include the `identifierType=scim` header in the request.
                            example: '12345678'
                          role:
                            type: string
                            description: 'The workspace role''s ID:

                              - `1` — Viewer. Can view, fork, and export workspace resources.

                              - `2` — Editor. Can create and edit workspace resources.

                              - `3` — Admin. Can manage workspace details and members.

                              '
                            enum:
                            - '1'
                            - '2'
                            - '3'
                            example: '1'
          examples:
            Update User Role:
              $ref: '#/components/examples/updateUserRole'
            Update Role with SCIM ID:
              $ref: '#/components/examples/updateRoleSCIMId'
            Update Role and Group with SCIM IDs:
              $ref: '#/components/examples/updateRoleGroupSCIMId'
    createWorkspace:
      content:
        application/json:
          schema:
            type: object
            properties:
              workspace:
                type: object
                description: Information about the workspace.
                required:
                - name
                - type
                properties:
                  name:
                    type: string
                    description: The workspace's name.
                    example: Team Workspace
                  type:
                    type: string
                    description: 'The type of workspace:

                      - `personal`

                      - `private` — Private workspaces are available on Postman [**Professional** and **Enterprise** plans](https://www.postman.com/pricing).

                      - `public`

                      - `team`

                      - `partner` — [Partner Workspaces](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/) are available on Postman [**Professional** and **Enterprise** plans](https://www.postman.com/pricing)).

                      '
                    enum:
                    - personal
                    - private
                    - public
                    - team
                    - partner
                    example: team
                  description:
                    type: string
                    description: The workspace's description.
                    example: This is a team workspace.
          example:
            workspace:
              name: Team Workspace
              type: team
              description: This is a team workspace.
    updateWorkspaceGlobalVariables:
      content:
        application/json:
          schema:
            type: object
            properties:
              values:
                type: array
                description: A list of the workspace's global variables.
                items:
                  $ref: '#/components/schemas/globalVariable'
          example:
            values:
            - key: api-key
              type: secret
              value: PMAK-XXXX
              enabled: true
            - key: collection_uid
              type: default
              value: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
              enabled: true
    updateWorkspace:
      content:
        application/json:
          schema:
            type: object
            properties:
              workspace:
                type: object
                properties:
                  name:
                    type: string
                    description: The workspace's new name.
                    example: Test Workspace
                  type:
                    type: string
                    description: 'The new workspace visibility [type](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#changing-workspace-visibility). This property does not support the following workspace visibility changes:

                      - `private` to `public`, `public` to `private`, and `private` to `personal` for Free and Basic [plans](https://www.postman.com/pricing/).

                      - `public` to `personal` for team users.

                      '
                    enum:
                    - private
                    - personal
                    - team
                    - public
                    example: team
                  description:
                    type: string
                    description: The new workspace description.
                    example: This is a test team workspace.
          example:
            workspace:
              name: Test Workspace
              description: This is a test team workspace.
              type: team
  examples:
    workspaceRolesScimIds:
      value:
        roles:
        - id: '3'
          displayName: Admin
          user:
          - 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99
          group:
          - 561631fq14ed41872a8eea4c8aa2b38cda9749812cc55c00
    userRoleUpdated:
      value:
        roles:
        - id: '1'
          displayName: Viewer
          user:
          - '12345678'
          group:
          - '123'
        - id: '2'
          displayName: Editor
          user:
          - '87654321'
          group:
          - '123'
        - id: '3'
          displayName: Admin
          user:
          - '13428756'
          group:
          - '132'
    updateRoleGroupSCIMId:
      value:
        roles:
        - op: add
          path: /user
          value:
          - id: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99
            role: '3'
        - op: add
          path: /usergroup
          value:
          - id: 561631fq14ed41872a8eea4c8aa2b38cda9749812cc55c00
            role: '3'
    userRoleUpdatedSCIMId:
      value:
        roles:
        - id: '1'
          displayName: Viewer
          user:
          - 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99
    userRoleGroupUpdatedSCIMId:
      value:
        roles:
        - id: '3'
          displayName: Admin
          user:
          - e982929dadd02cf627e8c111925fc37a93dbc86f510840db
          group:
          - 561631fq14ed41872a8eea4c8aa2b38cda9749812cc55c00
    updateUserRole:
      value:
        roles:
        - op: add
          path: /user
          value:
          - id: '12345678'
            role: '1'
          - id: '87654321'
            role: '2'
        - op: remove
          path: /user
          value:
          - id: '87612345'
            role: '1'
        - op: add
          path: /usergroup
          value:
          - id: '123'
            role: '2'
        - op: remove
          path: /usergroup
          value:
          - id: '312'
            role: '3'
    workspaceRoles:
      value:
        roles:
        - id: '3'
          displayName: Admin
          user:
          - '12345678'
          group:
          - '123'
    updateRoleSCIMId:
      value:
        roles:
        - op: add
          path: /user
          value:
          - id: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99
            role: '1'
  schemas:
    getWorkspaceRoles:
      title: Workspace Roles
      type: object
      description: Information about the workspace's roles.
      properties:
        roles:
          type: array
          description: A list of workspace roles and the users and groups assigned to them.
          items:
            type: object
            properties:
              id:
                type: string
                description: The role's ID.
                example: '3'
              user:
                type: array
                description: A list of user IDs assigned to the role.
                items:
                  type: string
                  description: The user's ID or SCIM ID.
                  example: '12345678'
              group:
                type: array
                description: A list of user group IDs assigned to the role.
                items:
                  type: string
                  description: The group's ID.
                  example: '123'
              displayName:
                type: string
                description: The role's display name.
                enum:
                - Admin
                - Viewer
                - Editor
                example: Viewer
    workspaceId:
      type: string
      example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9
    globalVariable:
      title: Global Variable
      type: object
      description: Information about the global variable.
      properties:
        key:
          type: string
          description: The variable's name.
          example: variableName
        type:
          type: string
          description: The [type](https://learning.postman.com/docs/sending-requests/variables/#variable-types) of variable.
          enum:
          - default
          - secret
          example: default
        value:
          type: string
          description: The variable's value.
          example: variableValue
        enabled:
          type: boolean
          description: If true, the variable is enabled.
          example: true
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/apigateway/
x-hasEquivalentPaths: true