Removetoken

Remove one or more tokens from a role

Tokens

This action requires the following tokens:

  • role-write

Arguments

Required arguments are marked in bold, and optional arguments are marked in italics.

Argument Type Default Description
role Hash   ID of the role to add a token to
token Array of Label   Names of the tokens to remove from the role

Output

This action produces the following output on success:

An object containing the following fields:

Name Type Description
id Hash Role ID
name String The name of this role
customer

The customer of this role, if any

The value of this field is an object containing the following fields:

Name Type Description
id Hash Customer ID
name String The name of this customer
datecreated DateTime When this customer was created
datemodified DateTime When this customer was last modified
tokens

Tokens for this role

The value of this field is an array containing zero or more elements, each one being one Label

Errors

This action can return one of the default status codes, or one of the following status codes on error:

STATUS_ROLE_NOT_FOUND (270)
The requested role could not be found
STATUS_TOKEN_NOT_FOUND (271)
One of the requested tokens could not be found
STATUS_ROLE_DOES_NOT_HAVE_TOKEN (273)
The role does not have one of the tokens
STATUS_ROLE_NOT_PERMITTED (274)
One of the requested tokens can not be added by the current actor