APIs.io Engineering Platform User Provisioning API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 User Provisioning 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
    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: User Provisioning
  description: "The **User Provisioning** endpoints enable you to provision and manage your Postman users.\n\n- You can only deactivate users with the SCIM API. You cannot permanently delete users with the API.\n- Users created with the SCIM API are automatically created in Postman:\n  - If the account's email ID does not exist, the user is also added to their organization's Postman team.\n  - If the account's email ID already exists, the system sends the user an email invite to join the Postman team. After they accept the invite, the are added to the team.\n- By default, new users are given the developer role in Postman. Postman user roles cannot be updated via the SCIM API. You must manage user and group roles in Postman.\n"
paths:
  /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:
      - User Provisioning
      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'
      - $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:
      - User Provisioning
      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:
      - User Provisioning
      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:
      - User Provisioning
      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:
      - User Provisioning
      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:
  responses:
    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'
    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'
    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'
    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'
    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'
    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'
  schemas:
    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
    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'
  requestBodies:
    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
    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
  examples:
    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
          userNa

# --- truncated at 32 KB (34 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/apis-io-engineering-platform/refs/heads/main/openapi/engineering-platform-user-provisioning-api-openapi.yml