Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

General Information

...

Data Model: Users

Workflow: 

Input

...

Type: application/json
NameSourceMandatoryTypeSpecial FormatDescription
users

bodyYesArrayarray of objectsarray of users to be invites

username

NOStringN/Athe user username (either username or email should be provided)

email

NOStringN/Athe user email (either username or email should be provided)tenantIdYESStringtenantCodeYESString

groups

NOArrayArray of strings

pin

NOObject



code
YESBoolean
set to True to create a random generated code 


allowed
YESBoolean

set to True if this user is allowed to start pin code login

...

Code Block
languagebash
titleCalling Get User API
 > CURL -X POST http://127.0.0.1:4000/urac/admin/inviteUsers --data '{"users": 
	[
		{
			username: "username",
			email: "email@email.com",
			tenantId: "324234",
			tenantCode: "code",
			pin : {
					code: true,
					allowed: true,
					}
			groups : ["group"]
		}
	]
}'

Response

Code Block
languagejs
titleGet User API response
{
    "result": true,
    "data": [{
		username: "username",
		email: "email@email.com"
	}]
}

...