Postman scim API

openapi: 3.2.0
info:
  title: Postman SCIM API
  version: 1.0.0
servers:
- url: https://api.postman.com
  description: https://api.postman.com
- url: https://api.eu.postman.com
  description: https://api.eu.postman.com
tags:
- name: scim
paths:
  /scim/v2/Groups:
    get:
      operationId: getScimGroupResources
      summary: Get all groups
      description: Gets information about all Postman team members.
      tags:
      - scim
      parameters:
      - name: startIndex
        in: query
        description: The index entry by which to begin the list of returned results. Must be a value of `1` or greater.
        required: false
        schema:
          $ref: '#/components/schemas/startIndex'
          default: 1
      - name: count
        in: query
        description: Limit the number of results returned in a single response.
        required: false
        schema:
          $ref: '#/components/schemas/count'
          default: 100
      - 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.

          '
        required: false
        schema:
          $ref: '#/components/schemas/scimGroupFilter'
      - name: Authorization
        in: header
        description: A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getScimGroupResources'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
    post:
      operationId: createScimGroup
      summary: 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).

        '
      tags:
      - scim
      parameters:
      - name: Authorization
        in: header
        description: A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createScimGroupResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimErrorScimType'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimErrorScimType'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createScimGroup'
  /scim/v2/Groups/{groupId}:
    get:
      operationId: getScimGroupResource
      summary: Get a group
      description: Gets information about a Postman group within the team.
      tags:
      - scim
      parameters:
      - name: groupId
        in: path
        description: The group's ID.
        required: true
        schema:
          $ref: '#/components/schemas/scimId'
      - name: Authorization
        in: header
        description: A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getScimGroupResource'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
    delete:
      operationId: deleteScimGroup
      summary: 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/).

        '
      tags:
      - scim
      parameters:
      - name: groupId
        in: path
        description: The group's ID.
        required: true
        schema:
          $ref: '#/components/schemas/scimId'
      - name: Authorization
        in: header
        description: A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Group Deleted
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
    patch:
      operationId: updateGroup
      summary: 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.

        '
      tags:
      - scim
      parameters:
      - name: groupId
        in: path
        description: The group's ID.
        required: true
        schema:
          $ref: '#/components/schemas/scimId'
      - name: Authorization
        in: header
        description: A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimUpdateGroupResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimErrorScimType'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/scimUpdateGroup'
  /scim/v2/ResourceTypes:
    get:
      operationId: getScimResourceTypes
      summary: Get resource types
      description: Gets all the resource types supported by Postman's SCIM API.
      tags:
      - scim
      parameters:
      - name: Authorization
        in: header
        description: A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getScimResourceTypes'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetScimResourceTypesRequestUnauthorizedError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
  /scim/v2/ServiceProviderConfig:
    get:
      operationId: getScimServiceProviderConfig
      summary: Get service provider configuration
      description: Gets the Postman SCIM API configuration information. This includes a list of supported operations.
      tags:
      - scim
      parameters:
      - name: Authorization
        in: header
        description: A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getScimServiceProviderConfig'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
  /scim/v2/Users:
    get:
      operationId: getScimUserResources
      summary: Get all users
      description: Gets information about all Postman team members.
      tags:
      - scim
      parameters:
      - name: startIndex
        in: query
        description: The index entry by which to begin the list of returned results. Must be a value of `1` or greater.
        required: false
        schema:
          $ref: '#/components/schemas/startIndex'
          default: 1
      - name: count
        in: query
        description: Limit the number of results returned in a single response.
        required: false
        schema:
          $ref: '#/components/schemas/count'
          default: 100
      - 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`).

          '
        required: false
        schema:
          $ref: '#/components/schemas/scimUserFilter'
      - name: Authorization
        in: header
        description: A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimUserResources'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
    post:
      operationId: createScimUser
      summary: 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.

        - If the user is a member of a different team during SCIM provisioning and their email domain is **not** verified with your Postman team, then the user is **not** provisioned. The endpoint returns an HTTP `409 Conflict` response.

        '
      tags:
      - scim
      parameters:
      - name: Authorization
        in: header
        description: A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createScimUserResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimErrorScimType'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimErrorScimType'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createScimUser'
  /scim/v2/Users/{userId}:
    get:
      operationId: getScimUserResource
      summary: Get a user
      description: Gets information about a Postman team member.
      tags:
      - scim
      parameters:
      - name: userId
        in: path
        description: The user's SCIM ID.
        required: true
        schema:
          $ref: '#/components/schemas/scimId'
      - name: Authorization
        in: header
        description: A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimUserResourceResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
    put:
      operationId: updateScimUser
      summary: Update a user
      description: 'Updates a user 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.

        '
      tags:
      - scim
      parameters:
      - name: userId
        in: path
        description: The user's SCIM ID.
        required: true
        schema:
          $ref: '#/components/schemas/scimId'
      - name: Authorization
        in: header
        description: A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimUserResourceResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateScimUserRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateScimUser'
    patch:
      operationId: updateScimUserPatch
      summary: Update a user
      description: 'Updates a user 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.

        '
      tags:
      - scim
      parameters:
      - name: userId
        in: path
        description: The user's SCIM ID.
        required: true
        schema:
          $ref: '#/components/schemas/scimId'
      - name: Authorization
        in: header
        description: A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimUserResourceResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateScimUserPatchRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateScimUserPatch'
components:
  schemas:
    GetScimServiceProviderConfigAuthenticationSchemesItems:
      type: object
      properties:
        description:
          type: string
          description: The scheme's description.
        name:
          type: string
          description: The scheme's friendly name.
        specUri:
          type: string
          format: url
          description: A link to the scheme's specification documentation.
        type:
          type: string
          description: The scheme's type.
      description: Information about the scheme.
      title: GetScimServiceProviderConfigAuthenticationSchemesItems
    startIndex:
      type: number
      format: double
      default: 1
      title: startIndex
    CreateScimGroupResponseMeta:
      type: object
      properties:
        created:
          type: string
          format: date-time
          description: The date and time at which the group was created.
        lastModified:
          type: string
          format: date-time
          description: The date and time at which the group was last modified.
        resourceType:
          type: string
          description: The SCIM resource type.
      description: The response's non-standard meta information.
      title: CreateScimGroupResponseMeta
    scimGroupFilter:
      type: string
      title: scimGroupFilter
    CreateScimGroupMembersItems:
      type: object
      properties:
        value:
          type: string
          description: The user's SCIM ID.
        display:
          type: string
          description: The user's display name.
      description: Information about the group's members.
      title: CreateScimGroupMembersItems
    scimUserResourceResponse:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
        id:
          type: string
          description: The team member's SCIM ID.
        userName:
          type: string
          description: The team member's SCIM username.
        name:
          $ref: '#/components/schemas/ScimUserResourceResponseName'
          description: Information about the Postman team member.
        externalId:
          type: string
          description: The team member's external ID.
        active:
          type: boolean
          description: If true, the team member is active.
        meta:
          $ref: '#/components/schemas/ScimUserResourceResponseMeta'
          description: The response's non-standard meta information.
      title: scimUserResourceResponse
    CommonErrorNameMessageError:
      type: object
      properties:
        name:
          type: string
          description: The error name.
        message:
          type: string
          description: The error message.
      description: Information about the error.
      title: CommonErrorNameMessageError
    GetScimServiceProviderConfigSort:
      type: object
      properties:
        supported:
          type: boolean
          description: If true, the feature is supported.
      description: Information about the sort configuration.
      title: GetScimServiceProviderConfigSort
    UpdateScimUserRequestBadRequestError:
      oneOf:
      - $ref: '#/components/schemas/scimError'
      - $ref: '#/components/schemas/scimErrorScimType'
      title: UpdateScimUserRequestBadRequestError
    GetScimServiceProviderConfigMeta:
      type: object
      properties:
        resourceType:
          type: string
        location:
          type: string
          format: url
      description: The response's non-standard meta information.
      title: GetScimServiceProviderConfigMeta
    GetScimResourceTypesItemsSchemaExtensionsItems:
      type: object
      properties:
        schema:
          type: string
          description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
        required:
          type: boolean
          description: If true, the resource must include this schema extension.
      title: GetScimResourceTypesItemsSchemaExtensionsItems
    updateScimUserPatch:
      oneOf:
      - $ref: '#/components/schemas/UpdateScimUserPatch0'
      - $ref: '#/components/schemas/UpdateScimUserPatch1'
      title: updateScimUserPatch
    scimUserFilter:
      type: string
      title: scimUserFilter
    ScimUpdateGroupOperationsItemsOp:
      type: string
      enum:
      - replace
      - remove
      - add
      description: The operation to perform.
      title: ScimUpdateGroupOperationsItemsOp
    GetScimServiceProviderConfigPatch:
      type: object
      properties:
        supported:
          type: boolean
          description: If true, the feature is supported.
      description: Information about patch configuration.
      title: GetScimServiceProviderConfigPatch
    commonErrorTypeTitleDetailStatus:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/CommonErrorTypeTitleDetailStatusType'
        title:
          type: string
          description: A short summary of the problem.
        detail:
          type: string
          description: Information about the error.
        status:
          type: integer
          description: The error's HTTP status code.
      title: commonErrorTypeTitleDetailStatus
    UpdateScimUserPatchOneOf1OperationsItems:
      type: object
      properties:
        op:
          $ref: '#/components/schemas/UpdateScimUserPatchOneOf1OperationsItemsOp'
          description: The operation to perform. Accepts the `replace` value.
        path:
          $ref: '#/components/schemas/UpdateScimUserPatchOneOf1OperationsItemsPath'
          description: The operation's path. Accepts the `userName` value.
        value:
          type: string
          format: email
          description: The user's email address.
      title: UpdateScimUserPatchOneOf1OperationsItems
    UpdateScimUserPatchOneOf0OperationsItemsOp:
      type: string
      enum:
      - replace
      description: The operation to perform.
      title: UpdateScimUserPatchOneOf0OperationsItemsOp
    UpdateScimUserPatchOneOf0OperationsItemsValue:
      type: object
      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.

            '
      description: The performed operation's value.
      title: UpdateScimUserPatchOneOf0OperationsItemsValue
    scimId:
      type: string
      title: scimId
    scimErrorScimType:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
        scimType:
          type: string
          description: The SCIM error type.
        detail:
          type: string
          description: Information about the error.
        status:
          type: string
          format: http-status-code
          description: The HTTP status code.
      title: scimErrorScimType
    createScimGroupResponse:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
        id:
          type: string
          description: The group's SCIM ID.
        displayName:
          type: string
          description: The group's display name.
        externalId:
          type: string
          description: The group's external ID.
        members:
          type: array
          items:
            $ref: '#/components/schemas/CreateScimGroupResponseMembersItems'
          description: A list of the group's members.
        meta:
          $ref: '#/components/schemas/CreateScimGroupResponseMeta'
          descript

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