Struct matrix_sdk::oidc::OidcAuthCodeUrlBuilder

pub struct OidcAuthCodeUrlBuilder { /* private fields */ }

Available on crate feature experimental-oidc only.

Builder type used to configure optional settings for authorization with an OpenID Connect Provider via the Authorization Code flow.

Created with Oidc::authorize_scope() or Oidc::login(). Finalized with Self::build().

Implementations

impl OidcAuthCodeUrlBuilder

pub fn display(self, display: Display) -> Self

Set how the Authorization Server should display the authentication and consent user interface pages to the End-User.

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

Set the Prompt of the authorization URL.

Prompt::Create can be used to signify that the user wants to register a new account. If Prompt::None is used, it must be the only value.

pub fn max_age(self, max_age: NonZeroU32) -> Self

Set the allowable elapsed time in seconds since the last time the End-User was actively authenticated by the OpenID Provider.

pub fn ui_locales(self, ui_locales: Vec<LanguageTag>) -> Self

Set the preferred locales of the user.

Must be ordered from the preferred locale to the least preferred locale.

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

Set the hint to the Authorization Server about the login identifier the End-User might use to log in.

To set a Matrix user ID as a login hint, use Self::user_id_hint().

Erases any value set with Self::user_id_hint().

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.

To set another type of identifier as a login hint, use Self::login_hint().

Erases any value set with Self::login_hint().

pub fn acr_values(self, acr_values: HashSet<String>) -> Self

Set the requested Authentication Context Class Reference values.

This is only necessary with specific providers.

pub async fn build(self) -> Result<OidcAuthorizationData, OidcError>

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 authorization can be completed by calling Oidc::finish_authorization().

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