Create a new user

POST /Users

Creates a new user with the provided SCIM attributes.

✅ Supported SCIM User Properties in Adra

These properties are the only ones recognized by Adra; others are ignored at runtime.

🔹 SCIM Core Schema (`urn:ietf:params:scim:schemas:core:2.0:User`)

SCIM Field	Type	Description	Internal Mapping	Required
`userName`	string	Unique login identifier	`Username`	✅
`name.givenName`	string	User's first name	`FirstName`	✅
`name.familyName`	string	User's last name	`LastName`	✅
`emails`	array	Must be of type `work`, `primary: true`. Only one accepted.	`Email`	✅
`active`	boolean	User's activation status	`Active`	❌
`title`	string	User's job title	`Title`	❌
`timezone`	string	Olson format (e.g., `Europe/London`)	`TimeZone`	❌
`locale`	string	Language/region setting (e.g., `en-GB`)	`Culture`	❌
`preferredLanguage`	string	User's preferred language	`Language`	❌
`externalId`	string	External unique ID from IdP	`ExternalId`	❌
`id`	string	Adra-generated unique user ID	`OperatorGuid`	❌

🔹 Enterprise User Schema (`urn:ietf:params:scim:schemas:extension:enterprise:2.0:User`)

SCIM Field	Type	Description	Internal Mapping	Required
`employeeNumber`	string	Employee reference number	`EmployeeNumber`	❌

📌 Fields not listed above are explicitly ignored by the Adra SCIM client.

application/json

Body Required

enterpriseExtension object | null

Additional properties are NOT allowed.
Hide enterpriseExtension attribute Show enterpriseExtension attribute object | null
- employeeNumber string | null
active boolean
electronicMailAddresses array[object]
Hide electronicMailAddresses attributes Show electronicMailAddresses attributes object
- value string | null
- itemType string | null
- primary boolean
locale string | null
meta object | null

Additional properties are NOT allowed.
Hide meta attribute Show meta attribute object | null
- resourceType string | null
name object

Additional properties are NOT allowed.
Hide name attributes Show name attributes object
- familyName string
- givenName string
preferredLanguage string | null
timeZone string | null
title string | null
userName string
externalId string | null
schemas array[string] | null

Responses

200 application/scim+json

OK
Hide response attributes Show response attributes object
- enterpriseExtension object | null
  
  Additional properties are NOT allowed.
  
  Hide enterpriseExtension attribute Show enterpriseExtension attribute object | null
  
  employeeNumber string | null
- active boolean
- electronicMailAddresses array[object]
  
  Hide electronicMailAddresses attributes Show electronicMailAddresses attributes object
  
  value string | null
  
  itemType string | null
  
  primary boolean
- locale string | null
- meta object | null
  
  Additional properties are NOT allowed.
  
  Hide meta attribute Show meta attribute object | null
  
  resourceType string | null
- name object
  
  Additional properties are NOT allowed.
  
  Hide name attributes Show name attributes object
  
  familyName string
  
  givenName string
- preferredLanguage string | null
- timeZone string | null
- title string | null
- userName string
- externalId string | null
- schemas array[string] | null
201 application/scim+json

User created successfully
Hide response attributes Show response attributes object
- enterpriseExtension object | null
  
  Additional properties are NOT allowed.
  
  Hide enterpriseExtension attribute Show enterpriseExtension attribute object | null
  
  employeeNumber string | null
- active boolean
- electronicMailAddresses array[object]
  
  Hide electronicMailAddresses attributes Show electronicMailAddresses attributes object
  
  value string | null
  
  itemType string | null
  
  primary boolean
- locale string | null
- meta object | null
  
  Additional properties are NOT allowed.
  
  Hide meta attribute Show meta attribute object | null
  
  resourceType string | null
- name object
  
  Additional properties are NOT allowed.
  
  Hide name attributes Show name attributes object
  
  familyName string
  
  givenName string
- preferredLanguage string | null
- timeZone string | null
- title string | null
- userName string
- externalId string | null
- schemas array[string] | null
400 application/scim+json

Bad Request
Hide response attributes Show response attributes object
- type string | null
- title string | null
- status integer(int32) | null
- detail string | null
- instance string | null
401 application/scim+json

Unauthorized
Hide response attributes Show response attributes object
- type string | null
- title string | null
- status integer(int32) | null
- detail string | null
- instance string | null
403 application/scim+json

Forbidden
Hide response attributes Show response attributes object
- type string | null
- title string | null
- status integer(int32) | null
- detail string | null
- instance string | null
409

Resource already exists
500 application/scim+json

Internal Server Error
Hide response attributes Show response attributes object
- type string | null
- title string | null
- status integer(int32) | null
- detail string | null
- instance string | null
501 application/scim+json

Not Implemented
Hide response attributes Show response attributes object
- type string | null
- title string | null
- status integer(int32) | null
- detail string | null
- instance string | null

POST /Users

curl \
 --request POST 'https://setup.adra.com/api/organizations/{organizationSid}/scim/Users' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"name":{"givenName":"Jane","familyName":"Doe"},"title":"Product Manager","active":true,"emails":[{"type":"work","value":"jdoe@example.com","primary":true}],"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"timezone":"America/New_York","userName":"jdoe@example.com","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"employeeNumber":"0603"}}'

Request example

{
  "name": {
    "givenName": "Jane",
    "familyName": "Doe"
  },
  "title": "Product Manager",
  "active": true,
  "emails": [
    {
      "type": "work",
      "value": "jdoe@example.com",
      "primary": true
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User",
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
  ],
  "timezone": "America/New_York",
  "userName": "jdoe@example.com",
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "employeeNumber": "0603"
  }
}

Response examples (200)

{
  "enterpriseExtension": {
    "employeeNumber": "string"
  },
  "active": true,
  "electronicMailAddresses": [
    {
      "value": "string",
      "itemType": "string",
      "primary": true
    }
  ],
  "locale": "string",
  "meta": {
    "resourceType": "string"
  },
  "name": {
    "familyName": "string",
    "givenName": "string"
  },
  "preferredLanguage": "string",
  "timeZone": "string",
  "title": "string",
  "userName": "string",
  "externalId": "string",
  "schemas": [
    "string"
  ]
}

Response examples (201)

{
  "id": "abcdef12-3456-7890-abcd-ef1234567890",
  "meta": {
    "resourceType": "User"
  },
  "name": {
    "givenName": "Jane",
    "familyName": "Doe"
  },
  "title": "Product Manager",
  "active": true,
  "emails": [
    {
      "type": "work",
      "value": "jdoe@example.com",
      "primary": true
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User",
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
  ],
  "timezone": "America/New_York",
  "userName": "jdoe@example.com",
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "employeeNumber": "0603"
  }
}

Response examples (400)

{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}

Response examples (401)

{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}

Response examples (403)

{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}

Response examples (500)

{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}

Response examples (501)

{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}