Module oauth2

Source
Expand description

Oauth2 RFC protocol definitions.

Structs§

AccessTokenIntrospectRequest
Request to introspect the identity of the account associated to a token.
AccessTokenIntrospectResponse
Response to an introspection request. If the token is inactive or revoked, only active will be set to the value of false.
AccessTokenRequest
An Access Token request. This requires a set of grant-type parameters to satisfy the request.
AccessTokenResponse
The response for an access token
AuthorisationRequest
An OAuth2 client redirects to the authorisation server with Authorisation Request parameters.
AuthorisationRequestOidc
An OIDC client redirects to the authorisation server with Authorisation Request parameters.
DeviceAuthorizationResponse
Ref https://www.rfc-editor.org/rfc/rfc8628#section-3.2
ErrorResponse
OAuth2RFC9068Token
OAuth2RFC9068TokenExtensions
Extensions for RFC 9068 Access Token
Oauth2Rfc8414MetadataResponse
The response to an OAuth2 rfc8414 metadata request
OidcDiscoveryResponse
The response to an OpenID connect discovery request https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
OidcWebfingerRel
OidcWebfingerResponse
The response to an Webfinger request. Only a subset of the body is defined here. https://datatracker.ietf.org/doc/html/rfc7033#section-4.4
PkceRequest
TokenRevokeRequest
Request revocation of an Access or Refresh token. On success the response is OK 200 with no body.

Enums§

AccessTokenType
Access token types, per IANA Registry - OAuth Access Token Types
AuthorisationResponse
In response to an Authorisation request, the user may be prompted to consent to the scopes requested by the OAuth2 client. If they have previously consented, they will immediately proceed.
ClaimType
CodeChallengeMethod
DisplayValue
GrantType
GrantTypeReq
IdTokenSignAlg
Algorithms supported for token signatures. Prefers ES256
PkceAlg
ResponseMode
ResponseType
SubjectType
TokenEndpointAuthMethod

Constants§

OAUTH2_DEVICE_CODE_EXPIRY_SECONDS
How many seconds a device code is valid for.
OAUTH2_DEVICE_CODE_INTERVAL_SECONDS
How often a client device can query the status of the token