Example: Create Users with SCIM

To create a user object with SCIM, send a POST request to the Users endpoint.

Required Editions

Available in: Salesforce Classic and Lightning Experience

Available in: All Editions

When you create a user object, include all required fields in your request. For a list of required fields, see the User object in the Object Reference.

Here’s an example of creating a user object.

Request:

POST https://mycompany.my.salesforce.com/services/scim/v2/Users/

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "externalId": "scimUser",
  "userName": "scimUser@mycompany.com",
  "name": {
    "familyName": "Scim",
    "givenName": "User"
  },
  "emails": [
    {
      "type": "work",
      "primary": "true",
      "value": "user@mycompany.com"
    }
  ],
  "entitlements": [
    {
      "value": "profile_id"
    }
  ]
}

Response:

HTTP/1.1 201 Created
...

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User",
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
  ],
  "id": "005RM000002FZAlYAO",
  "userName": "scimuser@mycompany.com",
  "externalId": "scimUser",
  "name": {
    "formatted": "User Scim",
    "familyName": "Scim",
    "givenName": "User"
  },
  "displayName": "User Scim",
  "nickName": "scimUser@mycompany.com",
  "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": "00eRM000001VtbnYAC",
      "$ref": "/Entitlements/00eRM000001VtbnYAC",
      "display": "System Administrator",
      "type": "Profile",
      "primary": true
    }
  ],
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "organization": "00DRM000000HOcw2AG"
  },
  "urn:salesforce:schemas:extension:2.0": {
    "alias": "45512346"
  },
  "meta": {
    "created": "2020-10-19T10:11:52Z",
    "lastModified": "2020-10-19T16:11:52Z",
    "location": "https://mycompany.my.salesforce.com/services/scim/v2/Users/005RM0...",
    "resourceType": "User",
    "version": "f63f4831a8747d4bd0de70fcca991553be4b2e01"
  }
}

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