Update user attributes Run in API Explorer

PATCH /Users/{identifier}
Adra personal access token

Modify user attributes using SCIM PATCH operations

Path parameters

  • identifier string Required

    Identifier of the user to modify

application/json

Body Required

  • operations array[object] | null Required
    Hide operations attributes Show operations attributes object
    • value array[object]
      Hide value attribute Show value attribute object
      • value string
    • op string Required

      Values are Add, Remove, or Replace.

    • path string Required
  • schemas array[string] | null Required

Responses

  • 200 application/scim+json

    OK

    Hide response attributes Show response attributes object
    • enterpriseExtension object | null

      Additional properties are NOT allowed.

      Hide enterpriseExtension attribute Show enterpriseExtension attribute object | null
      • employeeNumber string | null
    • active boolean
    • electronicMailAddresses array[object]
      Hide electronicMailAddresses attributes Show electronicMailAddresses attributes object
      • value string | null
      • itemType string | null
      • primary boolean
    • locale string | null
    • meta object | null

      Additional properties are NOT allowed.

      Hide meta attribute Show meta attribute object | null
      • resourceType string | null
    • name object

      Additional properties are NOT allowed.

      Hide name attributes Show name attributes object
      • familyName string
      • givenName string
    • preferredLanguage string | null
    • timeZone string | null
    • title string | null
    • userName string
    • externalId string | null
    • schemas array[string] | null
  • 204

    Operation successful

  • 400 application/scim+json

    Bad Request

    Hide response attributes Show response attributes object
    • type string | null
    • title string | null
    • status integer(int32) | null
    • detail string | null
    • instance string | null
  • 401 application/scim+json

    Unauthorized

    Hide response attributes Show response attributes object
    • type string | null
    • title string | null
    • status integer(int32) | null
    • detail string | null
    • instance string | null
  • 403 application/scim+json

    Forbidden

    Hide response attributes Show response attributes object
    • type string | null
    • title string | null
    • status integer(int32) | null
    • detail string | null
    • instance string | null
  • 404

    User not found

  • 500 application/scim+json

    Internal Server Error

    Hide response attributes Show response attributes object
    • type string | null
    • title string | null
    • status integer(int32) | null
    • detail string | null
    • instance string | null
  • 501 application/scim+json

    Not Implemented

    Hide response attributes Show response attributes object
    • type string | null
    • title string | null
    • status integer(int32) | null
    • detail string | null
    • instance string | null
PATCH /Users/{identifier} 
curl \
 --request PATCH 'https://setup.adra.com/api/organizations/{organizationSid}/scim/Users/{identifier}' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"replace","path":"active","value":"false"}]}'
Request example 
{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [
    {
      "op": "replace",
      "path": "active",
      "value": "false"
    }
  ]
}
Response examples (200) 
{
  "enterpriseExtension": {
    "employeeNumber": "string"
  },
  "active": true,
  "electronicMailAddresses": [
    {
      "value": "string",
      "itemType": "string",
      "primary": true
    }
  ],
  "locale": "string",
  "meta": {
    "resourceType": "string"
  },
  "name": {
    "familyName": "string",
    "givenName": "string"
  },
  "preferredLanguage": "string",
  "timeZone": "string",
  "title": "string",
  "userName": "string",
  "externalId": "string",
  "schemas": [
    "string"
  ]
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (401) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (403) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (500) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (501) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}