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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
from __future__ import annotations
from typing import Any, List # List is being used as list is already a method.
from ..rest import RestClient, RestClientOptions
from ..types import TimeoutType
class Roles:
"""Auth0 roles endpoints
Args:
domain (str): Your Auth0 domain, e.g: 'username.auth0.com'
token (str): Management API v2 Token
telemetry (bool, optional): Enable or disable Telemetry
(defaults to True)
timeout (float or tuple, optional): Change the requests
connect and read timeout. Pass a tuple to specify
both values separately or a float to set both to it.
(defaults to 5.0 for both)
protocol (str, optional): Protocol to use when making requests.
(defaults to "https")
rest_options (RestClientOptions): Pass an instance of
RestClientOptions to configure additional RestClient
options, such as rate-limit retries.
(defaults to None)
"""
def __init__(
self,
domain: str,
token: str,
telemetry: bool = True,
timeout: TimeoutType = 5.0,
protocol: str = "https",
rest_options: RestClientOptions | None = None,
) -> None:
self.domain = domain
self.protocol = protocol
self.client = RestClient(
jwt=token, telemetry=telemetry, timeout=timeout, options=rest_options
)
def _url(self, id: str | None = None) -> str:
url = f"{self.protocol}://{self.domain}/api/v2/roles"
if id is not None:
return f"{url}/{id}"
return url
def list(
self,
page: int = 0,
per_page: int = 25,
include_totals: bool = True,
name_filter: str | None = None,
):
"""List or search roles.
Args:
page (int, optional): The result's page number (zero based). By default,
retrieves the first page of results.
per_page (int, optional): The amount of entries per page. By default,
retrieves 25 results per page.
include_totals (bool, optional): True if the query summary is
to be included in the result, False otherwise. Defaults to True.
name_filter (str, optional): A case-insensitive filter to apply
to search for roles by name.
See: https://auth0.com/docs/api/management/v2#!/Roles/get_roles
"""
params = {
"per_page": per_page,
"page": page,
"include_totals": str(include_totals).lower(),
"name_filter": name_filter,
}
return self.client.get(self._url(), params=params)
def create(self, body: dict[str, Any]) -> dict[str, Any]:
"""Creates a new role.
Args:
body (dict): the attributes for the role to create.
See: https://auth0.com/docs/api/v2#!/Roles/post_roles
"""
return self.client.post(self._url(), data=body)
def get(self, id: str) -> dict[str, Any]:
"""Get a role.
Args:
id (str): The id of the role to retrieve.
See: https://auth0.com/docs/api/management/v2#!/Roles/get_roles_by_id
"""
return self.client.get(self._url(id))
def delete(self, id: str) -> Any:
"""Delete a role.
Args:
id (str): The id of the role to delete.
See: https://auth0.com/docs/api/management/v2#!/Roles/delete_roles_by_id
"""
return self.client.delete(self._url(id))
def update(self, id: str, body: dict[str, Any]) -> dict[str, Any]:
"""Update a role with the attributes passed in 'body'
Args:
id (str): The id of the role to update.
body (dict): the attributes to update on the role.
See: https://auth0.com/docs/api/management/v2#!/Roles/patch_roles_by_id
"""
return self.client.patch(self._url(id), data=body)
def list_users(
self,
id: str,
page: int = 0,
per_page: int = 25,
include_totals: bool = True,
from_param: str | None = None,
take: int | None = None,
):
"""List the users that have been associated with a given role.
Args:
id (str): The role's id.
page (int, optional): The result's page number (zero based). By default,
retrieves the first page of results.
per_page (int, optional): The amount of entries per page. By default,
retrieves 25 results per page.
include_totals (bool, optional): True if the query summary is
to be included in the result, False otherwise. Defaults to True.
from_param (str, optional): Checkpoint Id from which to begin retrieving results.
You can limit the number of entries using the take parameter.
take (int, optional): The total amount of entries to retrieve when
using the from parameter. When not set, the default value is up to the server.
See https://auth0.com/docs/api/management/v2#!/Roles/get_role_user
"""
params = {
"per_page": per_page,
"page": page,
"include_totals": str(include_totals).lower(),
"from": from_param,
"take": take,
}
url = self._url(f"{id}/users")
return self.client.get(url, params=params)
def add_users(self, id: str, users: List[str]) -> dict[str, Any]:
"""Assign users to a role.
Args:
id (str): The role's id.
users (list of str): A list of users ids to add to this role.
See https://auth0.com/docs/api/management/v2#!/Roles/post_role_users
"""
url = self._url(f"{id}/users")
body = {"users": users}
return self.client.post(url, data=body)
def list_permissions(
self, id: str, page: int = 0, per_page: int = 25, include_totals: bool = True
):
"""List the permissions associated to a role.
Args:
id (str): The role's id.
page (int, optional): The result's page number (zero based). By default,
retrieves the first page of results.
per_page (int, optional): The amount of entries per page. By default,
retrieves 25 results per page.
include_totals (bool, optional): True if the query summary is
to be included in the result, False otherwise. Defaults to True.
See https://auth0.com/docs/api/management/v2#!/Roles/get_role_permission
"""
params = {
"per_page": per_page,
"page": page,
"include_totals": str(include_totals).lower(),
}
url = self._url(f"{id}/permissions")
return self.client.get(url, params=params)
def remove_permissions(self, id: str, permissions: List[dict[str, str]]) -> Any:
"""Unassociates permissions from a role.
Args:
id (str): The role's id.
permissions (list of str): A list of permission ids to unassociate from the role.
See https://auth0.com/docs/api/management/v2#!/Roles/delete_role_permission_assignment
"""
url = self._url(f"{id}/permissions")
body = {"permissions": permissions}
return self.client.delete(url, data=body)
def add_permissions(self, id: str, permissions: List[dict[str, str]]) -> dict[str, Any]:
"""Associates permissions with a role.
Args:
id (str): The role's id.
permissions (list of str): A list of permission ids to associate to the role.
See https://auth0.com/docs/api/management/v2#!/Roles/post_role_permission_assignment
"""
url = self._url(f"{id}/permissions")
body = {"permissions": permissions}
return self.client.post(url, data=body)
|
