Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "sdk-identity/src/sdk/login"

Index

Functions

Functions

isLoggedIn

  • isLoggedIn(): Promise<boolean>

login

  • Parameters

    • userName: string
    • password: string
    • Default value options: object = {}
      • Optional cookie: undefined | false | true
      • Optional recaptchaToken: undefined | string
      • Optional rememberMe: undefined | false | true

    Returns Promise<APIErrorResponse | UserIdentity>

    A Promise with the user information. When successful, userIdentity will be populated with the data fetched by this method.

    On success (resolves)
    {
      "uuid": "c7e9fed4-bedf-428b-a694-1bbd21721cf7",
      "accessToken": "c7e9fed4bedf428b.a6941bbd21721cf7...",
    }
    On error (throws)
    See documentation for corresponding error codes:
    https://redirector.arcpublishing.com/alc/docs/swagger/?url=./arc-products/arc-identity-v1.json#/Authentication/login