Class AuthProvider

authenticate

• authenticate(credentials: {}): PromiseLike<User>
• authenticate(credentials: {}, resultHandler: ((res: AsyncResult<User>) => void) | Handler<AsyncResult<User>>): void
• authenticate(credentials: Credentials): PromiseLike<User>
• authenticate(credentials: Credentials, resultHandler: ((res: AsyncResult<User>) => void) | Handler<AsyncResult<User>>): void

• Authenticate a user.

  The first argument is a JSON object containing information for authenticating the user. What this actually contains depends on the specific implementation. In the case of a simple username/password based authentication it is likely to contain a JSON object with the following structure:

    {
      "username": "tim",
      "password": "mypassword"
    }
  

  For other types of authentication it contain different information - for example a JWT token or OAuth bearer token.

  If the user is successfully authenticated a object is passed to the handler in an . The user object can then be used for authorisation.

  Parameters

  • credentials: {}

    • [key: string]: any

  Returns PromiseLike<User>

• Authenticate a user.

  The first argument is a JSON object containing information for authenticating the user. What this actually contains depends on the specific implementation. In the case of a simple username/password based authentication it is likely to contain a JSON object with the following structure:

    {
      "username": "tim",
      "password": "mypassword"
    }
  

  For other types of authentication it contain different information - for example a JWT token or OAuth bearer token.

  If the user is successfully authenticated a object is passed to the handler in an . The user object can then be used for authorisation.

  Parameters

  • credentials: {}

    • [key: string]: any

  • resultHandler: ((res: AsyncResult<User>) => void) | Handler<AsyncResult<User>>

  Returns void

• Authenticate a user.

  The first argument is a Credentials object containing information for authenticating the user. What this actually contains depends on the specific implementation.

  If the user is successfully authenticated a object is passed to the handler in an . The user object can then be used for authorisation.

  Parameters

  • credentials: Credentials

  Returns PromiseLike<User>

• Authenticate a user.

  The first argument is a Credentials object containing information for authenticating the user. What this actually contains depends on the specific implementation.

  If the user is successfully authenticated a object is passed to the handler in an . The user object can then be used for authorisation.

  Parameters

  • credentials: Credentials

  • resultHandler: ((res: AsyncResult<User>) => void) | Handler<AsyncResult<User>>

  Returns void