Un-Invite User/s

Owned by Ragheb Bou Dargham (Unlicensed)
Last updated: Jul 03, 2019 by Fadi Nasr (Unlicensed)

General Information

ServiceAPIMethod
urac/admin/unInviteUsersPut


Data Model: Users

Workflow: 

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

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
405Unable to find User. Please try again.
411invalid user id provided


Example (CURL)

Request

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

Response

Get User API response
{
    "result": true,
    "data": true
}