Interface AuthOptions

Hierarchy

  • AuthOptions

Properties

appDetails authOrigin? manifestPath? onCancel? onFinish? redirectTo? sendToSignIn? userSession?

Properties

appDetails

appDetails: {
    icon: string;
    name: string;
}

Type declaration

  • icon: string

    A full URL that resolves to an image icon for your application

  • name: string

    A human-readable name for your application

Optional authOrigin

authOrigin?: string

Deprecated

Authentication is no longer supported through a hosted version. Users must install an extension.

Optional manifestPath

manifestPath?: string

Optional onCancel

onCancel?: (() => void)

Type declaration

    • (): void

    • This callback is fired if the user exits before finishing

      Returns void

Optional onFinish

onFinish?: ((payload: FinishedAuthData) => void)

Type declaration

    • (payload: FinishedAuthData): void

    • This callback is fired after authentication is finished. The callback is called with a single object argument, with three keys: authResponse: the raw authResponse string that is returned from authentication authResponsePayload: an AuthResponsePayload object userSession: a UserSession object with userData included

      Parameters

      Returns void

Optional redirectTo

redirectTo?: string

The URL you want the user to be redirected to after authentication.

Optional sendToSignIn

sendToSignIn?: boolean

If sendToSignIn is true, then the user will be sent through the sign in flow.

Optional userSession

userSession?: UserSession

Theme

Generated using TypeDoc