Logon

Log on

post

Authenticate the user. When successful, an authorization token will be generated.

Query parameters

localAuthbooleanoptional

Authenticate with local machine to configure local Web Admin Settings. NOTE: Only localhost connections are allowed.

Body

Create a new administrator session

usernamestring | nullablerequired

Parallels RAS administrator username.

passwordstring | nullablerequired

Parallels RAS administrator password.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/Session/logon' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "username": "text",
    "password": "text"
  }'

200

200

{
  "authToken": "text",
  "localAuth": true,
  "userId": 1,
  "applySettingsEnabled": true,
  "connectedSiteId": 1,
  "settingsId": 1,
  "sessionId": 1,
  "connectedServer": "text",
  "licensingServer": "text",
  "primaryBrokerConnection": true,
  "licensingServerConnection": true,
  "domain": "text",
  "farmName": "text",
  "farmGUID": "text"
}

Success