Module auth_scheme 

Available on crate feature api only.

The AuthScheme trait used to specify the authentication scheme used by endpoints and the types that implement it.

Structs

AccessToken

Authentication is performed by including an access token in the Authentication http header, or an access_token query parameter.

AccessTokenOptional

Authentication is optional, and it is performed by including an access token in the Authentication http header, or an access_token query parameter.

AppserviceToken

Authentication is required, and can only be performed for appservices, by including an appservice access token in the Authentication http header, or access_token query parameter.

AppserviceTokenOptional

No authentication is performed for clients, but it can be performed for appservices, by including an appservice access token in the Authentication http header, or an access_token query parameter.

NoAccessToken

No authentication is performed on an API that usually relies on access tokens.

NoAuthentication

No authentication is performed.

Enums

AddRequiredTokenError

An error that can occur when adding an AuthScheme that requires an access token.

ExtractTokenError

An error that can occur when extracting an AuthScheme that expects an access token.

SendAccessToken

An enum to control whether an access token should be added to outgoing requests

Traits

AuthScheme

Trait implemented by types representing an authentication scheme used by an endpoint.

ClientScopedAuthScheme

A marker trait indicating that endpoints which use this auth scheme require clients authenticated using the OAuth 2.0 API to request certain scopes. See Metadata::required_client_scopes() for more information.

Functions

add_access_token_as_authorization_header

Add the given access token as an Authorization HTTP header to the given map.

extract_bearer_or_query_token

Extract the access token from the Authorization HTTP header or the query string of the given request.