GetAdminRoles | Voximplant Voice AI

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.

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](/api-reference/management-api/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 objects

total_countinteger

The total found admin role count

countinteger

The returned admin role count

1	{
2	"result": [
3	{
4	"admin_role_id": 10,
5	"admin_role_name": "read_history",
6	"admin_role_active": true,
7	"system_role": false,
8	"modified": "2014-12-05 10:27:30",
9	"allowed_entries": [
10	"GetHistoryReports",
11	"GetTransactionHistory",
12	"GetCallHistory"
13	],
14	"denied_entries": [],
15	"admin_users": [
16	{
17	"admin_user_id": 11
18	}
19	]
20	}
21	],
22	"total_count": 1,
23	"count": 1
24	}

$	curl -X POST https://api.voximplant.com/platform_api/GetAdminRoles \
>	-H "Authorization: Bearer <token>"