DeviceCodeActivationMembers

Interface describing the members of the Device Code Activation screen.

Example

export interface DeviceCodeActivationMembers extends BaseMembers {
  /**
   * Submits the device code entered by the user.
   * This action is triggered when the user enters the code displayed on their device and submits the form.
   *
   * @param {object} payload - An object containing the code entered by the user and any custom payload.
   * @param {string} payload.code - The device code entered by the user.
   *
   * @returns {Promise<void>} A promise that resolves when the code is successfully submitted.
   * Rejects with an error if the submission fails.
   */
  continue(payload: ContinueOptions): Promise<void>;
}

Properties

branding · BrandingMembers

client · ClientMembers

organization · OrganizationMembers

prompt · PromptMembers

screen · ScreenMembers

tenant · TenantMembers

transaction · TransactionMembers

untrustedData · UntrustedDataMembers

user · UserMembers

Methods

continue · Promise<void>

Submits the device code entered by the user. This action is triggered when the user enters the code displayed on their device and submits the form.

A promise that resolves when the code is successfully submitted. Rejects with an error if the submission fails.

Show Parameters

payload · DeviceCodeActivationContinueOptions

An object containing the code entered by the user and any custom payload.

Properties

code · string