Struct LogoutRequest

pub struct LogoutRequest { /* private fields */ }

A request to the end session endpoint.

Implementations

impl LogoutRequest

pub fn set_id_token_hint<AC, GC, JE, JS, JT>( self, id_token_hint: &IdToken<AC, GC, JE, JS, JT>, ) -> Self

where AC: AdditionalClaims, GC: GenderClaim, JE: JweContentEncryptionAlgorithm<JT>, JS: JwsSigningAlgorithm<JT>, JT: JsonWebKeyType,

Provides an ID token previously issued by this OpenID Connect Provider as a hint about the user’s identity.

pub fn set_logout_hint(self, logout_hint: LogoutHint) -> Self

Provides the OpenID Connect Provider with a hint about the user’s identity.

The nature of this hint is specific to each provider.

pub fn set_client_id(self, client_id: ClientId) -> Self

Provides the OpenID Connect Provider with the client identifier.

When both this and id_token_hint are set, the provider must verify that this client id matches the one used when the ID token was issued.

pub fn set_post_logout_redirect_uri( self, redirect_uri: PostLogoutRedirectUrl, ) -> Self

Provides the OpenID Connect Provider with a URI to redirect to after the logout has been performed.

pub fn set_state(self, state: CsrfToken) -> Self

Specify an opaque value that the OpenID Connect Provider should pass back to your application using the state parameter when redirecting to post_logout_redirect_uri.

pub fn add_ui_locale(self, ui_locale: LanguageTag) -> Self

Requests the preferred languages for the user interface presented by the OpenID Connect Provider.

Languages should be added in order of preference.

pub fn http_get_url(self) -> Url

Returns the full logout URL. In order to logout, a GET request should be made to this URL by the client’s browser.

Trait Implementations

impl From<EndSessionUrl> for LogoutRequest

fn from(value: EndSessionUrl) -> Self

Converts to this type from the input type.