Invite User/s

General Information

Service	API	Method	Data Model	Workflow
urac	/admin/users/invite	PUT	Users

Input

Type: application/json

Name

Source

Mandatory

Type

Special Format

Description

Users

Body

YES

Object

includes user object, groups array, and pin object

Name

Source

Mandatory

Type

Special Format

Description

groups

Body

NO

Array

Array of strings

Groups array

Body

NO

Object

includes code and allowed parameters

Pin Object

Name	Mandatory	Type	Description
code	YES	Boolean	set to True to create a random generated code
allowed	YES	Boolean	set to True if this user is allowed to start pin code login

user

Body

YES

Object

Includes one of id, username, or email

User Object

One of the following should exist under the user object:

Name	Mandatory	Type	Special Format	Description
id	YES	String	N/A	User ID
username	YES	String	N/A	Username
email	YES	String	N/A	User Email

Output

Response

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

Valid Response

Valid Response Sample

{ 
  result: true,
  data: 1
}

Invalid Response

Error Response Sample

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

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes

Code	Description
400	Business logic required data are missing
520	Unable to find user
602	Model error: + %model_error%