Get all Roles for a User

Returns all roles IDs associated with a user.

Method

/API2/access/getAllRolesByUser

  • API Section: /API2/access
  • API Version: 2.0
  • From Release: 2018.5
  • Usage: REST API only via POST actions.
  • Usage by:
    • Enterprise Admin

Method Signature

Input Parameters

Name

userId

Type

string

Description

The system user ID

Output Response

Successful Result Code

200

Response List Type

ItemId[]

Description of Response Type

Returns a generic response object with the list of all role IDs. Note that the response is returned as a list of items of this object type.

Notes

This method only returns role ID's. Use this method with 'getRoleById' to get the role object.