Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 5 Next »

General Information

Service
API
Method
Data Model
Workflow
urac

/admin/users/invite

PUTUsers 


Input

Type: application/json
NameSourceMandatoryTypeSpecial FormatDescription
UsersBodyYESObjectincludes user object, groups array, and pin object

NameSourceMandatoryTypeSpecial FormatDescription
groupsBodyNOArrayArray of stringsGroups array
pinBodyNOObjectincludes code and allowed parametersPin Object

Name
Mandatory
Type
Description
codeYESBooleanset to True to create a random generated code 
allowedYESBoolean

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

userBodyYESObjectIncludes one of id, username, or emailUser Object

One of the following should exist under the user object:

Name
Mandatory
Type
Special Format
Description
idYESStringN/AUser ID
usernameYESStringN/AUsername
emailYESStringN/AUser 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 Expand source 
{ 
  result: true,
  data: 1
}

Invalid Response

Error Response Sample Expand source 
{
    "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

602Model error: + %model_error%
  • No labels