PUT - /admin/users/uninvite

General Information


ServiceAPIMethodData ModelWorkflow
urac

/admin/users/uninvite

PUTUsers 

Description

For each user you sent the following happens:

  • check if user is there and is already invited to the tenant
  • if yes remove the tenant from allowedTenants  and push user to succeeded array response
  • if not push user to failed array response with reason "Model error: User: user [" + user(id, email, username) + "] was not uninvited."


Input


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

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

One of the following should exist under the user 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

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

NameMandatoryTypeSpecial FormatDescription
succeededYESArrayArray of ObjectsSucceeded response information

One of the following should exist under the succeeded object:

NameMandatoryTypeSpecial FormatDescription
idYESStringN/AUser ID
usernameYESStringN/AUsername
emailYESStringN/AUser Email
failedYESStringN/AFailed response information

NameMandatoryTypeSpecial FormatDescription
reasonYESStringN/AFailing 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

602Model error: + %model_error%