Update an attribute for a SCIM enterprise user

Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.

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 enterprise, deletes the external identity, and deletes the associated :scim_user_id.

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

curl --location --request PATCH 'https://api.github.com/scim/v2/enterprises//Users/' \ --header 'Content-Type: application/json' \ --data-raw '{ "Operations": [ { "op": "add", "path": "emails", "value": [ { "type": "home", "value": "monalisa@octocat.github.com" } ] }, { "op": "replace", "path": "name.givenName", "value": "Monalisa" } ], "schemas": [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ] }'

{ "active": true, "emails": [ { "primary": true, "type": "string", "value": "string" } ], "externalId": "string", "groups": [ { "value": "string" } ], "id": "string", "meta": { "created": "string", "lastModified": "string", "location": "string", "resourceType": "string" }, "name": { "familyName": "string", "givenName": "string" }, "schemas": [ "string" ], "userName": "string" }

Request

Path Params

enterprise

string

required

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

scim_user_id

string

required

scim_user_id parameter

Body Params application/json

Operations

array [object]

required

Array of SCIM operations.

schemas

array[string]

required

The SCIM schema URIs.

Examples

Responses

🟢200response

application/json

Body

active

boolean

optional

emails

array [object {3}]

optional

primary

boolean

optional

type

string

optional

value

string

optional

externalId

string

optional

groups

array [object {1}]

optional

value

string

optional

string

required