Getroles

Get the roles of a user.

Note that this will return all roles of the user on the current level and all lower levels. I.e. if you request the roles in a customer, you will also get the roles for all accounts in that customer.

Tokens

This action requires the following tokens:

  • user-read

Arguments

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

Argument Type Default Description
user Hash   The ID of the user to get the roles of
customer Hash   The customer to view the roles in. Cannot be given if an account is given. If neither a customer nor an account is given, they will be copied from the request parameters.
account Hash   The account to view the roles in. Cannot be given if a customer is given. If neither a customer nor an account is given, they will be copied from the request parameters.

Output

This action produces the following output on success:

An array containing zero or more elements, each one being an object containing the following fields:

Name Type Description
role

Role of this user role

The value of this field is 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

account

ID of the account

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

Name Type Description
id Hash Account ID
name String Account name
customer

ID of the customer

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

Errors

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

STATUS_USER_NOT_FOUND (310)
If the user specified by “user” can not be found