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
[docs]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
[docs] 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)
[docs] 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)
[docs] 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))
[docs] 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))
[docs] 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)
[docs] 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)
[docs] 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)
[docs] 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)
[docs] def remove_permissions(self, id: str, permissions: List[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)
[docs] def add_permissions(self, id: str, permissions: List[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)