Get roles

This endpoint lists the available roles for a site and their ID. This ID is necessary when adding a user; the IDs are unique per site.

0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
Endpoint: "/v1.1/sites/{site_id}/roles"
Method: GET

Parameters:
Path {
site_id;
type: string, format: uuid;
required

site_id
}(string)
Response Content Type (application/json):
{
  
items;
type: array

items returned as result

"items"
: [ {
id;
type: string, format: uuid;

The id of the role

"id"
: "string",
customer_reference;
type: string

The name of the role

"customer_reference"
: "string",
code;
type: string

The code of the role

"code"
: "string",
parent_id;
type: string, format: uuid;

The id of the parent role

"parent_id"
: "string",
is_hierarchical;
type: boolean

Is role hierarchical

"is_hierarchical"
: boolean } ],
next_page_link;
type: string

next page uri link

"next_page_link"
: "string",
count;
type: integer, format: int64;

number of items returned

"count"
: "integer" }