Invite User/s

General Information

Description

• This API invites users that have an id, username, or email that fits the one sent in the user object in the request body to the tenant or subtenant that has the external key sent in the request headers.
• The user will have an automatically generated code if the code parameter under the pin object is set to be true.
• An email with the generated code will be sent to the user.
• The user will be allowed to trigger pin login if the allowed parameter under the same object is set to be true. If the allowed parameter is set to false, another user with allowed pin login should enable pin login in that specific tenant so users that have pin access can log in by pin.
• The invited user will have the subtenant that was invited to under allowedTenants array in config object.

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: { 
	succeeded: [ { id: '%user_id%' } ],
  	failed: [] 
  }
}

{
  "succeeded": [],
  "failed": [
    {
      "id": "%user_id%",
      "reason": "User has already been invited."
    }
  ]
}

Invalid Response

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

Response validation