v1

latestOpenAPI 3.1.02026-08-04150110.3 KB
SCIM

Create a user

Given a body create the user in TeamOhana and return it to the user. If the password is not provided during creation a randomly generated password will be set for the user. The username should be an email id OR the emails field should contain at least one email with type work. The API will fail to create the user otherwise. By default the user is also provisioned in Auth0; set create-in-auth0 to false in the body when the user already exists in Auth0 (e.g. via SSO) — in that case externalId must be set to the Auth0 user_id. The user's role is taken from the roles attribute: the value of the entry whose type is teamohana (case-sensitive), is matched against the org's role names. When no such entry is present the user defaults to the employee role; when a matching role is supplied but does not exist the request fails with 400 invalidValue.

post/{domain}/Users

Path parameters

domainstring required

Request body

profileUrlstring nullable
{"stackTrail":"paths:/{domain}/Users:post:requestBody:content:application/json:schema:properties:schemas","oasType":"schema","type":"unknown"}
nicknamestring nullable
preferredLanguagestring nullable
timezonestring nullable
displayNamestring nullable
userTypestring nullable
localestring nullable
urn:ietf:params:scim:schemas:extension:enterprise:2.0:Userobject
userNamestring required
titlestring nullable
create-in-auth0boolean
passwordstring nullable
activeboolean
externalIdstring

Response

profileUrlstring nullable
{"stackTrail":"paths:/{domain}/Users:post:responses:201:content:application/json:schema:properties:schemas","oasType":"schema","type":"unknown"}
nicknamestring nullable
preferredLanguagestring nullable
timezonestring nullable
displayNamestring nullable
idstring required
userTypestring nullable
localestring nullable
urn:ietf:params:scim:schemas:extension:enterprise:2.0:Userobject
userNamestring required
titlestring nullable
passwordstring nullable
activeboolean
externalIdstring