Struct oauth2::Client

pub struct Client<TE, TR, TT> where
    TE: ErrorResponse,
    TR: TokenResponse<TT>,
    TT: TokenType,  { /* fields omitted */ }

Stores the configuration for an OAuth2 client.

Implementations

impl<TE, TR, TT> Client<TE, TR, TT> where
    TE: ErrorResponse + 'static,
    TR: TokenResponse<TT>,
    TT: TokenType, 

pub fn new(
    client_id: ClientId,
    client_secret: Option<ClientSecret>,
    auth_url: AuthUrl,
    token_url: Option<TokenUrl>
) -> Self

Initializes an OAuth2 client with the fields common to most OAuth2 flows.

Arguments

• client_id - Client ID
• client_secret - Optional client secret. A client secret is generally used for private (server-side) OAuth2 clients and omitted from public (client-side or native app) OAuth2 clients (see RFC 8252).
• auth_url - Authorization endpoint: used by the client to obtain authorization from the resource owner via user-agent redirection. This URL is used in all standard OAuth2 flows except the Resource Owner Password Credentials Grant and the Client Credentials Grant.
• token_url - Token endpoint: used by the client to exchange an authorization grant (code) for an access token, typically with client authentication. This URL is used in all standard OAuth2 flows except the Implicit Grant. If this value is set to None, the exchange_* methods will return Err(RequestTokenError::Other(_)).

pub fn set_auth_type(self, auth_type: AuthType) -> Self

Configures the type of client authentication used for communicating with the authorization server.

The default is to use HTTP Basic authentication, as recommended in Section 2.3.1 of RFC 6749.

pub fn set_redirect_url(self, redirect_url: RedirectUrl) -> Self

Sets the the redirect URL used by the authorization endpoint.

pub fn set_device_authorization_url(
    self,
    device_authorization_url: DeviceAuthorizationUrl
) -> Self

Sets the the device authorization URL used by the device authorization endpoint. Used for Device Code Flow, as per RFC 8628.

pub fn authorize_url<S>(&self, state_fn: S) -> AuthorizationRequest<'_> where
    S: FnOnce() -> CsrfToken, 

Generates an authorization URL for a new authorization request.

Arguments

• state_fn - A function that returns an opaque value used by the client to maintain state between the request and callback. The authorization server includes this value when redirecting the user-agent back to the client.

Security Warning

Callers should use a fresh, unpredictable state for each authorization request and verify that this value matches the state parameter passed by the authorization server to the redirect URI. Doing so mitigates Cross-Site Request Forgery attacks. To disable CSRF protections (NOT recommended), use insecure::authorize_url instead.

pub fn exchange_code(
    &self,
    code: AuthorizationCode
) -> CodeTokenRequest<'_, TE, TR, TT>

Exchanges a code produced by a successful authorization process with an access token.

Acquires ownership of the code because authorization codes may only be used once to retrieve an access token from the authorization server.

See https://tools.ietf.org/html/rfc6749#section-4.1.3

pub fn exchange_password<'a, 'b>(
    &'a self,
    username: &'b ResourceOwnerUsername,
    password: &'b ResourceOwnerPassword
) -> PasswordTokenRequest<'b, TE, TR, TT> where
    'a: 'b, 

Requests an access token for the password grant type.

See https://tools.ietf.org/html/rfc6749#section-4.3.2

pub fn exchange_client_credentials(
    &self
) -> ClientCredentialsTokenRequest<'_, TE, TR, TT>

Requests an access token for the client credentials grant type.

See https://tools.ietf.org/html/rfc6749#section-4.4.2

pub fn exchange_refresh_token<'a, 'b>(
    &'a self,
    refresh_token: &'b RefreshToken
) -> RefreshTokenRequest<'b, TE, TR, TT> where
    'a: 'b, 

Exchanges a refresh token for an access token

See https://tools.ietf.org/html/rfc6749#section-6

pub fn exchange_device_code(&self) -> DeviceAuthorizationRequest<'_, TE>

Perform a device authorization request as per https://tools.ietf.org/html/rfc8628#section-3.1

pub fn exchange_device_access_token<'a, 'b, 'c, EF>(
    &'a self,
    auth_response: &'b DeviceAuthorizationResponse<EF>
) -> DeviceAccessTokenRequest<'b, 'c, TR, TT, EF> where
    'a: 'b,
    EF: ExtraDeviceAuthorizationFields, 

Perform a device access token request as per https://tools.ietf.org/html/rfc8628#section-3.4

Trait Implementations

impl<TE: Clone, TR: Clone, TT: Clone> Clone for Client<TE, TR, TT> where
    TE: ErrorResponse,
    TR: TokenResponse<TT>,
    TT: TokenType, 

fn clone(&self) -> Client<TE, TR, TT>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<TE: Debug, TR: Debug, TT: Debug> Debug for Client<TE, TR, TT> where
    TE: ErrorResponse,
    TR: TokenResponse<TT>,
    TT: TokenType, 

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.