Log in a user | Sample - Swagger Petstore OpenAPI 3

2 parameters

usernamestringoptional

The user's name to use for login.

passwordstringoptional

The user's password in clear text for login.

3 status codes

200Returns a string containing the successful login result.

400Returned when the supplied username or password is invalid.

defaultReturned when an unexpected error occurs.

Error handling

A 400 is returned when the supplied username or password is invalid. Provide both credentials as strings when authenticating the user.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { apiKey: process.env.API_KEY },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.login.list({
  username: "octocat",
  password: "example",
});

"example_value"

Request

Response

Errors