POST - /admin/user

General Information

Description

This API adds a user record to the tenant that has the external key sent in the request headers. 

Here is the business logic steps:

• Check is the user is already there, if yes return 
• Check the type of tenant adding the user (main or sub tenant)
  • if main tenant 
    • Add the user under the main tenant with the provided group
  • if sub tenant 
    • Add the user under the main tenant 
    • Invite the user to this subtenant with the provided group
• if pin object provided 
  • generate code if requested
  • turn on pin login if allowed
  • email the user the generated pin code using invitePin as documented under configuration
• if status is not provided, then pendingNew will be used as default
• if status is pendingNew then:
  • a token with expiration date gets generated 
  • an email will be sent to the user using addUser as documented under configuration
  • The email will contain a link protected by the generated token to be clicked to validate the user and set a password
  • Once the user is validated, the status will be set to active (if status is not active the user will not be able to login)
• If status is active or inactive 
  • an email will be sent to the user with the password using addUser as documented under configuration
  • if the password is not provided a generated password is sent to the user otherwise the provided password

Input

Type: application/json

Output

Response

SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response 

Valid Response

{ result: true, data: { id: '%new_user_ID%' } }

Invalid Response

{
    "result":false,
    "errors":{
        "codes":[602],
        "details":[
            {
                "code":602,
                "message":"Model error: + %model_error%"
            }
        ]
    }
}