DISABLE User

Description: This API allows to disable or re-enable the user status by editing the “active” attribute.

Usage: PATCH /api/v1/scim/v2/Users/<id>

Consumes: application/scim+json; charset=UTF-8

Sample request:

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
  "Operations": [{
    "op": "Replace",
    "path": "active",
    "value": false
  }]
}

Produces: application/scim+json; charset=UTF-8

Header parameter:Authorization: Bearer

Sample response:

200 - OK

{
  "id": "jbibinka2@example.com",
  "userName": "jbibinka2@example.com",
  "active": false,
  "emails": [
    {
      "primary": true,
      "value": "jbibinka2@example.com"
    }
  ],
  "groups": [
    {
      "value": "readers"
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "meta": {
    "resourceType": "User"
  }
}