Update a user's state

PATCH https://api.getpostman.com/scim/v2/Users/{{userId}}

Updates a user's active state in Qodex. Set the active property in the request body to one of the following values:

  • true — Activates the user. This lets them authenticate in to your Qodex team.
  • false — Removes the user from your Qodex team and deactivates the account. This blocks the user from authenticating in to Qodex.

Reactivating users

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

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"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":false,"meta":{"resourceType":"User","created":"2021-02-22T04:24:13.000Z","lastModified":"2021-02-22T04:24:13.000Z"}}