Adds a user

POST

/users

Users

Adds a user. No two users can have the same email address. Email is saved WITH case but compared regardless of case. Email can be changed for a user assuming it doesn't cause a conflict.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://learnifier.com/users' \
--header 'Content-Type: application/json' \
--data-raw '{
    "displayName": "Jane Doe",
    "externalId": "string",
    "firstName": "Jane",
    "hardLock": true,
    "homeOrg": 1234,
    "lastName": "Doe",
    "locale": "en-US",
    "primaryEmail": "jane.doe@example.com"
}'

Response Example

200 - Example 1

{
    "userId": "81590981-1e05-4fd5-aa15-15bc4b06cf7f"
}

Request

Body Params application/json

displayName

string

optional

The name shown when the user is listed

Example:

Jane Doe

externalId

string

optional

The external id (foreign key). Must not exceed 255 characters.

firstName

string

optional

The first (given) name of the user

Example:

Jane

hardLock

boolean

optional

True if the user should be locked from the system

homeOrg

integer <int64>

optional

The primary organization for the user. Must match the id of an Organization Unit.

Example:

1234

lastName

optional

The last name (surname) of the user

Example:

Doe

locale

string <locale>

optional

The user's preferred language/locale setting. Affects date and number formatting.

Example:

en-US

primaryEmail

string

optional

The primary email for the user. Used for communication from the platform.

Example:

jane.doe@example.com

Examples

Responses

🟢200User was successfully added

application/json

Body

userId

string <uuid>

optional

The user id

Example:

81590981-1e05-4fd5-aa15-15bc4b06cf7f

🟠409A user with the same primary email already existed.

🔴500Unexpected error

Lists all users

User information