Struct ory_hydra_client::models::open_id_connect_context::OpenIdConnectContext

pub struct OpenIdConnectContext {
    pub acr_values: Option<Vec<String>>,
    pub display: Option<String>,
    pub id_token_hint_claims: Option<Value>,
    pub login_hint: Option<String>,
    pub ui_locales: Option<Vec<String>>,
}

Fields

acr_values: Option<Vec<String>>

ACRValues is the Authentication AuthorizationContext Class Reference requested in the OAuth 2.0 Authorization request. It is a parameter defined by OpenID Connect and expresses which level of authentication (e.g. 2FA) is required. OpenID Connect defines it as follows: > Requested Authentication AuthorizationContext Class Reference values. Space-separated string that specifies the acr values that the Authorization Server is being requested to use for processing this Authentication Request, with the values appearing in order of preference. The Authentication AuthorizationContext Class satisfied by the authentication performed is returned as the acr Claim Value, as specified in Section 2. The acr Claim is requested as a Voluntary Claim by this parameter.

display: Option<String>

Display is a string value that specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User. The defined values are: page: The Authorization Server SHOULD display the authentication and consent UI consistent with a full User Agent page view. If the display parameter is not specified, this is the default display mode. popup: The Authorization Server SHOULD display the authentication and consent UI consistent with a popup User Agent window. The popup User Agent window should be of an appropriate size for a login-focused dialog and should not obscure the entire window that it is popping up over. touch: The Authorization Server SHOULD display the authentication and consent UI consistent with a device that leverages a touch interface. wap: The Authorization Server SHOULD display the authentication and consent UI consistent with a "feature phone" type display. The Authorization Server MAY also attempt to detect the capabilities of the User Agent and present an appropriate display.

id_token_hint_claims: Option<Value>

IDTokenHintClaims are the claims of the ID Token previously issued by the Authorization Server being passed as a hint about the End-User’s current or past authenticated session with the Client.

login_hint: Option<String>

LoginHint hints about the login identifier the End-User might use to log in (if necessary). This hint can be used by an RP if it first asks the End-User for their e-mail address (or other identifier) and then wants to pass that value as a hint to the discovered authorization service. This value MAY also be a phone number in the format specified for the phone_number Claim. The use of this parameter is optional.

ui_locales: Option<Vec<String>>

UILocales is the End-User’id preferred languages and scripts for the user interface, represented as a space-separated list of BCP47 [RFC5646] language tag values, ordered by preference. For instance, the value "fr-CA fr en" represents a preference for French as spoken in Canada, then French (without a region designation), followed by English (without a region designation). An error SHOULD NOT result if some or all of the requested locales are not supported by the OpenID Provider.

Implementations

impl OpenIdConnectContext

pub fn new() -> OpenIdConnectContext

Trait Implementations

impl Clone for OpenIdConnectContext

fn clone(&self) -> OpenIdConnectContext

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OpenIdConnectContext

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OpenIdConnectContext

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<OpenIdConnectContext> for OpenIdConnectContext

fn eq(&self, other: &OpenIdConnectContext) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &OpenIdConnectContext) -> bool

This method tests for !=.

impl Serialize for OpenIdConnectContext

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OpenIdConnectContext