-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
run ruff format in tests and docstrings, remove blacken-docs
- Loading branch information
Showing
15 changed files
with
344 additions
and
272 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,141 +1,139 @@ | ||
| """Implements subclasses for [Auth0](https://auth0.com).""" | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| from typing import Any | ||
|
|
||
| import requests | ||
| from jwskate import Jwk | ||
|
|
||
| from requests_oauth2client import ApiClient, OAuth2Client, OAuth2ClientCredentialsAuth | ||
|
|
||
|
|
||
| class Auth0: | ||
| """Auth0-related utilities.""" | ||
|
|
||
| @classmethod | ||
| def tenant(cls, tenant: str) -> str: | ||
| """Given a short tenant name, returns the full tenant FQDN.""" | ||
| if not tenant: | ||
| msg = "You must specify a tenant name." | ||
| raise ValueError(msg) | ||
| if ( | ||
| "." not in tenant | ||
| or tenant.endswith(".eu") | ||
| or tenant.endswith(".us") | ||
| or tenant.endswith(".au") | ||
| or tenant.endswith(".jp") | ||
| ): | ||
| tenant = f"{tenant}.auth0.com" | ||
| if "://" in tenant: | ||
| if tenant.startswith("https://"): | ||
| return tenant[8:] | ||
| msg = ( | ||
| "Invalid tenant name. " | ||
| "It must be a tenant name like 'mytenant.myregion' " | ||
| "or a full FQDN like 'mytenant.myregion.auth0.com'." | ||
| "or an issuer like 'https://mytenant.myregion.auth0.com'" | ||
| ) | ||
| raise ValueError(msg) | ||
| return tenant | ||
|
|
||
| @classmethod | ||
| def client( | ||
| cls, | ||
| tenant: str, | ||
| auth: ( | ||
| requests.auth.AuthBase | tuple[str, str] | tuple[str, Jwk] | tuple[str, dict[str, Any]] | str | None | ||
| ) = None, | ||
| *, | ||
| client_id: str | None = None, | ||
| client_secret: str | None = None, | ||
| private_jwk: Any | None = None, | ||
| session: requests.Session | None = None, | ||
| **kwargs: Any, | ||
| ) -> OAuth2Client: | ||
| """Initialise an OAuth2Client for an Auth0 tenant.""" | ||
| tenant = cls.tenant(tenant) | ||
| token_endpoint = f"https://{tenant}/oauth/token" | ||
| authorization_endpoint = f"https://{tenant}/authorize" | ||
| revocation_endpoint = f"https://{tenant}/oauth/revoke" | ||
| userinfo_endpoint = f"https://{tenant}/userinfo" | ||
| jwks_uri = f"https://{tenant}/.well-known/jwks.json" | ||
|
|
||
| return OAuth2Client( | ||
| auth=auth, | ||
| client_id=client_id, | ||
| client_secret=client_secret, | ||
| private_jwk=private_jwk, | ||
| session=session, | ||
| token_endpoint=token_endpoint, | ||
| authorization_endpoint=authorization_endpoint, | ||
| revocation_endpoint=revocation_endpoint, | ||
| userinfo_endpoint=userinfo_endpoint, | ||
| issuer=tenant, | ||
| jwks_uri=jwks_uri, | ||
| **kwargs, | ||
| ) | ||
|
|
||
| @classmethod | ||
| def management_api_client( | ||
| cls, | ||
| tenant: str, | ||
| auth: ( | ||
| requests.auth.AuthBase | tuple[str, str] | tuple[str, Jwk] | tuple[str, dict[str, Any]] | str | None | ||
| ) = None, | ||
| *, | ||
| client_id: str | None = None, | ||
| client_secret: str | None = None, | ||
| private_jwk: Any | None = None, | ||
| session: requests.Session | None = None, | ||
| **kwargs: Any, | ||
| ) -> ApiClient: | ||
| """Initialize a client for the Auth0 Management API. | ||
| See [Auth0 Management API v2](https://auth0.com/docs/api/management/v2). You must provide the | ||
| target tenant name and the credentials for a client that is allowed access to the Management | ||
| API. | ||
| Args: | ||
| tenant: the tenant name. | ||
| Same definition as for [Auth0.client][requests_oauth2client.vendor_specific.auth0.Auth0.client] | ||
| auth: client credentials. | ||
| Same definition as for [OAuth2Client][requests_oauth2client.client.OAuth2Client] | ||
| client_id: the Client ID. | ||
| Same definition as for [OAuth2Client][requests_oauth2client.client.OAuth2Client] | ||
| client_secret: the Client Secret. | ||
| Same definition as for [OAuth2Client][requests_oauth2client.client.OAuth2Client] | ||
| private_jwk: the private key to use for client authentication. | ||
| Same definition as for [OAuth2Client][requests_oauth2client.client.OAuth2Client] | ||
| session: requests session. | ||
| Same definition as for [OAuth2Client][requests_oauth2client.client.OAuth2Client] | ||
| **kwargs: additional kwargs to pass to the ApiClient base class | ||
| Usage: | ||
| ```python | ||
| from requests_oauth2client.vendor_specific import Auth0 | ||
| a0mgmt = Auth0.management_api_client( | ||
| "mytenant.eu", client_id=client_id, client_secret=client_secret | ||
| ) | ||
| users = a0mgmt.get("users", params={"page": 0, "per_page": 100}) | ||
| ``` | ||
| """ | ||
| tenant = cls.tenant(tenant) | ||
| client = cls.client( | ||
| tenant, | ||
| auth=auth, | ||
| client_id=client_id, | ||
| client_secret=client_secret, | ||
| private_jwk=private_jwk, | ||
| session=session, | ||
| ) | ||
| audience = f"https://{tenant}/api/v2/" | ||
| api_auth = OAuth2ClientCredentialsAuth(client, audience=audience) | ||
| return ApiClient( | ||
| base_url=audience, | ||
| auth=api_auth, | ||
| session=session, | ||
| **kwargs, | ||
| ) | ||
| """Implements subclasses for [Auth0](https://auth0.com).""" | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| from typing import Any | ||
|
|
||
| import requests | ||
| from jwskate import Jwk | ||
|
|
||
| from requests_oauth2client import ApiClient, OAuth2Client, OAuth2ClientCredentialsAuth | ||
|
|
||
|
|
||
| class Auth0: | ||
| """Auth0-related utilities.""" | ||
|
|
||
| @classmethod | ||
| def tenant(cls, tenant: str) -> str: | ||
| """Given a short tenant name, returns the full tenant FQDN.""" | ||
| if not tenant: | ||
| msg = "You must specify a tenant name." | ||
| raise ValueError(msg) | ||
| if ( | ||
| "." not in tenant | ||
| or tenant.endswith(".eu") | ||
| or tenant.endswith(".us") | ||
| or tenant.endswith(".au") | ||
| or tenant.endswith(".jp") | ||
| ): | ||
| tenant = f"{tenant}.auth0.com" | ||
| if "://" in tenant: | ||
| if tenant.startswith("https://"): | ||
| return tenant[8:] | ||
| msg = ( | ||
| "Invalid tenant name. " | ||
| "It must be a tenant name like 'mytenant.myregion' " | ||
| "or a full FQDN like 'mytenant.myregion.auth0.com'." | ||
| "or an issuer like 'https://mytenant.myregion.auth0.com'" | ||
| ) | ||
| raise ValueError(msg) | ||
| return tenant | ||
|
|
||
| @classmethod | ||
| def client( | ||
| cls, | ||
| tenant: str, | ||
| auth: ( | ||
| requests.auth.AuthBase | tuple[str, str] | tuple[str, Jwk] | tuple[str, dict[str, Any]] | str | None | ||
| ) = None, | ||
| *, | ||
| client_id: str | None = None, | ||
| client_secret: str | None = None, | ||
| private_jwk: Any | None = None, | ||
| session: requests.Session | None = None, | ||
| **kwargs: Any, | ||
| ) -> OAuth2Client: | ||
| """Initialise an OAuth2Client for an Auth0 tenant.""" | ||
| tenant = cls.tenant(tenant) | ||
| token_endpoint = f"https://{tenant}/oauth/token" | ||
| authorization_endpoint = f"https://{tenant}/authorize" | ||
| revocation_endpoint = f"https://{tenant}/oauth/revoke" | ||
| userinfo_endpoint = f"https://{tenant}/userinfo" | ||
| jwks_uri = f"https://{tenant}/.well-known/jwks.json" | ||
|
|
||
| return OAuth2Client( | ||
| auth=auth, | ||
| client_id=client_id, | ||
| client_secret=client_secret, | ||
| private_jwk=private_jwk, | ||
| session=session, | ||
| token_endpoint=token_endpoint, | ||
| authorization_endpoint=authorization_endpoint, | ||
| revocation_endpoint=revocation_endpoint, | ||
| userinfo_endpoint=userinfo_endpoint, | ||
| issuer=tenant, | ||
| jwks_uri=jwks_uri, | ||
| **kwargs, | ||
| ) | ||
|
|
||
| @classmethod | ||
| def management_api_client( | ||
| cls, | ||
| tenant: str, | ||
| auth: ( | ||
| requests.auth.AuthBase | tuple[str, str] | tuple[str, Jwk] | tuple[str, dict[str, Any]] | str | None | ||
| ) = None, | ||
| *, | ||
| client_id: str | None = None, | ||
| client_secret: str | None = None, | ||
| private_jwk: Any | None = None, | ||
| session: requests.Session | None = None, | ||
| **kwargs: Any, | ||
| ) -> ApiClient: | ||
| """Initialize a client for the Auth0 Management API. | ||
| See [Auth0 Management API v2](https://auth0.com/docs/api/management/v2). You must provide the | ||
| target tenant name and the credentials for a client that is allowed access to the Management | ||
| API. | ||
| Args: | ||
| tenant: the tenant name. | ||
| Same definition as for [Auth0.client][requests_oauth2client.vendor_specific.auth0.Auth0.client] | ||
| auth: client credentials. | ||
| Same definition as for [OAuth2Client][requests_oauth2client.client.OAuth2Client] | ||
| client_id: the Client ID. | ||
| Same definition as for [OAuth2Client][requests_oauth2client.client.OAuth2Client] | ||
| client_secret: the Client Secret. | ||
| Same definition as for [OAuth2Client][requests_oauth2client.client.OAuth2Client] | ||
| private_jwk: the private key to use for client authentication. | ||
| Same definition as for [OAuth2Client][requests_oauth2client.client.OAuth2Client] | ||
| session: requests session. | ||
| Same definition as for [OAuth2Client][requests_oauth2client.client.OAuth2Client] | ||
| **kwargs: additional kwargs to pass to the ApiClient base class | ||
| Usage: | ||
| ```python | ||
| from requests_oauth2client.vendor_specific import Auth0 | ||
| a0mgmt = Auth0.management_api_client("mytenant.eu", client_id=client_id, client_secret=client_secret) | ||
| users = a0mgmt.get("users", params={"page": 0, "per_page": 100}) | ||
| ``` | ||
| """ | ||
| tenant = cls.tenant(tenant) | ||
| client = cls.client( | ||
| tenant, | ||
| auth=auth, | ||
| client_id=client_id, | ||
| client_secret=client_secret, | ||
| private_jwk=private_jwk, | ||
| session=session, | ||
| ) | ||
| audience = f"https://{tenant}/api/v2/" | ||
| api_auth = OAuth2ClientCredentialsAuth(client, audience=audience) | ||
| return ApiClient( | ||
| base_url=audience, | ||
| auth=api_auth, | ||
| session=session, | ||
| **kwargs, | ||
| ) |
Oops, something went wrong.