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

application/json; api-version=1.0

Create a new administrator session

usernamestring | nullableRequired

Parallels RAS administrator username.

passwordstring | nullableRequired

Parallels RAS administrator password.

Responses

200

Success

application/json; api-version=1.0

post

/api/Session/logon

HTTPcURLJavaScriptPython

POST /api/Session/logon HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 37

{
  "username": "text",
  "password": "text"
}

200

Success

{
  "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"
}