Logo
30-day challenge API Documentation

SCIM 2.0 - Identity-Group Provisioning

Number of APIs: 5


1. Get all group resources

GET https://api.getpostman.com/scim/v2/Groups

Gets all Qodex groups within the team.



2. Update a group

PATCH https://api.getpostman.com/scim/v2/Groups/{{groupId}}

Updates a group's information. Using this endpoint you can:

  • Update a group's name.
  • Add or remove members from a Qodex group.

Include the following properties in the request body:

  • Operations — An object that contains the following properties:
    • op — The operation to perform. One of:
      • add
      • remove
      • replace
    • value — An object that contains the following properties:
      • id — The group's ID.
      • displayName — The group's display name.



3. Get a group resource

GET https://api.getpostman.com/scim/v2/Groups/{{groupId}}

Gets information about a Qodex group within the team.



4. Create a group

POST https://api.getpostman.com/scim/v2/Groups

Creates a new user group in Qodex and creates a new account for each group member.

Each account is added to your Qodex team and authentication is activated for each user. If an existing Qodex account uses an email that matches a group member's email ID, an email invite to join your Qodex 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 Qodex]



5. Delete a group

DELETE https://api.getpostman.com/scim/v2/Groups/{{groupId}}

Deletes a group in Qodex.

User accounts that were in the deleted group are deactivated in Qodex 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 Qodex support]



ENDPOINTS