Struct oauth2::Config

pub struct Config { /* fields omitted */ }

Stores the configuration for an OAuth2 client.

Methods

impl Config

fn new<I, S, A, T>(
    client_id: I,
    client_secret: S,
    auth_url: A,
    token_url: T
) -> Self where
    I: Into<String>,
    S: Into<String>,
    A: AsRef<str>,
    T: AsRef<str>, 

Initializes the OAuth2 client with the client ID, client secret, the base authorization URL and the URL ment for requesting the access token.

fn add_scope<S>(self, scope: S) -> Self where
    S: Into<String>, 

Appends a new scope to the authorization URL.

fn set_response_type<R>(self, response_type: R) -> Self where
    R: Into<ResponseType>, 

Allows setting a particular response type. Both &str and ResponseType work here.

The default response type is code.

fn set_redirect_url<R>(self, redirect_url: R) -> Self where
    R: Into<String>, 

Allows setting the redirect URL.

fn set_state<S>(self, state: S) -> Self where
    S: Into<String>, 

Allows setting a state parameter inside the authorization URL, which we'll be returned by the server after the authorization is over.

fn authorize_url(&self) -> Url

Produces the full authorization URL.

fn exchange<C>(&self, code: C) -> Result<Token, TokenError> where
    C: Into<String>, 

Deprecated since 1.0.0

: please use exchange_code instead

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

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

fn exchange_code<C>(&self, code: C) -> Result<Token, TokenError> where
    C: Into<String>, 

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

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

fn exchange_client_credentials(&self) -> Result<Token, TokenError>

Requests an access token for the client credentials grant type.

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

fn exchange_password<U, P>(
    &self,
    username: U,
    password: P
) -> Result<Token, TokenError> where
    U: Into<String>,
    P: Into<String>, 

Requests an access token for the password grant type.

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