Un-Invite User/s

General Information

Service	API	Method	Data Model	Workflow
urac	/admin/users/uninvite	PUT	Users

Description

This API uninvites users that have an id, username, or email that fits the one sent in the user object in the request body to subtenant that has the external key sent in the request headers.

Input

Type: application/json

Name

Source

Mandatory

Type

Special Format

Description

Users

Body

YES

Object

includes user object, groups array, and pin object

Name

Source

Mandatory

Type

Special Format

Description

user

Body

YES

Object

Includes one of id, username, or email

User Object

One of the following should exist under the user object:

Name	Mandatory	Type	Special Format	Description
id	YES	String	N/A	User ID
username	YES	String	N/A	Username
email	YES	String	N/A	User 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

{ 
  result: true,
  data: { 
	succeeded: [ { id: '5da721b6c257840b3fe44377' } ],
  	failed: [] 
  }
}

Invalid Response

Error Response Sample

{
    "result":false,
    "errors":{
        "codes":[602],
        "details":[
            {
                "code":602,
                "message":"Model error: + %model_error%"
            }
        ]
    }
}

Response validation

Name

Mandatory

Type

Special Format

Description

succeeded

YES

Array

Array of Objects

Succeeded response information

One of the following should exist under the succeeded object:

Name	Mandatory	Type	Special Format	Description
id	YES	String	N/A	User ID
username	YES	String	N/A	Username
email	YES	String	N/A	User Email

failed

YES

String

N/A

Failed response information

Name	Mandatory	Type	Special Format	Description
reason	YES	String	N/A	Failing reason

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes

Code	Description
400	Business logic required data are missing
530	Users array is required
602	Model error: + %model_error%