Skip to content
rp-test-docs-1
Get started
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

import RpTestDocs1 from 'rp-test-docs-1';

const client = new RpTestDocs1({
  apiKey: process.env['PETSTORE_API_KEY'], // This is the default and can be omitted
});

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

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