Update an attribute for a SCIM enterprise user

PATCH

/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}

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
    }
  }]
}

Request

Path Params

Body Params application/json

Examples

Responses

🟢200response

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

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"
    ]
}'

Response Example

{
    "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"
}

Modified at 2022-09-10 00:54:29

Get SCIM provisioning information for an enterprise user

Set SCIM information for a provisioned enterprise user