Skip to main content
PUT
/
scim
/
v2
/
users
/
{userId}
Replace user
curl --request PUT \
  --url https://{instance}.omniapp.co/api/scim/v2/users/{userId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userName": "blob.ross@blobsrus.co",
  "active": true,
  "displayName": "Blob Ross",
  "urn:omni:params:1.0:UserAttribute": {
    "good_blob": "yes"
  }
}
'
{
  "active": true,
  "displayName": "Blob Ross",
  "emails": [
    {
      "primary": true,
      "value": "blob.ross@blobsrus.co"
    }
  ],
  "groups": [],
  "id": "9e8719d9-276a-4964-9395-a493189a247c",
  "meta": {
    "created": "2024-12-03T23:13:14.109Z",
    "lastModified": "2024-12-03T23:13:14.109Z",
    "resourceType": "User"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "userName": "blob.ross@blobsrus.co",
  "urn:omni:params:1.0:UserAttribute": {
    "good_blob": "yes"
  }
}

Authorizations

​
Authorization
string
header
required

Requires an Organization API Key. Personal Access Tokens (PATs) are not supported for this endpoint.

Include in the Authorization header as: Bearer ORGANIZATION_API_KEY

Path Parameters

​
userId
string
required

The ID of the user to be replaced

Body

application/json
​
userName
string<email>
required

The user's email address.

Example:

"blob.ross@blobsrus.co"

​
active
boolean
default:true

Whether the user is active. Set to false to deactivate the user.

Example:

true

​
displayName
string

The user's display name

Example:

"Blob Ross"

​
urn:omni:params:1.0:UserAttribute
object

User attributes as key/value pairs, where keys map to the IDs of user attributes defined in Omni. This is the Reference column in the User attributes page.

Example:
{ "good_blob": "yes" }

Response

User replaced successfully

​
id
string

Unique identifier for the user

​
userName
string

The user's email address

​
displayName
string

The user's display name

​
active
boolean

Whether the user is active

​
emails
object[]

The user's email addresses

​
groups
object[]

User groups that the user belongs to

​
meta
object
​
schemas
string[]

SCIM information about the type of schemas used in the API. For example, urn:ietf:params:scim:schemas:core:2.0:User

​
urn:omni:params:1.0:UserAttribute
object

User attributes as key/value pairs, where keys map to the IDs of user attributes defined in Omni. This is the Reference column in the User attributes page.

​
urn:omni:params:scim:schemas:extension:user:2.0
object

Omni SCIM extension schema containing additional user metadata