AuthenticationRequest

Credentials for authenticating a Control Room user. Provide either password or apiKey along with the username.

Properties

Name	Type	Description
username	string	The Control Room username
password	string	The user's password (use instead of apiKey for password-based auth)
apiKey	string	The user's API key (use instead of password for key-based auth)
multipleLogin	boolean	Whether to allow multiple concurrent sessions for this user

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AuthenticationRequest",
  "title": "AuthenticationRequest",
  "type": "object",
  "description": "Credentials for authenticating a Control Room user. Provide either password or apiKey along with the username.",
  "required": [
    "username"
  ],
  "properties": {
    "username": {
      "type": "string",
      "description": "The Control Room username"
    },
    "password": {
      "type": "string",
      "description": "The user's password (use instead of apiKey for password-based auth)"
    },
    "apiKey": {
      "type": "string",
      "description": "The user's API key (use instead of password for key-based auth)"
    },
    "multipleLogin": {
      "type": "boolean",
      "description": "Whether to allow multiple concurrent sessions for this user"
    }
  }
}