Update an attribute for a SCIM user

PATCH {{baseUrl}}/scim/v2/organizations/:org/Users/:scim_user_id

Allows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.

Note: Complicated SCIM path selectors that include filters are not supported. For example, a path selector defined as "path": "emails[type eq \"work\"]" will not work.

Warning: If you set active:false using the replace operation (as shown in the JSON example below), it removes the user from the organization, deletes the external identity, and deletes the associated :scim_user_id.

{
  "Operations":[{
    "op":"replace",
    "value":{
      "active":false
    }
  }]
}

Request Body

{"Operations"=>[{"op"=>"<string>", "path"=>"<string>", "value"=>{"active"=>"<boolean>", "userName"=>"<string>", "externalId"=>"<string>", "givenName"=>"<string>", "familyName"=>"<string>"}}], "schemas"=>["<string>", "<string>"]}

HEADERS

RESPONSES

status: OK

{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],"id":"edefdfedf-050c-11e7-8d32","externalId":"a7d0f98382","userName":"mona.octocat@okta.example.com","displayName":"Monalisa Octocat","name":{"givenName":"Monalisa","familyName":"Octocat","formatted":"Monalisa Octocat"},"emails":[{"value":"mona.octocat@okta.example.com","primary":true},{"value":"monalisa@octocat.github.com"}],"active":true,"meta":{"resourceType":"User","created":"2017-03-09T16:11:13-05:00","lastModified":"2017-03-09T16:11:13-05:00","location":"https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32"}}