Interface AuthenticationDetailsParameters

Represents the parameters required for initiating an authentication request.

interface AuthenticationDetailsParameters {
    client_id: string;
    code_challenge: string;
    code_challenge_method: S256;
    device_id?: string;
    digital_fingerprint: string;
    locale?: string;
    login_hint?: string;
    login_strategy?: LoginStrategy;
    nonce?: string;
    prompt?: Prompt;
    redirect_uri?: string;
    reset_credentials_url: string;
    scope?: string;
    state: string;
}

Properties

client_id code_challenge code_challenge_method device_id? digital_fingerprint locale? login_hint? login_strategy? nonce? prompt? redirect_uri? reset_credentials_url scope? state

Properties

client_id

client_id: string

The OAuth2 client_id assigned to the client when it was registered.

code_challenge

code_challenge: string

The OAuth2 PKCE code_challenge. This is the hashed value of a verifier.

code_challenge_method

code_challenge_method: S256

The OAuth2 PKCE code_challenge_method. Only the S256 method (hashing the code_verifier with SHA-256) is supported.

Optional device_id

device_id?: string

Unique identifier used for pairing the device.

digital_fingerprint

digital_fingerprint: string

Unique identifier assigned to individual users or devices, used to create their digital identity.

Optional locale

locale?: string

Preferred languages for a customer.

Renders login page content for the merchant customer in the specified language. If not provided, the application will default to a configured default language for the merchant.

Example

"en"

Example

"en-GB"

Optional login_hint

login_hint?: string

The OAuth2 login_hint hints to the server which user is trying to authenticate.

Optional login_strategy

login_strategy?: LoginStrategy

Parameter, which indicates what will be the preferred login method.

  • password - The user will be asked to enter password.
  • pin - The user will be asked to enter PIN.

Optional nonce

nonce?: string

The OAuth2 nonce. The nonce value sent by the client will be present in the final token.

Optional prompt

prompt?: Prompt

Optional OAuth2 prompt parameter that specifies whether the Authorization Server prompts the End-User for re-authentication and consent.

Optional redirect_uri

redirect_uri?: string

The OAuth2 redirect_uri, to which the authorization server will redirect the user after authorization.

reset_credentials_url

reset_credentials_url: string

Parameter used for redirecting the users to a designated credentials reset interface from the Login Screen.

Optional scope

scope?: string

The OAuth2 scope on which the client requires access.

state

state: string

The OAuth2 state parameter sent in the request, for CSRF protection.

Settings

Member Visibility

Theme

On This Page

client_idcode_challengecode_challenge_methoddevice_iddigital_fingerprintlocalelogin_hintlogin_strategynoncepromptredirect_urireset_credentials_urlscopestate