API Reference

Users

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

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

TypeScript

HTTP

TypeScript

import ArenaDemoDayDemoDocsDemoSite from 'arena-demo-day-demo-docs-demo-site-and-typescript-library';

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

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

console.log(response);

200 example

"string"

Returns Examples

200 example

"string"