Versions Compared

Key

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

...

General Information

...

ServiceAPIMethodData ModelWorkflow
urac

/admin/

unInviteUsers

users/uninvite

PUT

...

...

 


Input

...

Type: application/json
NameSourceMandatoryTypeSpecial FormatDescription
usernamebodyNOArrayArray of stringsthe user username (either username or email should be provided)emailbodyNOArrayArray of stringsthe user email (either username or email should be provided)tenantIdQueryYESString

Output

UsersBodyYESObjectincludes user object, groups array, and pin object


NameSourceMandatoryTypeSpecial FormatDescription
userBodyYESObjectIncludes one of id, username, or emailUser Object


NameMandatoryTypeSpecial FormatDescription
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

Code Block
languagejs
titleValid Response Sample
linenumberstrue
collapsetrue
{ 
  	"result": true,
  	"data": {
		"..."	
	}1
}

Invalid Response

Code Block
languagejs
titleError Response Sample
linenumberstrue
collapsetrue
{
    "result":false,
    "errors":{
        "codes":[411602],
        "details":[
            {
                "code":411602,
                "message":"invalidModel usererror: id+ provided%model_error%"
            }
        ]
    }
}

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes


...


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

Request

Code Block
languagebash
titleCalling Get User API
 > CURL -X PUT http://127.0.0.1:4000/urac/admin/inviteUser?tenantId=xyz --data '{"username":["xyz"], "email":"[xyz"]}'

Response

...

languagejs
titleGet User API response
400

Business logic required data are missing

530

Users array is required

602Model error: + %model_error%