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
|
from __future__ import annotations
from typing import Any
from ..rest import RestClient, RestClientOptions
from ..types import TimeoutType
class Hooks:
"""Hooks endpoint implementation.
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/hooks"
if id is not None:
return f"{url}/{id}"
return url
def all(
self,
enabled: bool = True,
fields: list[str] | None = None,
include_fields: bool = True,
page: int | None = None,
per_page: int | None = None,
include_totals: bool = False,
):
"""Retrieves a list of all hooks.
Args:
enabled (bool, optional): If provided, retrieves hooks that match
the value, otherwise all hooks are retrieved.
fields (list, optional): A list of fields to include or exclude
(depending on include_fields) from the result, empty to
retrieve all fields.
include_fields (bool, optional): True if the fields specified are
to be included in the result, False otherwise
(defaults to true).
page (int, optional): The result's page number (zero based).
per_page (int, optional): The amount of entries per page.
include_totals (bool, optional): True if the query summary is
to be included in the result, False otherwise.
See: https://auth0.com/docs/api/management/v2#!/Hooks/get_hooks
"""
params = {
"fields": fields and ",".join(fields) or None,
"include_fields": str(include_fields).lower(),
"page": page,
"per_page": per_page,
"include_totals": str(include_totals).lower(),
}
# since the default is True, this is here to disable the filter
if enabled is not None:
params["enabled"] = str(enabled).lower()
return self.client.get(self._url(), params=params)
def create(self, body: dict[str, Any]) -> dict[str, Any]:
"""Creates a new Hook.
Args:
body (dict): Attributes for the newly created hook,
See: https://auth0.com/docs/api/v2#!/Hooks/post_hooks
"""
return self.client.post(self._url(), data=body)
def get(self, id: str, fields: list[str] | None = None) -> dict[str, Any]:
"""Retrieves a hook by its ID.
Args:
id (str): The id of the hook to retrieve.
fields (list, optional): A list of fields to include or exclude
(depending on include_fields) from the result, empty to
retrieve all fields.
See: https://auth0.com/docs/api/management/v2#!/Hooks/get_hooks_by_id
"""
params = {
"fields": fields and ",".join(fields) or None,
}
return self.client.get(self._url(id), params=params)
def delete(self, id: str) -> Any:
"""Deletes a hook.
Args:
id (str): The id of the hook to delete.
See: https://auth0.com/docs/api/management/v2#!/Hooks/delete_hooks_by_id
"""
return self.client.delete(self._url(id))
def update(self, id: str, body: dict[str, Any]) -> dict[str, Any]:
"""Updates an existing hook.
Args:
id (str): The id of the hook to modify.
body (dict): Attributes to modify.
See: https://auth0.com/docs/api/v2#!/Hooks/patch_hooks_by_id
"""
return self.client.patch(self._url(id), data=body)
def get_secrets(self, id: str) -> dict[str, Any]:
"""Retrieves a hook's secrets.
Args:
id (str): The id of the hook to retrieve secrets from.
See: https://auth0.com/docs/api/management/v2#!/Hooks/get_secrets
"""
return self.client.get(self._url("%s/secrets" % id))
def add_secrets(self, id: str, body: dict[str, Any]) -> dict[str, Any]:
"""Add one or more secrets for an existing hook.
Args:
id (str): The id of the hook to add secrets to.
body (dict): Dict of key-value pairs where the value must be a string.
See: https://auth0.com/docs/api/management/v2#!/Hooks/post_secrets
"""
return self.client.post(self._url("%s/secrets" % id), data=body)
def delete_secrets(self, id: str, body: list[str]) -> Any:
"""Delete one or more existing secrets for an existing hook.
Args:
id (str): The id of the hook to add secrets to.
body (list): List of secret names to delete.
See: https://auth0.com/docs/api/management/v2#!/Hooks/delete_secrets
"""
return self.client.delete(self._url("%s/secrets" % id), data=body)
def update_secrets(self, id: str, body: dict[str, Any]) -> dict[str, Any]:
"""Update one or more existing secrets for an existing hook.
Args:
id (str): The id of the hook to add secrets to.
body (dict): Dict of key-value pairs where the value must be a string.
See: https://auth0.com/docs/api/management/v2#!/Hooks/patch_secrets
"""
return self.client.patch(self._url("%s/secrets" % id), data=body)
|
