Struct google_identitytoolkit3::IdentitytoolkitRelyingpartyCreateAuthUriRequest

pub struct IdentitytoolkitRelyingpartyCreateAuthUriRequest {
    pub session_id: Option<String>,
    pub tenant_project_number: Option<String>,
    pub auth_flow_type: Option<String>,
    pub app_id: Option<String>,
    pub custom_parameter: Option<HashMap<String, String>>,
    pub openid_realm: Option<String>,
    pub hosted_domain: Option<String>,
    pub oauth_scope: Option<String>,
    pub client_id: Option<String>,
    pub tenant_id: Option<String>,
    pub ota_app: Option<String>,
    pub oauth_consumer_key: Option<String>,
    pub provider_id: Option<String>,
    pub context: Option<String>,
    pub continue_uri: Option<String>,
    pub identifier: Option<String>,
}

Request to get the IDP authentication URL.

Activities

This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).

• create auth uri relyingparty (request)

Fields

session_id: Option<String>

The session_id passed by client.

tenant_project_number: Option<String>

Tenant project number to be used for idp discovery.

auth_flow_type: Option<String>

Explicitly specify the auth flow type. Currently only support "CODE_FLOW" type. The field is only used for Google provider.

app_id: Option<String>

The app ID of the mobile app, base64(CERT_SHA1):PACKAGE_NAME for Android, BUNDLE_ID for iOS.

custom_parameter: Option<HashMap<String, String>>

The query parameter that client can customize by themselves in auth url. The following parameters are reserved for server so that they cannot be customized by clients: client_id, response_type, scope, redirect_uri, state, oauth_token.

openid_realm: Option<String>

Optional realm for OpenID protocol. The sub string "scheme://domain:port" of the param "continueUri" is used if this is not set.

hosted_domain: Option<String>

The hosted domain to restrict sign-in to accounts at that domain for Google Apps hosted accounts.

oauth_scope: Option<String>

Additional oauth scopes, beyond the basid user profile, that the user would be prompted to grant

client_id: Option<String>

The relying party OAuth client ID.

tenant_id: Option<String>

For multi-tenant use cases, in order to construct sign-in URL with the correct IDP parameters, Firebear needs to know which Tenant to retrieve IDP configs from.

ota_app: Option<String>

The native app package for OTA installation.

oauth_consumer_key: Option<String>

The developer's consumer key for OpenId OAuth Extension

provider_id: Option<String>

The IdP ID. For white listed IdPs it's a short domain name e.g. google.com, aol.com, live.net and yahoo.com. For other OpenID IdPs it's the OP identifier.

context: Option<String>

The opaque value used by the client to maintain context info between the authentication request and the IDP callback.

continue_uri: Option<String>

The URI to which the IDP redirects the user after the federated login flow.

identifier: Option<String>

The email or federated ID of the user.

Trait Implementations

impl RequestValue for IdentitytoolkitRelyingpartyCreateAuthUriRequest

impl Default for IdentitytoolkitRelyingpartyCreateAuthUriRequest

fn default() -> IdentitytoolkitRelyingpartyCreateAuthUriRequest

Returns the "default value" for a type.

impl Clone for IdentitytoolkitRelyingpartyCreateAuthUriRequest

fn clone(&self) -> IdentitytoolkitRelyingpartyCreateAuthUriRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IdentitytoolkitRelyingpartyCreateAuthUriRequest

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

Formats the value using the given formatter.

impl Serialize for IdentitytoolkitRelyingpartyCreateAuthUriRequest

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for IdentitytoolkitRelyingpartyCreateAuthUriRequest

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

Deserialize this value from the given Serde deserializer.