sdkagent

authlib API reference

105 public APIs from authlib (authlib/authlib) — 46 classes, 6 functions, 53 methods. Signatures extracted by static analysis of the actual source.

Repository: authlib/authlib

KindCount
Classes46
Functions6
Methods53

API list

classauthlib.common.errors.AuthlibBaseError
Base Exception for all errors in Authlib.
funcauthlib.common.security.is_secure_transport(uri)
Check if the uri is over ssl.
funcauthlib.common.urls.add_params_to_qs(query, params)
Extend a query with a list of two-tuples.
classauthlib.integrations.base_client.registry.BaseOAuth
Registry for oauth clients.
classauthlib.integrations.flask_oauth1.resource_protector.ResourceProtector
A protecting method for resource servers.
classauthlib.integrations.flask_oauth2.resource_protector.ResourceProtector
A protecting method for resource servers.
classauthlib.integrations.httpx_client.oauth1_client.OAuth1Auth
Signs the httpx2 request using OAuth 1 (RFC5849).
classauthlib.integrations.requests_client.oauth1_session.OAuth1Auth
Signs the request using OAuth 1 (RFC5849).
classauthlib.integrations.requests_client.oauth2_session.OAuth2Session
Construct a new OAuth 2 client requests session.
classauthlib.jose.rfc7515.models.JWSAlgorithm
Interface for JWS algorithm.
classauthlib.jose.rfc7515.models.JWSHeader
Header object for JWS.
classauthlib.jose.rfc7515.models.JWSObject
A dict instance to represent a JWS object.
classauthlib.jose.rfc7516.models.JWEAlgorithm
Interface for JWE algorithm conforming to RFC7518.
classauthlib.jose.rfc7516.models.JWEAlgorithmBase
Base interface for all JWE algorithms.
classauthlib.jose.rfc7516.models.JWEHeader
Header object for JWE.
classauthlib.jose.rfc7516.models.JWESharedHeader
Shared header object for JWE.
classauthlib.jose.rfc7517.asymmetric_key.AsymmetricKey
This is the base class for a JSON Web Key.
methodauthlib.jose.rfc7517.asymmetric_key.AsymmetricKey.as_key(is_private=False)
Represent this key as raw key.
classauthlib.jose.rfc7517.base_key.Key
This is the base class for a JSON Web Key.
classauthlib.jose.rfc7517.key_set.KeySet
This class represents a JSON Web Key Set.
classauthlib.jose.rfc7518.ec_key.ECKey
Key class of the ``EC`` key type.
classauthlib.jose.rfc7518.jws_algs.ECAlgorithm
ECDSA using SHA algorithms for JWS.
classauthlib.jose.rfc7518.jws_algs.HMACAlgorithm
HMAC using SHA algorithms for JWS.
classauthlib.jose.rfc7518.jws_algs.RSAAlgorithm
RSA using SHA algorithms for JWS.
classauthlib.jose.rfc7518.jws_algs.RSAPSSAlgorithm
RSASSA-PSS using SHA algorithms for JWS.
classauthlib.jose.rfc7518.oct_key.OctKey
Key class of the ``oct`` key type.
methodauthlib.jose.rfc7518.oct_key.OctKey.get_op_key(operation)
Get the raw key for the given key_op.
classauthlib.jose.rfc7518.rsa_key.RSAKey
Key class of the ``RSA`` key type.
classauthlib.jose.rfc8037.okp_key.OKPKey
Key class of the ``OKP`` key type.
funcauthlib.oauth1.rfc5849.signature.sign_hmac_sha1(client, request)
Sign a HMAC-SHA1 signature.
funcauthlib.oauth1.rfc5849.signature.sign_plaintext(client, request)
Sign a PLAINTEXT signature.
funcauthlib.oauth1.rfc5849.signature.verify_hmac_sha1(request)
Verify a HMAC-SHA1 signature.
funcauthlib.oauth1.rfc5849.signature.verify_plaintext(request)
Verify a PLAINTEXT signature.
classauthlib.oauth2.auth.ClientAuth
Attaches OAuth Client Information to HTTP requests.
classauthlib.oauth2.auth.TokenAuth
Attach token information to HTTP requests.
classauthlib.oauth2.client.OAuth2Client
Construct a new OAuth 2 protocol client.
classauthlib.oauth2.rfc6749.endpoint.Endpoint
Base class for OAuth2 endpoints.
methodauthlib.oauth2.rfc6749.endpoint.Endpoint.create_response(validated_request:EndpointRequest) -> tuple[int, Any, list] | None
Create the HTTP response from a validated request.
classauthlib.oauth2.rfc6749.endpoint.EndpointRequest
Base class for validated endpoint requests.
classauthlib.oauth2.rfc6749.resource_protector.TokenValidator
Base token validator class.
methodauthlib.oauth2.rfc7009.revocation.RevocationEndpoint.revoke_token(token, request)
Mark token as revoked.
classauthlib.oauth2.rfc7523.auth.ClientSecretJWT
Authentication method for OAuth 2.0 Client.
classauthlib.oauth2.rfc7523.auth.PrivateKeyJWT
Authentication method for OAuth 2.0 Client.
classauthlib.oauth2.rfc7591.errors.InvalidRedirectURIError
The value of one or more redirection URIs is invalid.
classauthlib.oauth2.rfc7591.errors.InvalidSoftwareStatementError
The software statement presented is invalid.
classauthlib.oauth2.rfc7636.challenge.CodeChallenge
CodeChallenge extension to Authorization Code Grant.
methodauthlib.oauth2.rfc8414.models.AuthorizationServerMetadata.validate_code_challenge_methods_supported()
OPTIONAL.
methodauthlib.oauth2.rfc8414.models.AuthorizationServerMetadata.validate_grant_types_supported()
OPTIONAL.
methodauthlib.oauth2.rfc8414.models.AuthorizationServerMetadata.validate_introspection_endpoint()
OPTIONAL.
methodauthlib.oauth2.rfc8414.models.AuthorizationServerMetadata.validate_introspection_endpoint_auth_methods_supported()
OPTIONAL.
methodauthlib.oauth2.rfc8414.models.AuthorizationServerMetadata.validate_introspection_endpoint_auth_signing_alg_values_supported()
OPTIONAL.
methodauthlib.oauth2.rfc8414.models.AuthorizationServerMetadata.validate_issuer()
REQUIRED.
methodauthlib.oauth2.rfc8414.models.AuthorizationServerMetadata.validate_jwks_uri()
OPTIONAL.
methodauthlib.oauth2.rfc8414.models.AuthorizationServerMetadata.validate_op_policy_uri()
OPTIONAL.
methodauthlib.oauth2.rfc8414.models.AuthorizationServerMetadata.validate_op_tos_uri()
OPTIONAL.
methodauthlib.oauth2.rfc8414.models.AuthorizationServerMetadata.validate_registration_endpoint()
OPTIONAL.
methodauthlib.oauth2.rfc8414.models.AuthorizationServerMetadata.validate_response_modes_supported()
OPTIONAL.
methodauthlib.oauth2.rfc8414.models.AuthorizationServerMetadata.validate_response_types_supported()
REQUIRED.
methodauthlib.oauth2.rfc8414.models.AuthorizationServerMetadata.validate_revocation_endpoint()
OPTIONAL.
methodauthlib.oauth2.rfc8414.models.AuthorizationServerMetadata.validate_revocation_endpoint_auth_methods_supported()
OPTIONAL.
methodauthlib.oauth2.rfc8414.models.AuthorizationServerMetadata.validate_revocation_endpoint_auth_signing_alg_values_supported()
OPTIONAL.
methodauthlib.oauth2.rfc8414.models.AuthorizationServerMetadata.validate_scopes_supported()
RECOMMENDED.
methodauthlib.oauth2.rfc8414.models.AuthorizationServerMetadata.validate_service_documentation()
OPTIONAL.
methodauthlib.oauth2.rfc8414.models.AuthorizationServerMetadata.validate_token_endpoint_auth_methods_supported()
OPTIONAL.
methodauthlib.oauth2.rfc8414.models.AuthorizationServerMetadata.validate_token_endpoint_auth_signing_alg_values_supported()
OPTIONAL.
methodauthlib.oauth2.rfc8414.models.AuthorizationServerMetadata.validate_ui_locales_supported()
OPTIONAL.
classauthlib.oauth2.rfc9068.token.JWTBearerTokenGenerator
A JWT formatted access token generator.
methodauthlib.oauth2.rfc9068.token.JWTBearerTokenGenerator.get_acr(user) -> str | None
Authentication Context Class Reference.
methodauthlib.oauth2.rfc9068.token.JWTBearerTokenGenerator.get_amr(user) -> list[str] | None
Authentication Methods References.
methodauthlib.oauth2.rfc9068.token.JWTBearerTokenGenerator.get_audiences(client, user, scope) -> str | list[str]
Return the audience for the token.
methodauthlib.oauth2.rfc9068.token.JWTBearerTokenGenerator.get_auth_time(user) -> int | None
User authentication time.
methodauthlib.oauth2.rfc9068.token.JWTBearerTokenGenerator.get_jti(client, grant_type, user, scope) -> str
JWT ID.
classauthlib.oauth2.rfc9207.discovery.AuthorizationServerMetadata
Authorization Server Metadata extension for RFC9207.
classauthlib.oidc.core.claims.UserInfo
The standard claims of a UserInfo object.
classauthlib.oidc.core.errors.ConsentRequiredError
The Authorization Server requires End-User consent.
classauthlib.oidc.core.errors.LoginRequiredError
The Authorization Server requires End-User authentication.
classauthlib.oidc.core.errors.RequestNotSupportedError
The OP does not support use of the request parameter.
classauthlib.oidc.core.userinfo.UserInfoEndpoint
OpenID Connect Core UserInfo Endpoint.
methodauthlib.oidc.core.userinfo.UserInfoEndpoint.get_issuer() -> str
The OP's Issuer Identifier URL.
classauthlib.oidc.discovery.models.OpenIDProviderMetadata
OpenID Provider Metadata for OpenID Connect Discovery.
methodauthlib.oidc.discovery.models.OpenIDProviderMetadata.validate_acr_values_supported()
OPTIONAL.
methodauthlib.oidc.discovery.models.OpenIDProviderMetadata.validate_claim_types_supported()
OPTIONAL.
methodauthlib.oidc.discovery.models.OpenIDProviderMetadata.validate_claims_locales_supported()
OPTIONAL.
methodauthlib.oidc.discovery.models.OpenIDProviderMetadata.validate_claims_parameter_supported()
OPTIONAL.
methodauthlib.oidc.discovery.models.OpenIDProviderMetadata.validate_claims_supported()
RECOMMENDED.
methodauthlib.oidc.discovery.models.OpenIDProviderMetadata.validate_display_values_supported()
OPTIONAL.
methodauthlib.oidc.discovery.models.OpenIDProviderMetadata.validate_id_token_encryption_alg_values_supported()
OPTIONAL.
methodauthlib.oidc.discovery.models.OpenIDProviderMetadata.validate_id_token_encryption_enc_values_supported()
OPTIONAL.
methodauthlib.oidc.discovery.models.OpenIDProviderMetadata.validate_id_token_signing_alg_values_supported()
REQUIRED.
methodauthlib.oidc.discovery.models.OpenIDProviderMetadata.validate_request_object_encryption_alg_values_supported()
OPTIONAL.
methodauthlib.oidc.discovery.models.OpenIDProviderMetadata.validate_request_object_encryption_enc_values_supported()
OPTIONAL.
methodauthlib.oidc.discovery.models.OpenIDProviderMetadata.validate_request_object_signing_alg_values_supported()
OPTIONAL.
methodauthlib.oidc.discovery.models.OpenIDProviderMetadata.validate_request_parameter_supported()
OPTIONAL.
methodauthlib.oidc.discovery.models.OpenIDProviderMetadata.validate_request_uri_parameter_supported()
OPTIONAL.
methodauthlib.oidc.discovery.models.OpenIDProviderMetadata.validate_require_request_uri_registration()
OPTIONAL.
methodauthlib.oidc.discovery.models.OpenIDProviderMetadata.validate_subject_types_supported()
REQUIRED.
methodauthlib.oidc.discovery.models.OpenIDProviderMetadata.validate_userinfo_encryption_alg_values_supported()
OPTIONAL.
methodauthlib.oidc.discovery.models.OpenIDProviderMetadata.validate_userinfo_encryption_enc_values_supported()
OPTIONAL.
methodauthlib.oidc.discovery.models.OpenIDProviderMetadata.validate_userinfo_signing_alg_values_supported()
OPTIONAL.
classauthlib.oidc.rpinitiated.end_session.EndSessionEndpoint
OpenID Connect RP-Initiated Logout endpoint.
methodauthlib.oidc.rpinitiated.end_session.EndSessionEndpoint.create_response(validated_request:EndSessionRequest) -> tuple[int, Any, list[tuple[str, str]]] | None
Create the end session HTTP response.
methodauthlib.oidc.rpinitiated.end_session.EndSessionEndpoint.end_session(end_session_request:EndSessionRequest) -> None
Terminate the user's session.
methodauthlib.oidc.rpinitiated.end_session.EndSessionEndpoint.resolve_client_from_id_token_claims(id_token_claims:dict) -> Any | None
Resolve client from id_token aud claim.
methodauthlib.oidc.rpinitiated.end_session.EndSessionEndpoint.validate_request(request:OAuth2Request) -> EndSessionRequest
Validate an end session request.
classauthlib.oidc.rpinitiated.end_session.EndSessionRequest
Validated end session request data.

About this data

These signatures were extracted from the public source of authlib/authlib using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries