GetKeyRoles | Voximplant Voice AI

Gets roles of the specified key.

Example request: Get roles of the key.

Gets roles of the specified key.

Example request: Get roles of the key.

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

key_idstringRequired

The key's ID

with_expanded_rolesbooleanOptional

Whether to show the roles' additional properties

Response

Successful response

resultlist of objects

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.

Whether to show the roles' additional properties

1	{
2	"result": [
3	{
4	"role_name": "Support",
5	"role_id": 3,
6	"inherited": true,
7	"parent_role_id": [
8	1,
9	2
10	],
11	"gui_only": true
12	},
13	{
14	"role_name": "Accountant",
15	"role_id": 7,
16	"inherited": false,
17	"parent_role_id": [],
18	"gui_only": true
19	},
20	{
21	"role_name": "TestRole",
22	"role_id": 14,
23	"inherited": false,
24	"parent_role_id": [],
25	"gui_only": false
26	}
27	]
28	}

1	{
2	"result": [
3	{
4	"role_name": "Support",
5	"role_id": 3,
6	"inherited": true,
7	"parent_role_id": [
8	1,
9	2
10	],
11	"gui_only": true
12	},
13	{
14	"role_name": "Accountant",
15	"role_id": 7,
16	"inherited": false,
17	"parent_role_id": [],
18	"gui_only": true
19	},
20	{
21	"role_name": "TestRole",
22	"role_id": 14,
23	"inherited": false,
24	"parent_role_id": [],
25	"gui_only": false
26	}
27	]
28	}

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