---
schema_version: "1"
id: 75ae9df37b5b7edaa8325b07a1b7237b2bea8cebffdf9e5bf3a333b0475e21a5
title: "Examples: Update Users with SCIM"
collection: admin
version: current
locale: en-us
portal_url: https://docs.salesforce.com/admin/current/en-us/xcloud/264-0-0/identity_scim_update_users.md
canonical_url: https://help.salesforce.com/s/articleView?id=xcloud.identity_scim_update_users.htm&release=264.0.0&type=5
source_site: help.salesforce.com
content_type: documentation
content_hash: 2086fe66c8ec8b9152e853b4e781c492b19f6ea990bde3b5cc21b1820630aa11
description: After creating a user object, you can update its fields. To update a user object, send a PATCH request to the Users endpoint.
products:
  - Security
  - Cross Cloud
release: "264"
---
# Examples: Update Users with SCIM

After creating a user object, you can update its fields. To update a user object, send a PATCH request to the Users endpoint.

### Required Editions

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small edition"><colgroup><col></colgroup><tbody><tr class=""><td class="slds-cell-wrap" style="vertical-align:top;">Available in: Salesforce Classic and Lightning Experience</td></tr><tr class=""><td class="slds-cell-wrap" style="vertical-align:top;">Available in: <strong>All</strong> Editions</td></tr></tbody></table>

The following examples show how to update user objects with SCIM. These user object updates are supported.

![Note](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-xcloud-identity-264-0-0-production-enus/699dab6f-8f1a-4662-b24f-6521d5b747f7/images/icon_note.png)

Note When you create or update users with SCIM, you can assign only one phone number to each user.

- [Update a Single User Object Field](https://help.salesforce.com/s/articleView?id=xcloud.identity_scim_update_users.htm&release=264.0.0&type=5)
- [Update Multiple User Object Fields](https://help.salesforce.com/s/articleView?id=xcloud.identity_scim_update_users.htm&release=264.0.0&type=5)
- [Update User Object Role](https://help.salesforce.com/s/articleView?id=xcloud.identity_scim_update_users.htm&release=264.0.0&type=5)
- [Add a Permission Set to a User Object](https://help.salesforce.com/s/articleView?id=xcloud.identity_scim_update_users.htm&release=264.0.0&type=5)

## Update a Single User Object Field

This example shows a single field update on the user object.

Request:

```
PATCH https://mycompany.my.salesforce.com/services/scim/v2/Users/<userid>

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [
    {
      "op": "replace",
      "value": {
        "nickName": "user2"
      }
    }
  ]
}
```

Response:

```
HTTP/1.1 200 OK
… 

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User",
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
  ],
  "id": "0054W00000CVREkQAP",
  "userName": "scimuser@mycompany.com",
  "externalId": "scimUser",
  "name": {
    "formatted": "User Scim",
    "familyName": "Scim",
    "givenName": "User"
  },
  "displayName": "User Scim",
  "nickName": "user2",
  "emails": [
    {
      "type": "work",
      "primary": true,
      "value": "user@mycompany.com"
    }
  ],
  "photos": [
    {
      "type": "photo",
      "value": "https://mycompany.file.force.com/profilephoto/005/F"
    },
    {
      "type": "thumbnail",
      "value": "https://mycompany.file.force.com/profilephoto/005/T"
    }
  ],
  "userType": "Standard",
  "preferredLanguage": "en_US",
  "emailEncodingKey": "UTF-8",
  "locale": "en_US",
  "timezone": "America/Los_Angeles",
  "active": true,
  "entitlements": [
    {
      "value": "00e4W000002Kw0XQAS",
      "$ref": "/Entitlements/00e4W000002Kw0XQAS",
      "display": "System Administrator",
      "type": "Profile",
      "primary": true
    }
  ],
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "organization": "00D4W000007RdhEUAS"
  },
  "urn:salesforce:schemas:extension:2.0": {
    "alias": "90905417"
  },
  "meta": {
    "created": "2020-10-22T06:21:45Z",
    "lastModified": "2020-10-23T05:33:53Z",
    "location": "https://mycompany.my.salesforce.com/services/scim/v2/Users/0054W00000...",
    "resourceType": "User",
    "version": "9c7f7da0ddb5118829d51dd29e844264496f852b"
  }
}
```

## Update Multiple User Object Fields

This example shows multiple fields being updated on the user object.

Request:

```
PATCH https://mycompany.my.salesforce.com/services/scim/v2/Users/<userid>

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [
    {
      "op": "replace",
      "value": [
        {
          "nickName": "user3",
          "active": false
        }
      ]
    }
  ]
}
```

Response:

```
HTTP/1.1 200 OK
… 

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User",
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
  ],
  "id": "0054W00000DGzivQAD",
  "userName": "user3@example.com",
  "name": {
    "formatted": "User3 SCIM",
    "familyName": "SCIM",
    "givenName": "User3"
  },
  "displayName": "User3 SCIM",
  "nickName": "user3",
  "emails": [
    {
      "type": "work",
      "primary": true,
      "value": "user3@example.com"
    }
  ],
  ...

    "active": false,
  "entitlements": [
    {
      "value": "00e4W000002Kw0kQAC",
      "$ref": "/Entitlements/00e4W000002Kw0kQAC",
      "display": "Identity User",
      "type": "Profile",
      "primary": true
    }
  ],
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "organization": "00D4W000007RdhEUAS"
  },
  "urn:salesforce:schemas:extension:2.0": {
    "alias": "11399755"
  },
  "meta": {
    "created": "2020-11-05T09:23:19Z",
    "lastModified": "2020-12-03T09:10:57Z",
    "location": "https://mycompany.my.salesforce.com/services/scim/v2/Users/0054W00...",
    "resourceType": "User",
    "version": "18e2e5a3f4038af969c9d129c9b12f5e29c85b55"
  }
}
```

## Update User Object Role

Before updating a user object’s role, remember to query the Roles endpoint to see a list of available roles. Here’s an example of updating the role assigned to a user object.

Request:

```
PATCH https://mycompany.my.salesforce.com/services/scim/v2/Users/<UserId>

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [
    {
      "op": "replace",
      "value": {
        "roles": [
          {
            "value": "<role_id>"
          }
        ]
      }
    }
  ]
}
```

Response:

```
HTTP/1.1 200 OK
…
{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User",
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
  ],
  "id": "0054W00000CVREkQAP",
  "userName": "scimuser@mycompany.com",
  "externalId": "scimUser",
  "name": {
    "formatted": "User Scim",
    "familyName": "Scim",
    "givenName": "User"
  },
  "displayName": "User Scim",
  "nickName": "user2",
  "emails": [
    {
      "type": "work",
      "primary": true,
      "value": "user@mycompany.com"
    }
  ...

  "entitlements": [
    {
      "value": "00e4W000002Kw0XQAS",
      "$ref": "/Entitlements/00e4W000002Kw0XQAS",
      "display": "System Administrator",
      "type": "Profile",
      "primary": true
    }
  ],
  "roles": [
    {
      "value": "00E4W0000026qDpUAI",
      "$ref": "/Roles/00E4W0000026qDpUAI",
      "display": "CEO"
    }
  ],
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "organization": "00D4W000007RdhEUAS"
  },
  "urn:salesforce:schemas:extension:2.0": {
    "alias": "90905417"
  },
  "meta": {
    "created": "2020-10-22T06:21:45Z",
    "lastModified": "2020-10-25T09:06:56Z",
    "location": "https://mycompany.my.salesforce.com/services/scim/v2/Users/0054W000...",
    "resourceType": "User",
    "version": "d959e2db34c46435d2c1321126dc54ef25f2ca39"
  }
}
```

## Add a Permission Set to a User Object

This example shows how to add a permission set to a user object. As when editing user objects in Salesforce, you can add multiple permission sets to user objects. Before adding a permission set to a user object, remember to query the Entitlements endpoint to see a list of available permission sets.

Request:

```
PATCH https://mycompany.my.salesforce.com/services/scim/v2/Users/<UserId>

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [
    {
      "op": "add",
      "value": {
        "entitlements": [
          {
            "value": "<permission_set_id>"
          }
        ]
      }
    }
  ]
}
```

Response:

```
HTTP/1.1 200 OK
…

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User",
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
  ],
  "id": "0054W00000CUpYGQA1",
  "userName": "integration@00d4w000007rdheuas.com",
  "name": {
    "formatted": "Integration User",
    "familyName": "User",
    "givenName": "Integration"
  },
  "displayName": "Integration User",
  "nickName": "integration1.4407085834085586E12",
  "emails": [
    {
      "type": "work",
      "primary": true,
      "value": "integration@example.com"
    }
  ],
  "addresses": [
    {
      "type": "work",
      "primary": true,
      "country": "xx",
      "formatted": "xx"
    }
...  

  "entitlements": [
    {
      "value": "00e4W000002Kw0YQAS",
      "$ref": "/Entitlements/00e4W000002Kw0YQAS",
      "display": "Analytics Cloud Integration User",
      "type": "Profile",
      "primary": true
    },
    {
      "value": "0PS4W000002pwIXWAY",
      "$ref": "/Entitlements/0PS4W000002pwIXWAY",
      "display": "SCIM_Test_Persmissions",
      "type": "Permission Set",
      "primary": false
    }
  ],
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "organization": "00D4W000007RdhEUAS"
  },
  "urn:salesforce:schemas:extension:2.0": {
    "alias": "integ"
  },
  "meta": {
    "created": "2020-10-22T09:14:27Z",
    "lastModified": "2020-10-26T05:58:59Z",
    "location": "https://mycompany.my.salesforce.com/services/scim/v2/Users/0054W00000CUpYGQA1",
    "resourceType": "User",
    "version": "4cd44c006b2bc431a720b668e0acaaba32b380d1"
  }
}
```