Sign in
latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

user-controller

Save Or update User (saveUser)

Create or update the User. When creating user, platform generates User Id as time-based UUID. The newly created User Id will be present in the response. Specify existing User Id to update the device. Referencing non-existing User Id will cause 'Not Found' error.

Device email is unique for entire platform setup.Remove 'id', 'tenantId' and optionally 'customerId' from the request body example (below) to create new User entity.

Available for users with 'SYS_ADMIN', 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.

post/api/user

Query parameters

sendActivationMailstring

Send activation email (or use activation link)

Request body

createdTimeinteger

Timestamp of the user creation, in milliseconds

emailstring required

Email of the user

authority'SYS_ADMIN' | 'TENANT_ADMIN' | 'CUSTOMER_USER' | 'REFRESH_TOKEN' | 'PRE_VERIFICATION_TOKEN' | 'MFA_CONFIGURATION_TOKEN' required

Authority

firstNamestring

First name of the user

lastNamestring

Last name of the user

phonestring

Phone number of the user

versioninteger
namestring

Duplicates the email of the user, readonly

{"stackTrail":"components:schemas:JsonNode","oasType":"schema","type":"unknown","description":"A value representing the any type (object or primitive)","example":{}}

Example request

{
  "id": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "USER"
  },
  "createdTime": 1609459200000,
  "tenantId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "TENANT"
  },
  "customerId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "CUSTOMER"
  },
  "email": "user@example.com",
  "authority": "SYS_ADMIN, TENANT_ADMIN or CUSTOMER_USER",
  "firstName": "John",
  "lastName": "Doe",
  "name": "user@example.com",
  "additionalInfo": {}
}

Response

OK

createdTimeinteger

Timestamp of the user creation, in milliseconds

emailstring required

Email of the user

authority'SYS_ADMIN' | 'TENANT_ADMIN' | 'CUSTOMER_USER' | 'REFRESH_TOKEN' | 'PRE_VERIFICATION_TOKEN' | 'MFA_CONFIGURATION_TOKEN' required

Authority

firstNamestring

First name of the user

lastNamestring

Last name of the user

phonestring

Phone number of the user

versioninteger
namestring

Duplicates the email of the user, readonly

{"stackTrail":"components:schemas:JsonNode","oasType":"schema","type":"unknown","description":"A value representing the any type (object or primitive)","example":{}}

Example response

{
  "id": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "USER"
  },
  "createdTime": 1609459200000,
  "tenantId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "TENANT"
  },
  "customerId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "CUSTOMER"
  },
  "email": "user@example.com",
  "authority": "SYS_ADMIN, TENANT_ADMIN or CUSTOMER_USER",
  "firstName": "John",
  "lastName": "Doe",
  "name": "user@example.com",
  "additionalInfo": {}
}