Update a provisioned organization membership

Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the Update an attribute for a SCIM user endpoint instead.

You must at least provide the required values for the user: userName, name, and emails.

Warning: Setting active: false removes the user from the organization, deletes the external identity, and deletes the associated {scim_user_id}.

curl --location --request PUT 'https://api.github.com/scim/v2/organizations//Users/' \ --header 'Content-Type: application/json' \ --data-raw '{ "active": true, "displayName": "Jon Doe", "emails": [ { "primary": true, "value": "someone@example.com" }, { "primary": false, "value": "another@example.com" } ], "externalId": "string", "groups": [ "string" ], "name": { "familyName": "User", "givenName": "Jane" }, "schemas": [ "string" ], "userName": "someone@example.com" }'

Request

Path Params

org

string

required

scim_user_id

string

required

scim_user_id parameter

Body Params application/json

active

boolean

optional

displayName

string

optional

The name of the user, suitable for display to end-users

Example:

Jon Doe

emails

array [object {3}]

required

user emails

>= 1 items

Example:

[{"primary":true,"value":"someone@example.com"},{"primary":false,"value":"another@example.com"}]

primary

boolean

optional

type

string

optional

value

string

required

externalId

string

optional

groups

array[string]

optional

name

object

required

Example:

{"familyName":"User","givenName":"Jane"}

familyName

string

required

formatted

string

optional

givenName

string

required

schemas

array[string]

optional

userName

string

required

Configured by the admin. Could be an email, login, or username

Example:

someone@example.com

Examples

Update a provisioned organization membership

Request

Responses