Interface DeviceCodeActivationMembers

Interface describing the members of the Device Code Activation screen.

interface DeviceCodeActivationMembers {
    branding: BrandingMembers;
    client: ClientMembers;
    organization: OrganizationMembers;
    prompt: PromptMembers;
    screen: ScreenMembers;
    tenant: TenantMembers;
    transaction: TransactionMembers;
    untrustedData: UntrustedDataMembers;
    user: UserMembers;
    continue(options: {
        code: string;
        customOptions?: CustomOptions;
    }): Promise<void>;
}

Hierarchy

  • BaseMembers
    • DeviceCodeActivationMembers

Implemented by

Properties

branding: BrandingMembers
organization: OrganizationMembers
transaction: TransactionMembers
untrustedData: UntrustedDataMembers

Methods

  • 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.

    Parameters

    • options: {
          code: string;
          customOptions?: CustomOptions;
      }

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

      • code: string

        The device code entered by the user.

      • OptionalcustomOptions?: CustomOptions

        Optional custom options to include with the request.

    Returns Promise<void>

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