Skip to content
Justin Docs Test
  • Auto
  • Light
  • Dark
Get started

Login

API Reference
Users
Logs user into the system
client.users.login(UserLoginParams { password, username } query?, RequestOptionsoptions?): UserLoginResponse
get/user/login

Logs user into the system

ParametersExpand Collapse
query: UserLoginParams { password, username }
password?: string

The password for login in clear text

username?: string

The user name for login

ReturnsExpand Collapse
UserLoginResponse = string
Logs user into the system
  • http
  • typescript
import JustinDocsTest from 'justin-docs-test';

const client = new JustinDocsTest({
  apiKey: 'My API Key',
});

const response = await client.users.login();

console.log(response);
"string"
Returns Examples
"string"