Methods
(async) passwordAuth(client, loginOptions)
Use username and password to login and get the access token.
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
loginOptions.endpoint |
String
|
The login endpoint. |
|
loginOptions.username |
String
|
The username, can be customized by usernameField. |
|
loginOptions.password |
String
|
The password. |
|
loginOptions.usernameField |
String
|
<optional> |
The username field name, default "username". |
loginOptions.tokenKey |
String
|
<optional> |
The token key path, default "token". |
loginOptions.query |
Object
|
<optional> |
The query parameters. |
loginOptions.headers |
Object
|
<optional> |
Extra headers. |
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
client |
*
|
|
loginOptions |
Object
|