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 · min: 1 · max: 255 · nullableRequired

Parallels RAS administrator username.

passwordstring · nullableRequired

Parallels RAS administrator password.

Responses

200

Success

application/json; api-version=1.0

Session

authTokenstring · nullableOptional

The Authentication Token of the current session.

localAuthbooleanOptional

Specifies if the user is Locally Authenticated or with RAS Connection Broker.

userIdinteger · int32Optional

The User ID connected to the current session.

applySettingsEnabledbooleanOptional

Specifies if Settings need to be applied or not.

connectedSiteIdinteger · int32Optional

The Site ID to which the current session is connected to.

settingsIdinteger · int32Optional

The current Settings ID.

sessionIdinteger · int32Optional

The ID of the current session.

connectedServerstring · nullableOptional

The Server that the current session is connected to.

licensingServerstring · nullableOptional

The Licensing Server.

primaryBrokerConnectionbooleanOptional

Specifies if the session is connected with the Primary Connection Broker of a Site.

licensingServerConnectionbooleanOptional

Specifies if the session is connected is with the Licensing Server.

domainstring · nullableOptional

Specifies the Domain where the Connection Broker is installed.

farmNamestring · nullableOptional

Specifies the Farm Name.

farmGUIDstring · nullableOptional

Specifies the Farm GUID.

post

/api/Session/logon

HTTPcURLJavaScriptPython

POST /api/Session/logon HTTP/1.1
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"
}