IdentitytoolkitRelyingpartyCreateAuthUriRequest

import type { IdentitytoolkitRelyingpartyCreateAuthUriRequest } from "https://googleapis.deno.dev/v1/identitytoolkit:v3.ts";

Request to get the IDP authentication URL.

interface IdentitytoolkitRelyingpartyCreateAuthUriRequest {

appId?: string;

authFlowType?: string;

clientId?: string;

context?: string;

continueUri?: string;

customParameter?: {

[key: string]: string;

};

hostedDomain?: string;

identifier?: string;

oauthConsumerKey?: string;

oauthScope?: string;

openidRealm?: string;

otaApp?: string;

providerId?: string;

sessionId?: string;

tenantId?: string;

tenantProjectNumber?: bigint;

}

§Properties

appId?: string

[src]

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

authFlowType?: string

[src]

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

clientId?: string

[src]

The relying party OAuth client ID.

context?: string

[src]

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

continueUri?: string

[src]

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

customParameter?: {

[key: string]: string;

}

[src]

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.

hostedDomain?: string

[src]

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

identifier?: string

[src]

The email or federated ID of the user.

oauthConsumerKey?: string

[src]

The developer's consumer key for OpenId OAuth Extension

oauthScope?: string

[src]

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

openidRealm?: string

[src]

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

otaApp?: string

[src]

The native app package for OTA installation.

providerId?: string

[src]

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.

sessionId?: string

[src]

The session_id passed by client.

tenantId?: string

[src]

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.

tenantProjectNumber?: bigint

[src]

Tenant project number to be used for idp discovery.