from __future__ import annotations
from typing import Any
from ..rest import RestClient, RestClientOptions
from ..types import TimeoutType
[docs]class Grants:
"""Auth0 grants 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/grants"
if id is not None:
return url + "/" + id
return url
[docs] def all(
self,
page: int | None = None,
per_page: int | None = None,
include_totals: bool = False,
extra_params: dict[str, Any] | None = None,
):
"""Retrieves all grants.
Args:
page (int, optional): The result's page number (zero based). When not set,
the default value is up to the server.
per_page (int, optional): The amount of entries per page. When not set,
the default value is up to the server.
include_totals (bool, optional): True if the query summary is
to be included in the result, False otherwise. Defaults to False.
extra_params (dictionary, optional): The extra parameters to add to
the request. The page, per_page, and include_totals values
specified as parameters take precedence over the ones defined here.
See: https://auth0.com/docs/api/management/v2#!/Grants/get_grants
"""
params = extra_params or {}
params.update(
{
"page": page,
"per_page": per_page,
"include_totals": str(include_totals).lower(),
}
)
return self.client.get(self._url(), params=params)
[docs] def delete(self, id: str) -> Any:
"""Deletes a grant.
Args:
id (str): The id of the grant to delete.
See: https://auth0.com/docs/api/management/v2#!/Grants/delete_grants_by_id
"""
url = self._url("%s" % (id))
return self.client.delete(url)