Struct oauth2::Client

pub struct Client { /* fields omitted */ }

Stores the configuration for an OAuth2 client.

Methods

impl Client

pub fn new(client_id: impl AsRef<str>, auth_url: Url, token_url: Url) -> Self

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

Arguments

• client_id - Client ID
• 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_client_secret(&mut self, client_secret: impl Into<ClientSecret>)

Configure the client secret to use.

pub fn add_scope(&mut self, scope: impl Into<Scope>)

Appends a new scope to the authorization URL.

pub fn set_auth_type(&mut self, auth_type: AuthType)

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(&mut self, redirect_url: Url)

Sets the the redirect URL used by the authorization endpoint.

pub fn authorize_url(&self, state: &State) -> Url

Produces the full authorization URL used by the Authorization Code Grant flow, which is the most common OAuth2 flow.

Arguments

• state - A state value to include in the request. 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.

pub fn authorize_url_implicit(&self, state: &State) -> Url

Produces the full authorization URL used by the Implicit Grant flow.

Arguments

• state - A state value to include in the request. 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.

pub fn exchange_code(&self, code: impl Into<AuthorizationCode>) -> Request

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 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>(
    &'a self,
    username: impl AsRef<str>,
    password: impl AsRef<str>
) -> Request<'a>

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) -> Request

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(&self, refresh_token: &RefreshToken) -> Request

Exchanges a refresh token for an access token

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

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.