Hierarchy

  • IKUIUserAPIProps

Properties

getValidAccessToken: ((options?: {
    refreshToken?: string;
    userId?: string;
}) => Promise<string>)

Type declaration

    • (options?: {
          refreshToken?: string;
          userId?: string;
      }): Promise<string>
    • Parameters

      • Optional options: {
            refreshToken?: string;
            userId?: string;
        }
        • Optional refreshToken?: string
        • Optional userId?: string

      Returns Promise<string>

isAuthenticated: ((userId?: string) => Promise<boolean>)

Type declaration

    • (userId?: string): Promise<boolean>
    • Parameters

      • Optional userId: string

      Returns Promise<boolean>

login: loginFn

Deprecated

loginSetup: loginSetupFn

Deprecated

logoutAllUsers: (() => Promise<{
    [userId: string]: boolean;
}>)

Type declaration

    • (): Promise<{
          [userId: string]: boolean;
      }>
    • Returns Promise<{
          [userId: string]: boolean;
      }>

logoutCurrentUser: logoutCurrentUserFn

Deprecated

Use logoutUser instead.

logoutUser: ((userId?: string) => Promise<boolean>)

Type declaration

    • (userId?: string): Promise<boolean>
    • Parameters

      • Optional userId: string

      Returns Promise<boolean>

refreshAccessToken: ((refreshToken?: string, codeChallenge?: string, omitAuthorizationHeaders?: boolean) => Promise<string>)

Type declaration

    • (refreshToken?: string, codeChallenge?: string, omitAuthorizationHeaders?: boolean): Promise<string>
    • Parameters

      • Optional refreshToken: string
      • Optional codeChallenge: string
      • Optional omitAuthorizationHeaders: boolean

      Returns Promise<string>

register: registerFn

Deprecated

registerSetup: registerSetupFn

Deprecated

sendNewPassword: sendNewPasswordFn

Deprecated

sendResetPasswordEmail: sendResetPasswordEmailFn

Deprecated

Generated using TypeDoc