Skip to content

Create Session

Creates a new Session within a specified Organization.

Verb PUT
Endpoint {base-url}/sessions/management/
Max Page Size N/A

Request Body

{
  "body": [
    {
      "machineId": 42,
      "startedAtUtc": "2022-08-31T20:04:33.623",
      "login": "example@example.com",
      "reason": null,
      "loginWasSuccessful": true,
      "endedAtUtc": null,
      "wasAbandoned": false,
      "source": "Web",
      "organizationId": 1
    }
  ]
}

Note

All changes in this request are atomic. If any item fails, the entire batch is rolled back and no changes are made.

Returns

On Success

The ids of the created Session.

Response Body

[
  1673
]

On Error

HTTP Code Error Code Definition
403 DATA_ACCESS_VIOLATION The body organizationId, or the referenced machineId, belongs to an organization you do not have access to.
404 MISSING_RECORD The referenced machineId does not exist.
422 VALIDATION_ERROR A required field is missing or invalid: startedAtUtc, loginWasSuccessful and wasAbandoned are required, organizationId must be 1 or greater, and a supplied machineId must be 1 or greater. Also returned when a value exceeds its length limit (login and reason max 500 characters, source max 50 characters).