Struct AuthorisationRequest

pub struct AuthorisationRequest {
    pub response_type: ResponseType,
    pub response_mode: Option<ResponseMode>,
    pub client_id: String,
    pub state: Option<String>,
    pub pkce_request: Option<PkceRequest>,
    pub redirect_uri: Url,
    pub scope: BTreeSet<String>,
    pub nonce: Option<String>,
    pub oidc_ext: AuthorisationRequestOidc,
    pub max_age: Option<i64>,
    pub unknown_keys: BTreeMap<String, Value>,
}

An OAuth2 client redirects to the authorisation server with Authorisation Request parameters.

Fields

response_type: ResponseType

response_mode: Option<ResponseMode>

Response mode.

Optional; defaults to query for response_type=code (Auth Code), and fragment for response_type=token (Implicit Grant, which we probably won’t support).

Reference: OAuth 2.0 Multiple Response Type Encoding Practices: Response Modes

client_id: String

state: Option<String>

pkce_request: Option<PkceRequest>

redirect_uri: Url

scope: BTreeSet<String>

nonce: Option<String>

oidc_ext: AuthorisationRequestOidc

max_age: Option<i64>

unknown_keys: BTreeMap<String, Value>

Implementations

impl AuthorisationRequest

pub const fn get_response_mode(&self) -> Option<ResponseMode>

Get the response_mode appropriate for this request, taking into account defaults from the response_type parameter.

Returns None if the selection is invalid.

Reference: OAuth 2.0 Multiple Response Type Encoding Practices: Response Modes

Trait Implementations

impl Clone for AuthorisationRequest

fn clone(&self) -> AuthorisationRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthorisationRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AuthorisationRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AuthorisationRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.