Skip to main content
POST
/
scim
/
v2
/
users
Create user
curl --request POST \
  --url https://{instance}.omniapp.co/api/scim/v2/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "<string>",
  "userName": "jsmith@example.com",
  "urn:omni:params:1.0:UserAttribute": {}
}
'
{
  "id": "<string>",
  "userName": "<string>",
  "displayName": "<string>",
  "meta": {
    "resourceType": "User",
    "created": "2023-11-07T05:31:56Z",
    "lastModified": "2023-11-07T05:31:56Z"
  },
  "schemas": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

Use either an Organization API Key or Personal Access Token (PAT). Include in the Authorization header as: Bearer YOUR_TOKEN

Body

application/json
displayName
string
required

User display name

userName
string<email>
required

User email address

urn:omni:params:1.0:UserAttribute
object

Custom user attributes

Response

User created successfully

id
string
userName
string
displayName
string
meta
object
schemas
string[]