Un-Invite User/s

Un-Invite User/s

General Information


Service

API

Method

Service

API

Method

urac

/admin/unInviteUsers

Put

 

Data Model: Users

Workflow: 

Input


Type: application/json

Name

Source

Mandatory

Type

Special Format

Description

Name

Source

Mandatory

Type

Special Format

Description

username

body

NO

Array

Array of strings

the user username (either username or email should be provided)

email

body

NO

Array

Array of strings

the user email (either username or email should be provided)

tenantId

Query

YES

String

 

 

 

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

Code

Description

405

Unable to find User. Please try again.

411

invalid 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 }