• auth
• LoginWithEmailRequest

Interface LoginWithEmailRequest

interface LoginWithEmailRequest {
client_id?: string;
client_secret?: string;
client_assertion?: string;
client_assertion_type?: "urn:ietf:params:oauth:client-assertion-type:jwt-bearer";
email: string;
code: string;
audience?: string;
scope?: string;
}

Hierarchy (View Summary)

• ClientCredentials
  • LoginWithEmailRequest

Index

Properties

client_id?client_secret?client_assertion?client_assertion_type?emailcodeaudience?scope?

Properties

Optionalclient_id

client_id?: string

Specify this to override the parent class's clientId

Optionalclient_secret

client_secret?: string

Specify this to override the parent class's clientSecret

Optionalclient_assertion

client_assertion?: string

Specify this to provide your own client assertion JWT rather than the class creating one for you from the clientAssertionSigningKey.

Optionalclient_assertion_type

client_assertion_type?: "urn:ietf:params:oauth:client-assertion-type:jwt-bearer"

If you provide your own client_assertion you should also provide the client_assertion_type.

email

email: string

The user's email address.

code

code: string

The user's verification code.

Optionalaudience

audience?: string

API Identifier of the API for which you want to get an Access Token.

Optionalscope

scope?: string

Use openid to get an ID Token, or openid profile email to also include user profile information in the ID Token.

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Properties client_idclient_secretclient_assertionclient_assertion_typeemailcodeaudiencescope