Logon

Log on

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

POST/api/Session/logon

Query parameters

Body

Contains the information about the session.

username*nullable string

Parallels RAS administrator username.

password*nullable string

Parallels RAS administrator password.

Response

Success

Body

authTokennullable string

The Authentication Token of the current session.

localAuthboolean

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

userIdinteger (int32)

The User ID connected to the current session.

applySettingsEnabledboolean

Specifies if Settings need to be applied or not.

connectedSiteIdinteger (int32)

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

settingsIdinteger (int32)

The current Settings ID.

sessionIdinteger (int32)

The ID of the current session.

connectedServernullable string

The Server that the current session is connected to.

licensingServernullable string

The Licensing Server.

primaryBrokerConnectionboolean

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

licensingServerConnectionboolean

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

domainnullable string

Specifies the Domain where the Connection Broker is installed.

farmNamenullable string

Specifies the Farm Name.

farmGUIDnullable string

Specifies the Farm GUID.

Request

const response = await fetch('/api/Session/logon', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "password": "text",
      "username": "text"
    }),
});
const data = await response.json();

Response

{
  "authToken": "text",
  "localAuth": false,
  "applySettingsEnabled": false,
  "connectedServer": "text",
  "licensingServer": "text",
  "primaryBrokerConnection": false,
  "licensingServerConnection": false,
  "domain": "text",
  "farmName": "text",
  "farmGUID": "text"
}

PreviousLogoff NextAdministrators

const response = await fetch('/api/Session/logon', { method: 'POST', headers: { "Content-Type": "application/json; api-version=1.0" }, body: JSON.stringify({ "password": "text", "username": "text" }), }); const data = await response.json();

{ "authToken": "text", "localAuth": false, "applySettingsEnabled": false, "connectedServer": "text", "licensingServer": "text", "primaryBrokerConnection": false, "licensingServerConnection": false, "domain": "text", "farmName": "text", "farmGUID": "text" }