Skip to navigation
Management APIReferenceAdmin Roles

GetAdminRoles

View as Markdown

Gets the admin roles.

Example request: Get two admin roles attached to the admin_user_id=22.

Authentication

AuthorizationBearer

Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the Authorization header as a Bearer value:

Authorization: Bearer $VOXIMPLANT_TOKEN

See Authorization for ready-to-copy snippets in bash, Python, Node.js and Go that turn your credentials.json into a token.

Query parameters

admin_role_idintegerOptional
The admin role ID to filter
admin_role_namestringOptional
The admin role name part to filter
admin_role_activebooleanOptional
Whether the admin role is enabled to filter
with_entriesbooleanOptionalDefaults to false
Whether to get the permissions
with_account_rolesbooleanOptionalDefaults to true
Whether to include the account roles
with_parent_rolesbooleanOptionalDefaults to true
Whether to include the parent roles
included_admin_user_idlist of integersOptional

The attached admin user ID list separated by semicolons (;). Use the 'all' value to select all admin users

excluded_admin_user_idlist of integersOptional

Not attached admin user ID list separated by semicolons (;). Use the 'all' value to select all admin users

full_admin_users_matchingstringOptionalDefaults to false
Set false to get roles with partial admin user list matching
showing_admin_user_idintegerOptional

The admin user to show in the 'admin_users' field output

countintegerOptionalDefaults to 20
The max returning record count
offsetintegerOptionalDefaults to 0

The first N records are skipped in the output

Response

Successful response
resultlist of objectsOptional
total_countintegerOptional
The total found admin role count
countintegerOptional
The returned admin role count