openapi: 3.0.0
info:
  version: 2015-07-09
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Scim 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: Scim
  description: Provisioning of GitHub organization membership for SCIM-enabled providers.
paths:
  /scim/v2/enterprises/{enterprise}/Groups:
    get:
      summary: APIs.io Engineering Platform List provisioned SCIM groups for an enterprise
      description: '**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.


        Lists provisioned SCIM groups in an enterprise.


        You can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response.'
      operationId: enterprise-admin/list-provisioned-groups-enterprise
      tags:
      - Scim
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/scim#list-provisioned-scim-groups-for-an-enterprise
      parameters:
      - name: filter
        description: If specified, only results that match the specified filter will be returned. Multiple filters are not supported. Possible filters are `externalId`, `id`, and `displayName`. For example, `?filter="externalId eq '9138790-10932-109120392-12321'"`.
        in: query
        required: false
        schema:
          type: string
        examples:
          displayName:
            value: Engineering
          externalId:
            value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159
      - $ref: '#/components/parameters/excluded-attributes'
      - $ref: '#/components/parameters/start-index'
      - $ref: '#/components/parameters/count'
      - $ref: '#/components/parameters/enterprise'
      responses:
        '200':
          description: Success, either groups were found or not found
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/scim-enterprise-group-list'
              examples:
                default:
                  $ref: '#/components/examples/scim-enterprise-group-list'
        '400':
          $ref: '#/components/responses/scim_bad_request'
        '401':
          $ref: '#/components/responses/authorization_failure'
        '403':
          $ref: '#/components/responses/permission_denied'
        '429':
          $ref: '#/components/responses/scim_too_many_requests'
        '500':
          $ref: '#/components/responses/scim_internal_error'
      x-github:
        enabledForGitHubApps: true
        githubCloudOnly: true
        category: enterprise-admin
        subcategory: scim
  /scim/v2/Groups:
    get:
      summary: APIs.io Engineering Platform Get all group resources
      description: Gets information about all Postman team members.
      operationId: getScimGroupResources
      x-postman-plan: Enterprise
      tags:
      - Scim
      responses:
        '200':
          $ref: '#/components/responses/getScimGroupResources'
        '400':
          $ref: '#/components/responses/scim400ErrorInvalidFilter'
        '401':
          $ref: '#/components/responses/scim401Error'
        '403':
          $ref: '#/components/responses/scim403Error'
        '500':
          $ref: '#/components/responses/scimGroup500Error'
      parameters:
      - $ref: '#/components/parameters/startIndex'
      - $ref: '#/components/parameters/count_2'
      - $ref: '#/components/parameters/scimGroupFilter'
    post:
      summary: APIs.io Engineering Platform Create a group
      description: 'Creates a new user group in Postman and creates a new account for each group member.


        Each account is added to your Postman team and authentication is activated for each user. If an existing Postman account uses an email that matches a group member''s email ID, an [email invite](https://postman.postman.co/docs/administration/managing-your-team/managing-your-team/#invites) to join your Postman team is sent to that user. Once the user accepts the invite, they''ll be added to your team.


        By default, the system assigns new users the developer role. You can [update user roles in Postman](https://learning.postman.com/docs/administration/managing-your-team/managing-your-team/#managing-team-roles).

        '
      operationId: createScimGroup
      x-postman-plan: Enterprise
      tags:
      - Scim
      requestBody:
        $ref: '#/components/requestBodies/createScimGroup'
      responses:
        '201':
          $ref: '#/components/responses/createScimGroup'
        '400':
          $ref: '#/components/responses/scim400ErrorInvalidSyntax'
        '401':
          $ref: '#/components/responses/scim401Error'
        '403':
          $ref: '#/components/responses/scim403Error'
        '409':
          $ref: '#/components/responses/scim409Error'
        '500':
          $ref: '#/components/responses/scimUpdateGroup500Error'
  /scim/v2/Groups/{groupId}:
    parameters:
    - $ref: '#/components/parameters/scimGroupId'
    get:
      summary: APIs.io Engineering Platform Get a group resource
      description: Gets information about a Postman group within the team.
      operationId: getScimGroupResource
      x-postman-plan: Enterprise
      tags:
      - Scim
      responses:
        '200':
          $ref: '#/components/responses/getScimGroupResource'
        '400':
          $ref: '#/components/responses/scim400Error'
        '401':
          $ref: '#/components/responses/scim401Error'
        '403':
          $ref: '#/components/responses/scim403Error'
        '404':
          $ref: '#/components/responses/scimGroup404Error'
        '500':
          $ref: '#/components/responses/scim500Error'
    patch:
      summary: APIs.io Engineering Platform Update a group
      description: 'Updates a group''s information. Using this endpoint you can:


        - Update a group''s name.

        - Add or remove members from a Postman group.

        '
      operationId: scimUpdateGroup
      x-postman-plan: Enterprise
      tags:
      - Scim
      requestBody:
        $ref: '#/components/requestBodies/scimUpdateGroup'
      responses:
        '200':
          $ref: '#/components/responses/scimUpdateGroup'
        '400':
          $ref: '#/components/responses/scim400ErrorInvalidSyntax'
        '401':
          $ref: '#/components/responses/scim401Error'
        '403':
          $ref: '#/components/responses/scim403Error'
        '404':
          $ref: '#/components/responses/scimGroup404Error'
        '500':
          $ref: '#/components/responses/scim500Error'
    delete:
      summary: APIs.io Engineering Platform Delete a group
      description: 'Deletes a group in Postman. On success, this returns an HTTP `204 No Content` response.


        User accounts that were in the deleted group are deactivated in Postman if the app is assigned to the user only with the deleted group.


        User accounts and the data corresponding to them are not deleted. To permanently delete user accounts and their data, [contact Postman support](https://www.postman.com/support/).

        '
      operationId: deleteScimGroup
      x-postman-plan: Enterprise
      tags:
      - Scim
      responses:
        '204':
          description: Group Deleted
        '400':
          $ref: '#/components/responses/scim400Error'
        '401':
          $ref: '#/components/responses/scim401Error'
        '403':
          $ref: '#/components/responses/scim403Error'
        '404':
          $ref: '#/components/responses/scimGroup404Error'
        '500':
          $ref: '#/components/responses/scim500Error'
  /scim/v2/ResourceTypes:
    get:
      summary: APIs.io Engineering Platform Get resource types
      description: Gets all the resource types supported by Postman's SCIM API.
      operationId: getScimResourceTypes
      x-postman-plan: Enterprise
      tags:
      - Scim
      responses:
        '200':
          $ref: '#/components/responses/getScimResourceTypes'
        '401':
          $ref: '#/components/responses/common401Error'
        '500':
          $ref: '#/components/responses/scim500Error'
  /scim/v2/ServiceProviderConfig:
    get:
      summary: APIs.io Engineering Platform Get service provider configuration
      description: Gets the Postman SCIM API configuration information. This includes a list of supported operations.
      operationId: getScimServiceProviderConfig
      x-postman-plan: Enterprise
      tags:
      - Scim
      responses:
        '200':
          $ref: '#/components/responses/getScimServiceProviderConfig'
        '401':
          $ref: '#/components/responses/scim401Error'
        '500':
          $ref: '#/components/responses/scim500Error'
  /scim/v2/Users:
    get:
      summary: APIs.io Engineering Platform Get all user resources
      description: Gets information about all Postman team members.
      operationId: getScimUserResources
      x-postman-plan: Enterprise
      tags:
      - Scim
      responses:
        '200':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimUserResources'
              examples:
                Successful Response:
                  $ref: '#/components/examples/getScimUserResources'
                Filter Inactive Users:
                  $ref: '#/components/examples/getInactiveScimUserResources'
        '400':
          $ref: '#/components/responses/scim400Error'
        '401':
          $ref: '#/components/responses/scim401Error'
        '403':
          $ref: '#/components/responses/scim403Error'
        '500':
          $ref: '#/components/responses/scim500Error'
      parameters:
      - $ref: '#/components/parameters/startIndex'
      - $ref: '#/components/parameters/count_2'
      - $ref: '#/components/parameters/scimUserFilter'
    post:
      summary: APIs.io Engineering Platform Create a user
      description: 'Creates a new user account in Postman and adds the user to your organization''s Postman team.

        - If the account does not exist, this also activates the user so they can authenticate in to your Postman team.

        - If an account matching the email ID exists, the user receives [email invite](https://learning.postman.com/docs/administration/managing-your-team/manage-team-members/#manage-invites) to join the Postman team. The user joins the team when they accept the invite.

        - If the user''s email domain matches your team''s verified domains, the user is immediately added to the team.


        By default, the system assigns new users the developer role. You can [update user roles in Postman](https://learning.postman.com/docs/administration/managing-your-team/manage-team-members/#manage-team-roles).


        **Note:**


        Users must join the team before you can assign them to any groups.

        '
      operationId: createScimUser
      x-postman-plan: Enterprise
      tags:
      - Scim
      requestBody:
        $ref: '#/components/requestBodies/createScimUser'
      responses:
        '201':
          $ref: '#/components/responses/createScimUser'
        '400':
          $ref: '#/components/responses/scim400ErrorInvalidSyntax'
        '401':
          $ref: '#/components/responses/scim401Error'
        '403':
          $ref: '#/components/responses/scim403Error'
        '409':
          $ref: '#/components/responses/scim409Error'
        '500':
          $ref: '#/components/responses/scim500Error'
  /scim/v2/Users/{userId}:
    parameters:
    - $ref: '#/components/parameters/scimUserId'
    get:
      summary: APIs.io Engineering Platform Get a user resource
      description: Gets information about a Postman team member.
      operationId: getScimUserResource
      x-postman-plan: Enterprise
      tags:
      - Scim
      responses:
        '200':
          $ref: '#/components/responses/scimUserResource'
        '400':
          $ref: '#/components/responses/scim400Error'
        '401':
          $ref: '#/components/responses/scim401Error'
        '403':
          $ref: '#/components/responses/scim403Error'
        '404':
          $ref: '#/components/responses/scim404Error'
        '500':
          $ref: '#/components/responses/scim500ErrorUser'
    put:
      summary: APIs.io Engineering Platform Update a user
      description: 'Updates a user''s first and last name in Postman.


        **Note:**


        You can only use the SCIM API to update a user''s first and last name. You cannot update any other user attributes with the API.

        '
      operationId: updateScimUser
      x-postman-plan: Enterprise
      tags:
      - Scim
      requestBody:
        $ref: '#/components/requestBodies/updateScimUser'
      responses:
        '200':
          $ref: '#/components/responses/scimUserResource'
        '400':
          $ref: '#/components/responses/scim400ErrorInvalidSyntax'
        '401':
          $ref: '#/components/responses/scim401Error'
        '403':
          $ref: '#/components/responses/scim403Error'
        '404':
          $ref: '#/components/responses/scim404Error'
        '500':
          $ref: '#/components/responses/scim500Error'
    patch:
      summary: APIs.io Engineering Platform Update a user's state
      description: 'Updates a user''s active state in Postman.


        **Reactivating a user**


        By setting the `active` property from `false` to `true`, this reactivates an account. This allows the account to authenticate in to Postman and adds the account back on to your Postman team.

        '
      operationId: updateScimUserState
      x-postman-plan: Enterprise
      tags:
      - Scim
      requestBody:
        $ref: '#/components/requestBodies/updateScimUserState'
      responses:
        '200':
          $ref: '#/components/responses/scimUserResource'
        '400':
          $ref: '#/components/responses/scim400ErrorInvalidSyntax'
        '401':
          $ref: '#/components/responses/scim401Error'
        '403':
          $ref: '#/components/responses/scim403Error'
        '404':
          $ref: '#/components/responses/scim404Error'
        '500':
          $ref: '#/components/responses/scim500Error'
components:
  parameters:
    scimGroupFilter:
      name: filter
      in: query
      description: 'Filter results by a specific word or phrase. This query parameter only supports the `displayName` filter and has the following requirements:

        - Filter values are case-sensitive.

        - Special characters and spaces must be URL encoded.

        '
      schema:
        type: string
        example: displayName eq "Test-API"
    scimGroupId:
      name: groupId
      in: path
      required: true
      description: The group's ID.
      schema:
        $ref: '#/components/schemas/scimId'
    excluded-attributes:
      name: excludedAttributes
      description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time.
      in: query
      required: false
      schema:
        type: string
        example: members
    start-index:
      name: startIndex
      description: 'Used for pagination: the starting index of the first result to return when paginating through values.'
      in: query
      required: false
      schema:
        type: integer
        default: 1
        format: int32
        example: 1
    count:
      name: count
      description: 'Used for pagination: the number of results to return per page.'
      in: query
      required: false
      schema:
        type: integer
        default: 30
        format: int32
        example: 1
    scimUserFilter:
      name: filter
      in: query
      description: 'Filter results by a specific word or phrase. This query parameter accepts the following:

        - `userName` — Filter values are case-sensitive, and special characters and spaces must be URL encoded.

        - `active` — Return only users who are active (`true`) or inactive (`false`).

        '
      schema:
        type: string
        example: userName eq "taylor-lee%40example.com"
      examples:
        Filter:
          value: userName eq "taylor-lee%40example.com"
        Filter with Encoding:
          value: userName eq "taylor-lee%2Btest%40example.com"
        Filter Active Users:
          value: active eq "true"
        Filter Inactive Users:
          value: active eq "false"
    startIndex:
      name: startIndex
      in: query
      description: The index entry by which to begin the list of returned results.
      schema:
        type: number
        default: 1
        example: 1
    scimUserId:
      name: userId
      in: path
      required: true
      description: The user's SCIM ID.
      schema:
        $ref: '#/components/schemas/scimId'
    count_2:
      name: count
      in: query
      description: Limit the number of results returned in a single response.
      schema:
        type: number
        default: 100
        example: 2
    enterprise:
      name: enterprise
      description: The slug version of the enterprise name. You can also substitute this value with the enterprise id.
      in: path
      required: true
      schema:
        type: string
  examples:
    scim-enterprise-group-list:
      value:
        schemas:
        - urn:ietf:params:scim:api:messages:2.0:ListResponse
        totalResults: 1
        Resources:
        - schemas:
          - urn:ietf:params:scim:schemas:core:2.0:Group
          externalId: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159
          id: 927fa2c08dcb4a7fae9e
          displayName: Engineering
          members:
          - value: 879db59-3bdf-4490-ad68-ab880a2694745
            $+ref: https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745
            displayName: User 1
          - value: 0db508eb-91e2-46e4-809c-30dcbda0c685
            $+ref: https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685
            displayName: User 2
          meta:
            resourceType: Group
            created: '2012-03-27T19:59:26.000Z'
            lastModified: '2018-03-27T19:59:26.000Z'
            location: https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e
        startIndex: 1
        itemsPerPage: 20
    getInactiveScimUserResources:
      value:
        schemas:
        - urn:ietf:params:scim:api:messages:2.0:ListResponse
        totalResults: 1
        startIndex: 1
        itemsPerPage: 2
        Resources:
        - schemas:
          - urn:ietf:params:scim:schemas:core:2.0:User
          id: 123775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99
          userName: alex.cruz@example.com
          name:
            givenName: Alex
            familyName: Cruz
          externalId: '87654321'
          active: false
          meta:
            resourceType: User
            created: '2021-02-22T04:24:13.000Z'
            lastModified: '2021-02-22T04:24:13.000Z'
    getScimUserResources:
      value:
        schemas:
        - urn:ietf:params:scim:api:messages:2.0:ListResponse
        totalResults: 2
        startIndex: 1
        itemsPerPage: 2
        Resources:
        - schemas:
          - urn:ietf:params:scim:schemas:core:2.0:User
          id: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99
          userName: taylor.lee@example.com
          name:
            givenName: Taylor
            familyName: Lee
          externalId: '12345678'
          active: true
          meta:
            resourceType: User
            created: '2021-02-22T04:24:13.000Z'
            lastModified: '2021-02-22T04:24:13.000Z'
        - schemas:
          - urn:ietf:params:scim:schemas:core:2.0:User
          id: 123775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99
          userName: alex.cruz@example.com
          name:
            givenName: Alex
            familyName: Cruz
          externalId: '87654321'
          active: false
          meta:
            resourceType: User
            created: '2021-02-22T04:24:13.000Z'
            lastModified: '2021-02-22T04:24:13.000Z'
  responses:
    scim_bad_request:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/scim-error'
        application/scim+json:
          schema:
            $ref: '#/components/schemas/scim-error'
    getScimGroupResource:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              schemas:
                type: array
                description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
                items:
                  type: string
                  example: urn:ietf:params:scim:schemas:core:2.0:Group
              id:
                type: string
                description: The group's SCIM ID.
                example: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99
              userName:
                type: string
                description: The group's display name.
                example: Test-API
              members:
                type: array
                description: Information about the group's members.
                items:
                  type: object
                  properties:
                    value:
                      type: string
                      description: The member's SCIM ID.
                      example: 23a35c2723d34c03b4c56443c09e7173
                    display:
                      type: string
                      description: The member's display name.
                      example: Taylor Lee
              externalId:
                type: string
                description: The group's external ID.
                example: '1234'
              meta:
                type: object
                description: The response's non-standard meta information.
                properties:
                  resourceType:
                    type: string
                    description: The resource type.
                    example: Group
                  created:
                    type: string
                    format: date-time
                    description: The date and time at which the group was created.
                    example: '2022-02-22T04:24:13.000Z'
                  lastModified:
                    type: string
                    format: date-time
                    description: The date and time at which the group was last modified.
                    example: '2022-02-22T04:24:13.000Z'
          example:
            schemas:
            - urn:ietf:params:scim:schemas:core:2.0:Group
            id: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99
            displayName: Test-API
            members:
            - value: 23a35c2723d34c03b4c56443c09e7173
              display: Taylor Lee
            externalId: '1234'
            meta:
              resourceType: Group
              created: '2022-02-22T04:24:13.000Z'
              lastModified: '2022-02-22T04:24:13.000Z'
    scimUserResource:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              schemas:
                type: array
                description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
                items:
                  type: string
                  example: urn:ietf:params:scim:schemas:core:2.0:User
              id:
                type: string
                description: The team member's SCIM ID.
                example: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99
              userName:
                type: string
                description: The team member's SCIM username.
                example: taylor.lee@example.com
              name:
                type: object
                description: Information about the Postman team member.
                properties:
                  givenName:
                    type: string
                    description: The team member's first name.
                    example: Taylor
                  familyName:
                    type: string
                    description: The team member's last name.
                    example: Lee
              externalId:
                type: string
                description: The team member's external ID.
                example: '12345678'
              active:
                type: boolean
                description: If true, the team member is active.
                example: true
              meta:
                type: object
                description: The response's non-standard meta information.
                properties:
                  resourceType:
                    type: string
                    description: The resource type.
                    example: User
                  created:
                    type: string
                    format: date-time
                    description: The date and time at which the team member was created.
                    example: '2021-02-22T04:24:13.000Z'
                  lastModified:
                    type: string
                    format: date-time
                    description: The date and time at which the team member was last modified.
                    example: '2021-02-22T04:24:13.000Z'
          example:
            schemas:
            - urn:ietf:params:scim:schemas:core:2.0:User
            id: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99
            userName: taylor.lee@example.com
            name:
              givenName: Taylor
              familyName: Lee
            externalId: '12345678'
            active: true
            meta:
              resourceType: User
              created: '2021-02-22T04:24:13.000Z'
              lastModified: '2021-02-22T04:24:13.000Z'
    scim400Error:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              schemas:
                type: array
                description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
                items:
                  type: string
                  example: urn:ietf:params:scim:api:messages:2.0:Error
              detail:
                type: string
                description: Information about the error.
                example: This Postman team doesn't exist anymore.
              status:
                type: string
                format: http-status-code
                description: The HTTP status code.
                example: '400'
          example:
            schemas:
            - urn:ietf:params:scim:api:messages:2.0:Error
            detail: This Postman team doesn't exist anymore.
            status: '400'
    scim500Error:
      description: Internal Server Error
      content:
        application/json:
          schema:
            type: object
            properties:
              schemas:
                type: array
                description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
                items:
                  type: string
                  example: urn:ietf:params:scim:api:messages:2.0:Error
              detail:
                type: string
                description: Information about the error.
                example: Couldn't update this team member's information. Try again — it should work next time around.
              status:
                type: string
                format: http-status-code
                description: The HTTP status code.
                example: '500'
          example:
            schemas:
            - urn:ietf:params:scim:api:messages:2.0:Error
            detail: Couldn't update this team member's information. Try again — it should work next time around.
            status: '500'
    scimUpdateGroup:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              schemas:
                type: array
                description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
                items:
                  type: string
                  example: urn:ietf:params:scim:api:messages:2.0:PatchOp
              id:
                type: string
                description: The group's ID.
                example: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99
              displayName:
                type: string
                description: The group's name.
                example: Test-API
              externalId:
                type: string
                description: The group's external ID.
                example: '1234'
              meta:
                type: object
                description: The response's non-standard meta information.
                properties:
                  resourceType:
                    type: string
                    description: The resource type.
                    example: Group
                  created:
                    type: string
                    format: date-time
                    description: The date and time at which the group was created.
                    example: '2022-02-22T04:24:13.000Z'
                  lastModified:
                    type: string
                    format: date-time
                    description: The date and time at which the group was last modified.
                    example: '2022-02-22T04:24:13.000Z'
          example:
            schemas:
            - urn:ietf:params:scim:schemas:core:2.0:Group
            id: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99
            displayName: Test-API
            members:
            - value: 23a35c2723d34c03b4c56443c09e7173
              display: Taylor Lee
            externalId: '1234'
            meta:
              resourceType: Group
              created: '2022-02-22T04:24:13.000Z'
              lastModified: '2022-02-22T04:24:13.000Z'
    createScimUser:
      description: Created
      content:
        application/json:
          schema:
            type: object
            properties:
              schemas:
                type: array
                description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
                items:
                  type: string
                  example: urn:ietf:params:scim:schemas:core:2.0:User
              id:
                type: string
                description: The user's SCIM ID.
                example: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99
              userName:
                type: string
                format: email
                description: The user's username.
                example: taylor.lee@example.com
              name:
                type: object
                properties:
                  givenName:
                    type: string
                    description: The user's first name.
                    example: Taylor
                  familyName:
                    type: string
                    description: The user's last name.
                    example: Lee
              externalId:
                type: string
                description: The user's external ID.
                example: '12345678'
              active:
                type: boolean
                description: If true, the user is active.
                example: true
              meta:
                type: object
                description: The response's non-standard meta information.
                properties:
                  created:
                    type: string
                    format: date-time
                    description: The date and time at which the user was created.
                    example: '2021-02-22T04:24:13.000Z'
                  lastModified:
                    type: string
                    format: date-time
                    description: The date and time at which the user was last modified.
                    example: '2021-02-22T04:24:13.000Z'
                  resourceType:
                    type: string
                    description: The SCIM resource type.
                    enum:
                    - User
                    example: User
          example:
            schemas:
            - urn:ietf:params:scim:schemas:core:2.0:User
            id: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99
            userName: taylor.lee@example.com
            name:
              givenName: Test
              familyName: User
            externalId: '12345678'
            active: true
            meta:
              resourceType: User
              created: '2021-02-22T04:24:13.000Z'
              lastModified: '2021-02-22T04:24:13.000Z'
    scim500ErrorUser:
      description: Internal Server Error
      content:
        application/json:
          schema:
            type: object
            properties:
              schemas:
                type: array
                description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
                items:
                  type: string
                  example: urn:ietf:params:scim:api:messages:2.0:Error
              detail:
                type: string
                description: Information about the error.
                example: Unable to fetch information about this team member.
              status:
                type: string
                format: http-status-code
                description: The HTTP status code.
                example: '500'
          example:
            schemas:
            - urn:ietf:params:scim:api:messages:2.0:Error
            detail: Unable to fetch information about this team member.
            status: '500'
    scimGroup404Error:
      description: Not Found
      content:
        application/json:
          schema:
            type: object
            properties:
              schemas:
                type: array
                description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
                items:
                  type: string
                  example: urn:ietf:params:scim:api:messages:2.0:Error
              detail:
                type: string
                description: Information about the error.
                example: This group isn't a member of the team.
              status:
                type: string
                format: http-status-code
                description: The HTTP status code.
                example: '404'
          example:
            schemas:
            - urn:ietf:params:scim:api:messages:2.0:Error
            detail: This group isn't a member of the team.
            status: '404'
    scim_too_many_requests:
      description: Too many requests
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/scim-error'
        application/scim+json:
          schema:
            $ref: '#/components/schemas/scim-error'
    createScimGroup:
      description: Created
      content:
        application/json:
          schema:
            type: object
            properties:
              schemas:
                type: array
                description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
                items:
                  type: string
                  example: urn:ietf:params:scim:schemas:core:2.0:Group
              id:
                type: string
                description: The group's SCIM ID.
                example: 561631fq14ed41872a8eea4c8aa2b38cda9749812cc55c00
              displayName:
                type: string
                description: The group's display name.
                example: Test-API
              externalId:
                type: string
                description: The group's external ID.
                example: '1234'
              members:
                type: array
                items:
                  type: object
                  description: An object containing the group's assigned SCIM members.
                  properties:
                    value:
                      type: string
                      description: The user's SCIM ID.
                      example: 23a35c2723d34c03b4c56443c09e7173
                    display:
                      type: string
                      description: The user's display name.
                      example: Taylor Lee
              meta:
                type: object
                description: The response's non-standard meta information.
                properties:
                  created:
                    type: string
                    format: date-time
                    description: The date and time at which the group was created.
                    example: '2021-02-22T04:24:13.000Z'
                  lastModified:
                    type: string
                    format: date-time
                    description: The date and time at which the group was last modified.
                    example: '2021-02-22T04:24:13.000Z'
                  resourceType:
                    type: string
                    description: The SCIM resource type.
                    example: Group
          example:
            schemas:
            - urn:ietf:params:scim:schemas:core:2.0:Group
            id: 561631fq14ed41872a8eea4c8aa2b38cda9749812cc55c00
            displayName: Test-API
            externalId: '1234'
            members:
            - value: 23a35c2723d34c03b4c56443c09e7173
              display: Taylor Lee
            meta:
              created: '2022-02-22T04:24:13.000Z'
              lastModified: '2022-02-22T04:24:13.000Z'
              resourceType: Group
    getScimServiceProviderConfig:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            description: Information about Postman's SCIM API configurations and supported operations.
            properties:
              schemas:
                type: array
                description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
                items:
                  type: string
                  example: urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig
              documentationUri:
                type: string
                format: url
                description: A link to the URI's documentation.
                example: https://learning.postman.com/docs/administration/managing-your-team/configuring-scim
              patch:
                type: object
                description: Information about patch configuration.
                properties:
                  supported:
                    type: boolean
                    description: If true, the feature is supported.
                    example: true
              bulk:
                type: object
                description: Information about bulk configuration.
                properties:
                  maxOperations:
                    type: number
                    description: The total number of maximum operations allowed for bulk operations.
                    example: 0
                  maxPayloadSize:
                    type: number
                    description: The maximum payload allowed for bulk operations.
                    example: 0
                  supported:
                    type: boolean
                    description: If true, the feature is supported.
                    example: false
              filter:
                type: object
                description: Information about the filter configuration.
                properties:
                  maxResults:
                    type: number
                    description: The total number of maximum results allowed for filter operations.
                    example: 100
                  supported:
                    type: boolean
                    description: If true, the feature is supported.
                    example: true
              changePassword:
                type: object
                description: Information about the change password configuration.
                properties:
                  supported:
                    type: boolean
                    description: If true, the feature is supported.
                    example: false
              sort:
                type: object
                description: Information about the sort configuration.
                properties:
                  supported:
                    type: boolean
                    description: If true, the feature is supported.
                    example: false
              authenticationSchemes:
                type: array
                description: A list of authentication schemes.
                items:
                  type: object
                  description: Information about the scheme.
                  properties:
                    description:
                      type: string
                      description: The scheme's description.
                      example: Authentication scheme using the OAuth Bearer Token Standard
                    name:
                      type: string
                      description: The scheme's friendly name.
                      example: OAuth Bearer Token
                    specUri:
                      type: string
                      format: url
                      description: A link to the scheme's specification documentation.
                      example: http://www.rfc-editor.org/info/rfc6750
                    type:
                      type: string
                      description: The scheme's type.
                      example: oauthbearertoken
              etag:
                type: object
                description: Information about the [entity tag](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) (Etag) HTTP response header configuration.
                properties:
                  supported:
                    type: boolean
                    description: If true, the feature is supported.
                    example: false
              meta:
                type: object
                description: The response's non-standard meta information.
                properties:
                  resourceType:
                    type: string
                    example: ServiceProviderConfig
                  location:
                    type: string
                    format: url
                    example: https://api.getpostman.com/scim/v2/ServiceProviderConfig
          example:
            schemas:
            - urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig
            documentationUri: https://learning.postman.com/docs/administration/managing-your-team/configuring-scim
            patch:
              supported: true
            bulk:
              supported: false
              maxOperations: 0
              maxPayloadSize: 0
            filter:
              supported: true
              maxResults: 100
            changePassword:
              supported: false
            sort:
              supported: false
            etag:
              supported: false
            authenticationSchemes:
            - name: OAuth Bearer Token
              description: Authentication scheme using the OAuth Bearer Token Standard
              specUri: http://www.rfc-editor.org/info/rfc6750
              type: oauthbearertoken
            meta:
              resourceType: ServiceProviderConfig
              location: https://api.getpostman.com/scim/v2/ServiceProviderConfig
    scim401Error:
      description: Unauthorized
      content:
        application/json:
          schema:
            type: object
            properties:
              schemas:
                type: array
                description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
                items:
                  type: string
                  example: urn:ietf:params:scim:api:messages:2.0:Error
              detail:
                type: string
                description: Information about the error.
                example: Unable to access the team. Check if you have entered a valid API key.
              status:
                type: string
                format: http-status-code
                description: The HTTP status code.
                example: '401'
          example:
            schemas:
            - urn:ietf:params:scim:api:messages:2.0:Error
            detail: Unable to access the team. Check if you have entered a valid API key.
            status: '401'
    scim_internal_error:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/scim-error'
        application/scim+json:
          schema:
            $ref: '#/components/schemas/scim-error'
    scim403Error:
      description: Forbidden
      content:
        application/json:
          schema:
            type: object
            properties:
              schemas:
                type: array
                description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
                items:
                  type: string
                  example: urn:ietf:params:scim:api:messages:2.0:Error
              detail:
                type: string
                description: Information about the error.
                example: Your API key was generated by a Team Admin who is no longer on your team. Use an API key generated by a Team Admin.
              status:
                type: string
                format: http-status-code
                description: The HTTP status code.
                example: '403'
          example:
            schemas:
            - urn:ietf:params:scim:api:messages:2.0:Error
            detail: Your API key was generated by a Team Admin who is no longer on your team. Use an API key generated by a Team Admin.
            status: '403'
    getScimGroupResources:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              Resources:
                type: array
                description: A list of group resources.
                items:
                  $ref: '#/components/schemas/scimGroupResource'
              itemsPerPage:
                type: number
                description: The number of items per response page.
                example: 2
              schemas:
                type: array
                items:
                  type: string
                  description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
                  example: urn:ietf:params:scim:api:messages:2.0:ListResponse
              startIndex:
                type: number
                description: The index entry by which the returned results begin.
                example: 1
              totalResults:
                type: number
                description: The total number of results found.
                example: 2
          example:
            schemas:
            - urn:ietf:params:scim:api:messages:2.0:ListResponse
            totalResults: 2
            startIndex: 1
            itemsPerPage: 2
            Resources:
            - schemas:
              - urn:ietf:params:scim:schemas:core:2.0:Group
              id: 561631fq14ed41872a8eea4c8aa2b38cda9749812cc55c00
              displayName: Test-API
              members:
              - value: 23a35c2723d34c03b4c56443c09e7173
                display: Taylor Lee
              externalId: '1234'
              meta:
                resourceType: Group
                created: '2022-02-22T04:24:13.000Z'
                lastModified: '2022-02-22T04:24:13.000Z'
            - schemas:
              - urn:ietf:params:scim:schemas:core:2.0:Group
              id: 123775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99
              displayName: Test Group
              members:
              - value: 23a35c2723d34c03b4c56443c09e7173
                display: Taylor Lee
              - value: b1c794f24f4c49f4b5d503a4cb2686ea
                display: Alex Cruz
              externalId: '4321'
              meta:
                resourceType: Group
                created: '2022-02-22T04:24:13.000Z'
                lastModified: '2022-02-22T04:24:13.000Z'
    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
    permission_denied:
      description: Permission denied
    scim404Error:
      description: Not Found
      content:
        application/json:
          schema:
            type: object
            properties:
              schemas:
                type: array
                description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
                items:
                  type: string
                  example: urn:ietf:params:scim:api:messages:2.0:Error
              detail:
                type: string
                description: Information about the error.
                example: This person isn't a member of the team.
              status:
                type: string
                format: http-status-code
                description: The HTTP status code.
                example: '404'
          example:
            schemas:
            - urn:ietf:params:scim:api:messages:2.0:Error
            detail: This person isn't a member of the team.
            status: '404'
    getScimResourceTypes:
      description: Successful Response
      content:
        application/json:
          schema:
            type: array
            items:
              type: object
              properties:
                schemas:
                  type: array
                  description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
                  items:
                    type: string
                    example: urn:ietf:params:scim:schemas:core:2.0:ResourceType
                id:
                  type: string
                  description: The resource's ID.
                  example: User
                name:
                  type: string
                  description: The resource's friendly name.
                  example: User
                endpoint:
                  type: string
                  description: The resource's endpoint.
                  example: /Users
                description:
                  type: string
                  description: The resource's description.
                  example: User Account
                schema:
                  type: string
                  description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
                  example: urn:ietf:params:scim:schemas:core:2.0:User
                schemaExtensions:
                  type: array
                  description: Information about the resource's schema extensions.
                  items:
                    type: object
                    properties:
                      schema:
                        type: string
                        description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
                        example: urn:ietf:params:scim:schemas:extension:enterprise:2.0:User
                      required:
                        type: boolean
                        description: If true, the resource must include this schema extension.
                        example: true
          example:
          - schemas:
            - urn:ietf:params:scim:schemas:core:2.0:ResourceType
            id: User
            name: User
            endpoint: /Users
            description: User Account
            schema: urn:ietf:params:scim:schemas:core:2.0:User
            schemaExtensions:
            - schema: urn:ietf:params:scim:schemas:extension:enterprise:2.0:User
              required: true
          - schemas:
            - urn:ietf:params:scim:schemas:core:2.0:ResourceType
            id: Group
            name: Group
            endpoint: /Groups
            description: Group
            schema: urn:ietf:params:scim:schemas:core:2.0:Group
    authorization_failure:
      description: Authorization failure
    scimUpdateGroup500Error:
      description: Internal Server Error
      content:
        application/json:
          schema:
            type: object
            properties:
              schemas:
                type: array
                description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
                items:
                  type: string
                  example: urn:ietf:params:scim:api:messages:2.0:Error
              detail:
                type: string
                description: Information about the error.
                example: Couldn't update this team member's information. Try again — it should work next time around.
              status:
                type: string
                format: http-status-code
                description: The HTTP status code.
                example: '500'
          example:
            schemas:
            - urn:ietf:params:scim:api:messages:2.0:Error
            detail: Couldn't update this team member's information. Try again — it should work next time around.
            status: '500'
    scim400ErrorInvalidFilter:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              schemas:
                type: array
                description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
                items:
                  type: string
                  example: urn:ietf:params:scim:api:messages:2.0:Error
              detail:
                type: string
                description: Information about the error.
                example: You've used filter(s) that Postman doesn't support.
              status:
                type: string
                format: http-status-code
                description: The HTTP status code.
                example: '400'
          example:
            schemas:
            - urn:ietf:params:scim:api:messages:2.0:Error
            detail: You've used filter(s) that Postman doesn't support.
            status: '400'
    scim409Error:
      description: Conflict
      content:
        application/json:
          schema:
            type: object
            properties:
              schemas:
                type: array
                description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
                items:
                  type: string
                  example: urn:ietf:params:scim:api:messages:2.0:Error
              scimType:
                type: string
                description: The SCIM error type.
                example: uniqueness
              detail:
                type: string
                description: Information about the error.
                example: This person is already a member of the team.
              status:
                type: string
                format: http-status-code
                description: The HTTP status code.
                example: '409'
          example:
            schemas:
            - urn:ietf:params:scim:api:messages:2.0:Error
            scimType: uniqueness
            detail: This person is already a member of the team.
            status: '409'
    scim400ErrorInvalidSyntax:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              schemas:
                type: array
                description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
                items:
                  type: string
                  example: urn:ietf:params:scim:api:messages:2.0:Error
              scimType:
                type: string
                description: The SCIM error type.
                example: invalidSyntax
              detail:
                type: string
                description: Information about the error.
                example: The request body seems to be incomplete or have unsupported characters.
              status:
                type: string
                format: http-status-code
                description: The HTTP status code.
                example: '400'
          example:
            schemas:
            - urn:ietf:params:scim:api:messages:2.0:Error
            scimType: invalidSyntax
            detail: The request body seems to be incomplete or have unsupported characters.
            status: '400'
    scimGroup500Error:
      description: Internal Server Error
      content:
        application/json:
          schema:
            type: object
            properties:
              schemas:
                type: array
                description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
                items:
                  type: string
                  example: urn:ietf:params:scim:api:messages:2.0:Error
              detail:
                type: string
                description: Information about the error.
                example: Couldn't fetch members of the team.
              status:
                type: string
                format: http-status-code
                description: The HTTP status code.
                example: '500'
          example:
            schemas:
            - urn:ietf:params:scim:api:messages:2.0:Error
            detail: Couldn't fetch members of the team.
            status: '500'
  schemas:
    scimGroupResource:
      title: SCIM Group Resource
      description: The SCIM group resource object.
      type: object
      properties:
        schemas:
          type: array
          description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
          items:
            type: string
            example: urn:ietf:params:scim:schemas:core:2.0:Group
        id:
          type: string
          description: The group's SCIM ID.
          example: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99
        displayName:
          type: string
          description: The group's display name.
          example: Test SCIMv2
        members:
          type: array
          description: A list of the group's members.
          items:
            type: object
            description: Information about the group's members.
            properties:
              value:
                type: string
                description: The resource value.
                example: 23a35c2723d34c03b4c56443c09e7173
              display:
                type: string
                description: The resource's display name.
                example: taylor.lee@example.com
        externalId:
          type: string
          description: The group's external ID.
          example: '1234'
        meta:
          type: object
          description: The response's non-standard meta information.
          properties:
            resourceType:
              type: string
              description: The resource type.
              example: Group
            created:
              type: string
              format: date-time
              description: The date and time at which the group was created.
              example: '2022-02-22T04:24:13.000Z'
            lastModified:
              type: string
              format: date-time
              description: The date and time at which the group was last modified.
              example: '2022-02-22T04:24:13.000Z'
    scim-enterprise-group-response:
      allOf:
      - $ref: '#/components/schemas/group-response'
      - type: object
        properties:
          id:
            type: string
            description: The internally generated id for the group object.
            example: 7fce0092-d52e-4f76-b727-3955bd72c939
          members:
            type: array
            items:
              type: object
              properties:
                value:
                  type: string
                $ref:
                  type: string
                display:
                  type: string
            description: The security group members.
            example:
            - value: 879db59-3bdf-4490-ad68-ab880a2694745
              $+ref: https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745
              displayName: User 1
            - value: 0db508eb-91e2-46e4-809c-30dcbda0c685
              $+ref: https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685
              displayName: User 2
          meta:
            $ref: '#/components/schemas/meta'
    scimId:
      type: string
      example: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99
    scimUserResources:
      title: SCIM Users
      type: object
      properties:
        Resources:
          type: array
          description: A list of user resources.
          items:
            $ref: '#/components/schemas/scimUserResource'
        itemsPerPage:
          type: number
          description: The number of items per response page.
          example: 2
        schemas:
          type: array
          items:
            type: string
            description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
            example: urn:ietf:params:scim:api:messages:2.0:ListResponse
        startIndex:
          type: number
          description: The index entry by which the returned results begin.
          example: 1
        totalResults:
          type: number
          description: The total number of results found.
          example: 1000
    scim-error:
      title: Scim Error
      description: Scim Error
      type: object
      properties:
        message:
          type: string
          nullable: true
        documentation_url:
          type: string
          nullable: true
        detail:
          type: string
          nullable: true
        status:
          type: integer
        scimType:
          type: string
          nullable: true
        schemas:
          type: array
          items:
            type: string
    meta:
      type: object
      description: The metadata associated with the creation/updates to the user.
      required:
      - resourceType
      properties:
        resourceType:
          type: string
          description: A type of a resource
          enum:
          - User
          - Group
          example: User
        created:
          type: string
          description: A date and time when the user was created.
          example: '2022-03-27T19:59:26.000Z'
        lastModified:
          type: string
          description: A data and time when the user was last modified.
          example: '2022-03-27T19:59:26.000Z'
        location:
          type: string
          description: A URL location of an object
    scimUserResource:
      title: SCIM User Resource
      description: The SCIM user resource object.
      type: object
      properties:
        schemas:
          type: array
          description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
          items:
            type: string
            example: urn:ietf:params:scim:schemas:core:2.0:User
        id:
          type: string
          description: The team member's SCIM ID.
          example: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99
        userName:
          type: string
          description: The team member's SCIM username.
          example: taylor.lee@example.com
        name:
          type: object
          description: Information about the Postman team member.
          properties:
            givenName:
              type: string
              description: The team member's first name.
              example: Taylor
            familyName:
              type: string
              description: The team member's last name.
              example: Lee
        externalId:
          type: string
          description: The team member's external ID.
          example: '12345678'
        active:
          type: boolean
          description: If true, the team member is active.
          example: true
        meta:
          type: object
          description: The response's non-standard meta information.
          properties:
            resourceType:
              type: string
              description: The resource type.
              example: User
            created:
              type: string
              format: date-time
              description: The date and time at which the team member was created.
              example: '2021-02-22T04:24:13.000Z'
            lastModified:
              type: string
              format: date-time
              description: The date and time at which the team member was last modified.
              example: '2021-02-22T04:24:13.000Z'
    scim-enterprise-group-list:
      type: object
      required:
      - schemas
      - totalResults
      - Resources
      - startIndex
      - itemsPerPage
      properties:
        schemas:
          type: array
          description: The URIs that are used to indicate the namespaces of the list SCIM schemas.
          items:
            type: string
            enum:
            - urn:ietf:params:scim:api:messages:2.0:ListResponse
          example:
          - urn:ietf:params:scim:api:messages:2.0:ListResponse
        totalResults:
          type: integer
          description: Number of results found
          example: 1
        Resources:
          type: array
          description: Information about each provisioned group.
          items:
            $ref: '#/components/schemas/scim-enterprise-group-response'
        startIndex:
          type: integer
          description: A starting index for the returned page
          example: 1
        itemsPerPage:
          type: integer
          description: Number of objects per page
          example: 20
    group-response:
      type: object
      required:
      - schemas
      properties:
        schemas:
          type: array
          description: The URIs that are used to indicate the namespaces of the SCIM schemas.
          items:
            type: string
            enum:
            - urn:ietf:params:scim:schemas:core:2.0:Group
            - urn:ietf:params:scim:api:messages:2.0:ListResponse
          example:
          - urn:ietf:params:scim:schemas:core:2.0:Group
        externalId:
          type: string
          description: A unique identifier for the resource as defined by the provisioning client.
          example: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159
          nullable: true
        displayName:
          type: string
          description: A human-readable name for a security group.
          example: Engineering
          nullable: true
        members:
          type: array
          description: The group members.
          items:
            type: object
            required:
            - value
            - $ref
            properties:
              value:
                type: string
                description: The local unique identifier for the member
                example: 23a35c27-23d3-4c03-b4c5-6443c09e7173
              $ref:
                type: string
              display:
                type: string
                description: The display name associated with the member
                example: Monalisa Octocat
  requestBodies:
    scimUpdateGroup:
      content:
        application/json:
          schema:
            type: object
            properties:
              schemas:
                type: array
                description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
                items:
                  type: string
                  example: urn:ietf:params:scim:api:messages:2.0:PatchOp
              Operations:
                type: array
                description: Information about the group update operation.
                items:
                  type: object
                  properties:
                    op:
                      type: string
                      description: The operation to perform.
                      enum:
                      - replace
                      - remove
                      - add
                      example: replace
                    path:
                      type: string
                      description: The operation's path. Include this value when you update a group's members.
                      example: members
                    value:
                      type: object
                      description: The performed operation's value.
                      properties:
                        id:
                          type: string
                          description: The group's ID.
                          example: 561631fq14ed41872a8eea4c8aa2b38cda9749812cc55c00
                        displayName:
                          type: string
                          description: The group's name.
                          example: Test-API
          example:
            schemas:
            - urn:ietf:params:scim:api:messages:2.0:PatchOp
            Operations:
            - op: replace
              value:
                id: 561631fq14ed41872a8eea4c8aa2b38cda9749812cc55c00
                displayName: Test-API
    updateScimUser:
      content:
        application/json:
          schema:
            type: object
            properties:
              schemas:
                type: array
                description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
                items:
                  type: string
                  example: urn:ietf:params:scim:schemas:core:2.0:User
              name:
                type: object
                description: Information about the user's name.
                properties:
                  givenName:
                    type: string
                    description: The user's first name.
                    example: Taylor
                  familyName:
                    type: string
                    description: The user's last name.
                    example: Lee
          example:
            schemas:
            - urn:ietf:params:scim:schemas:core:2.0:User
            name:
              givenName: Taylor
              familyName: Lee
    updateScimUserState:
      content:
        application/json:
          schema:
            type: object
            properties:
              schemas:
                type: array
                description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
                items:
                  type: string
                  example: urn:ietf:params:scim:api:messages:2.0:PatchOp
              Operations:
                type: array
                description: Information about the user update operation.
                items:
                  type: object
                  properties:
                    op:
                      type: string
                      description: The operation to perform.
                      enum:
                      - replace
                      example: replace
                    value:
                      type: object
                      description: The performed operation's value.
                      properties:
                        active:
                          type: boolean
                          description: 'Sets the user''s `active` state:

                            - `true` — Activates the user. This lets them authenticate in to your Postman team.

                            - `false` — Removes the user from your Postman team and deactivates the account. This blocks the user from authenticating in to Postman.

                            '
                          example: true
          example:
            schemas:
            - urn:ietf:params:scim:api:messages:2.0:PatchOp
            Operations:
            - op: replace
              value:
                active: true
    createScimGroup:
      content:
        application/json:
          schema:
            type: object
            properties:
              schemas:
                type: array
                description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
                items:
                  type: string
                  example: urn:ietf:params:scim:schemas:core:2.0:Group
              displayName:
                type: string
                description: The group's display name.
                example: Test-API
              members:
                type: array
                items:
                  type: object
                  description: An object containing the SCIM users to assign to the group.
                  properties:
                    value:
                      type: string
                      description: The user's SCIM ID.
                      example: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99
                    display:
                      type: string
                      description: The user's display name.
                      example: Taylor Lee
          example:
            schemas:
            - urn:ietf:params:scim:schemas:core:2.0:Group
            displayName: Test-API
            members:
            - value: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99
              displayName: Taylor Lee
    createScimUser:
      content:
        application/json:
          schema:
            type: object
            properties:
              schemas:
                type: array
                description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
                items:
                  type: string
                  example: urn:ietf:params:scim:schemas:core:2.0:User
              userName:
                type: string
                description: The user's username.
                example: taylor.lee@example.com
              active:
                type: boolean
                description: If true, activates the user. This lets them authenticate in to your Postman team.
                example: true
              externalId:
                type: string
                description: The user's external ID.
                example: '12345678'
              groups:
                type: array
                description: A list of groups to assign the user to.
                items:
                  type: string
                  example: Test Group
              locale:
                type: string
                description: The user's [IETF language tag](https://datatracker.ietf.org/doc/html/rfc5646).
                example: en-US
              name:
                type: object
                description: Information about the user's name.
                properties:
                  givenName:
                    type: string
                    description: The user's first name.
                    example: Taylor
                  familyName:
                    type: string
                    description: The user's last name.
                    example: Lee
          example:
            schemas:
            - urn:ietf:params:scim:schemas:core:2.0:User
            userName: taylor.lee@example.com
            name:
              givenName: Taylor
              familyName: Lee
            displayName: Taylor Lee
            locale: en-US
            groups:
            - Test Group
            active: 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