Skip to main content
Aria Knowledge Central


Retrieves every role for a given client.

For information on error messages generated by this API, see get_roles_m Error Messages.

Input Arguments

Req Field Name Field Type Max Length Description
client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.
role_no int Aria-assigned number of the role.
role_name string Display name of the role.
client_role_id string Client-assigned identifier of the role.
no_of users long Total number of users associated with the role.
  • Was this article helpful?