/session

Destroys the Session

delete

Authorizations

auth_bearersession_secret

AuthorizationstringRequired

Path parameters

sessionSecretanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

*/*

delete

/session/{sessionSecret}

HTTPcURLJavaScriptPython

DELETE /api/rest/session/{sessionSecret} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

{
  "code": "text",
  "message": "text"
}

Creates a Session

post

Begins a session by accepting both the UserID and the Passoword. Upon successful completion of this call, the user will be added to the current HTTP session. If the session expires, the user will have to reestablish the session by supplying credentials again. This is most useful for applications delivered in a web page.

Authorizations

auth_bearersession_secret

AuthorizationstringRequired

Body

application/json

userIdanyRequired

The user ID.

passwordanyRequired

The password.

profileIdanyOptional

The profile ID to assign to the session.

profileSelectoranyOptional

A query string to select the profile to use.

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

post

/session

HTTPcURLJavaScriptPython

POST /api/rest/session HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "userId": null,
  "password": null,
  "profileId": null,
  "profileSelector": null
}

{
  "code": "text",
  "message": "text"
}