Invite Users (bulk invite)

General Information

Service	API	Method
urac	/admin/inviteUsers	Post

Data Model: Users

Workflow:

Input

Type: application/json

Name			Source	Mandatory	Type	Special Format	Description
users			body	Yes	Array	array of objects	array of users to be invites
	username			NO	String	N/A	the user username (either username or email should be provided)
	email			NO	String	N/A	the user email (either username or email should be provided)
	groups			NO	Array	Array of strings
	pin			NO	Object
		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

Output

Valid Response

Valid Response Sample

{
	"result": true,
	"data": {
		"..."	
	}
}

Invalid Response

Error Response Sample

{
    "result":false,
    "errors":{
        "codes":[411],
        "details":[
            {
                "code":411,
                "message":"invalid user id provided"
            }
        ]
    }
}

Error Codes

Code	Description
405	Unable to find User. Please try again.
411	invalid user id provided

Example (CURL)

Request

Calling Get User API

 > CURL -X POST http://127.0.0.1:4000/urac/admin/inviteUsers --data '{"users": 
	[
		{
			username: "username",
			email: "email@email.com",
			pin : {
					code: true,
					allowed: true,
					}
			groups : ["group"]
		}
	]
}'

Response

Get User API response

{
    "result": true,
    "data": [{
		username: "username",
		email: "email@email.com"
	}]
}