contentstack

opencollection: 1.0.0
info:
  name: Contentstack SCIM API
  version: '2.0'
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: SCIM Users
    type: folder
  items:
  - info:
      name: List SCIM users
      type: http
    http:
      method: GET
      url: https://auth-api.contentstack.com/scim/v2.0/organizations/:organization_uid/Users
      params:
      - name: organization_uid
        value: ''
        type: path
        description: The unique identifier of the Contentstack organization.
      - name: filter
        value: ''
        type: query
        description: 'SCIM filter expression for searching users. Example: userName eq "user@example.com"'
    docs: Retrieves all users in the organization following the SCIM 2.0 ListResponse format. Supports filtering by userName
      (email address) using the filter query parameter for user lookup during IdP sync operations.
  - info:
      name: Create a SCIM user
      type: http
    http:
      method: POST
      url: https://auth-api.contentstack.com/scim/v2.0/organizations/:organization_uid/Users
      params:
      - name: organization_uid
        value: ''
        type: path
        description: The unique identifier of the Contentstack organization.
      body:
        type: json
        data: '{}'
    docs: Provisions a new user in the Contentstack organization via SCIM. The user is created with the attributes provided
      in the SCIM User resource and assigned to the organization's default role unless group mappings specify otherwise.
  - info:
      name: Get a SCIM user
      type: http
    http:
      method: GET
      url: https://auth-api.contentstack.com/scim/v2.0/organizations/:organization_uid/Users/:user_id
      params:
      - name: organization_uid
        value: ''
        type: path
        description: The unique identifier of the Contentstack organization.
      - name: user_id
        value: ''
        type: path
        description: The SCIM user ID of the user within the organization.
    docs: Retrieves the SCIM User resource for a specific user by their SCIM user ID within the organization.
  - info:
      name: Replace a SCIM user
      type: http
    http:
      method: PUT
      url: https://auth-api.contentstack.com/scim/v2.0/organizations/:organization_uid/Users/:user_id
      params:
      - name: organization_uid
        value: ''
        type: path
        description: The unique identifier of the Contentstack organization.
      - name: user_id
        value: ''
        type: path
        description: The SCIM user ID of the user within the organization.
      body:
        type: json
        data: '{}'
    docs: Fully replaces a SCIM user resource with the provided attributes. All attributes not included in the request will
      be cleared or reset to defaults following SCIM 2.0 PUT semantics.
  - info:
      name: Update a SCIM user
      type: http
    http:
      method: PATCH
      url: https://auth-api.contentstack.com/scim/v2.0/organizations/:organization_uid/Users/:user_id
      params:
      - name: organization_uid
        value: ''
        type: path
        description: The unique identifier of the Contentstack organization.
      - name: user_id
        value: ''
        type: path
        description: The SCIM user ID of the user within the organization.
      body:
        type: json
        data: '{}'
    docs: Partially updates a SCIM user resource using SCIM 2.0 PATCH operations. Commonly used to activate or deactivate
      users by setting the active attribute, or to update specific profile attributes without replacing the entire resource.
- info:
    name: SCIM Groups
    type: folder
  items:
  - info:
      name: List SCIM groups
      type: http
    http:
      method: GET
      url: https://auth-api.contentstack.com/scim/v2.0/organizations/:organization_uid/Groups
      params:
      - name: organization_uid
        value: ''
        type: path
        description: The unique identifier of the Contentstack organization.
      - name: filter
        value: ''
        type: query
        description: 'SCIM filter expression for searching groups. Example: displayName eq "Editors"'
    docs: Retrieves all groups in the organization following the SCIM 2.0 ListResponse format. Supports filtering by displayName
      for group lookup during IdP sync operations.
  - info:
      name: Create a SCIM group
      type: http
    http:
      method: POST
      url: https://auth-api.contentstack.com/scim/v2.0/organizations/:organization_uid/Groups
      params:
      - name: organization_uid
        value: ''
        type: path
        description: The unique identifier of the Contentstack organization.
      body:
        type: json
        data: '{}'
    docs: Creates a new group in the Contentstack organization via SCIM. Groups can be mapped to specific roles and stacks
      in Contentstack to control member access permissions.
  - info:
      name: Get a SCIM group
      type: http
    http:
      method: GET
      url: https://auth-api.contentstack.com/scim/v2.0/organizations/:organization_uid/Groups/:group_id
      params:
      - name: organization_uid
        value: ''
        type: path
        description: The unique identifier of the Contentstack organization.
      - name: group_id
        value: ''
        type: path
        description: The SCIM group ID of the group within the organization.
    docs: Retrieves the SCIM Group resource for a specific group by its SCIM group ID within the organization.
  - info:
      name: Replace a SCIM group
      type: http
    http:
      method: PUT
      url: https://auth-api.contentstack.com/scim/v2.0/organizations/:organization_uid/Groups/:group_id
      params:
      - name: organization_uid
        value: ''
        type: path
        description: The unique identifier of the Contentstack organization.
      - name: group_id
        value: ''
        type: path
        description: The SCIM group ID of the group within the organization.
      body:
        type: json
        data: '{}'
    docs: Fully replaces a SCIM group resource including all member assignments. Use this to synchronize the complete group
      membership from the IdP.
  - info:
      name: Update a SCIM group
      type: http
    http:
      method: PATCH
      url: https://auth-api.contentstack.com/scim/v2.0/organizations/:organization_uid/Groups/:group_id
      params:
      - name: organization_uid
        value: ''
        type: path
        description: The unique identifier of the Contentstack organization.
      - name: group_id
        value: ''
        type: path
        description: The SCIM group ID of the group within the organization.
      body:
        type: json
        data: '{}'
    docs: Partially updates a SCIM group using SCIM 2.0 PATCH operations. Commonly used to add or remove individual members
      from the group without replacing the entire membership list.
  - info:
      name: Delete a SCIM group
      type: http
    http:
      method: DELETE
      url: https://auth-api.contentstack.com/scim/v2.0/organizations/:organization_uid/Groups/:group_id
      params:
      - name: organization_uid
        value: ''
        type: path
        description: The unique identifier of the Contentstack organization.
      - name: group_id
        value: ''
        type: path
        description: The SCIM group ID of the group within the organization.
    docs: Removes a SCIM group from the Contentstack organization. Members of the group retain their individual user accounts
      but lose the role permissions granted by the group mapping.
- info:
    name: SCIM Schema Discovery
    type: folder
  items:
  - info:
      name: Get SCIM schemas
      type: http
    http:
      method: GET
      url: https://auth-api.contentstack.com/scim/v2.0/Schemas
    docs: Returns the SCIM schemas supported by the Contentstack SCIM API, enabling IdP clients to understand the available
      attributes for User and Group resources.
  - info:
      name: Get SCIM resource types
      type: http
    http:
      method: GET
      url: https://auth-api.contentstack.com/scim/v2.0/ResourceTypes
    docs: Returns the SCIM resource types supported by the Contentstack SCIM API including Users and Groups, enabling IdP
      clients to discover available endpoints and their schemas.
bundled: true