Struct oauth2::AuthorizationRequest

pub struct AuthorizationRequest<'a> { /* fields omitted */ }

A request to the authorization endpoint

Implementations

impl<'a> AuthorizationRequest<'a>

pub fn add_scope(self, scope: Scope) -> Self

Appends a new scope to the authorization URL.

pub fn add_scopes<I>(self, scopes: I) -> Self where
    I: IntoIterator<Item = Scope>, 

Appends a collection of scopes to the token request.

pub fn add_extra_param<N, V>(self, name: N, value: V) -> Self where
    N: Into<Cow<'a, str>>,
    V: Into<Cow<'a, str>>, 

Appends an extra param to the authorization URL.

This method allows extensions to be used without direct support from this crate. If name conflicts with a parameter managed by this crate, the behavior is undefined. In particular, do not set parameters defined by RFC 6749 or RFC 7636.

Security Warning

Callers should follow the security recommendations for any OAuth2 extensions used with this function, which are beyond the scope of RFC 6749.

pub fn use_implicit_flow(self) -> Self

Enables the Implicit Grant flow.

pub fn set_response_type(self, response_type: &ResponseType) -> Self

Enables custom flows other than the code and token (implicit flow) grant.

pub fn set_pkce_challenge(self, pkce_code_challenge: PkceCodeChallenge) -> Self

Enables the use of Proof Key for Code Exchange (PKCE).

PKCE is highly recommended for all public clients (i.e., those for which there is no client secret or for which the client secret is distributed with the client, such as in a native, mobile app, or browser app).

pub fn set_redirect_uri(self, redirect_url: Cow<'a, RedirectUrl>) -> Self

Overrides the redirect_url to the one specified.

pub fn url(self) -> (Url, CsrfToken)

Returns the full authorization URL and CSRF state for this authorization request.

Trait Implementations

impl<'a> Debug for AuthorizationRequest<'a>

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

Formats the value using the given formatter.