Struct OAuthAuthCodeUrlBuilder

Source
pub struct OAuthAuthCodeUrlBuilder { /* private fields */ }
Expand description

Builder type used to configure optional settings for authorization with an OAuth 2.0 authorization server via the Authorization Code flow.

Created with OAuth::login(). Finalized with Self::build().

Implementations§

Source§

impl OAuthAuthCodeUrlBuilder

Source

pub fn prompt(self, prompt: Vec<Prompt>) -> Self

Set the Prompt of the authorization URL.

If this is not set, it is assumed that the user wants to log into an existing account.

Prompt::Create can be used to signify that the user wants to register a new account.

Source

pub fn login_hint(self, login_hint: String) -> Self

Set a generic login hint to help an identity provider pre-fill the login form.

Note: This is not the same as the Self::user_id_hint() method, which is specifically designed to a) take a UserId and no other type of hint and b) be used directly by MAS and not the identity provider.

The most likely use case for this method is to pre-fill the login page using a provisioning link provided by an external party such as https://app.example.com/?server_name=example.org&login_hint=alice In this instance it is up to the external party to make ensure that the hint is known to work with their identity provider. For more information see login_hint in https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest

The following methods are mutually exclusive: Self::login_hint() and Self::user_id_hint().

Source

pub fn user_id_hint(self, user_id: &UserId) -> Self

Set the hint to the Authorization Server about the Matrix user ID the End-User might use to log in, as defined in MSC4198.

The following methods are mutually exclusive: Self::login_hint() and Self::user_id_hint().

Source

pub async fn build(self) -> Result<OAuthAuthorizationData, OAuthError>

Get the URL that should be presented to login via the Authorization Code flow.

This URL should be presented to the user and once they are redirected to the redirect_uri, the login can be completed by calling OAuth::finish_login().

Returns an error if the client registration was not restored, or if a request fails.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

impl<T> Identity for T
where T: ?Sized,

Source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> Any for T
where T: Any,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> SendOutsideWasm for T
where T: Send,

Source§

impl<T> SyncOutsideWasm for T
where T: Sync,