/session

Destroys the Session

delete

/session/{sessionSecret}

Authorizations

auth_bearersession_secret

Path parameters

sessionSecretanyrequired

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/session/{sessionSecret}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

400

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

Creates a Session

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.

post

/session

Authorizations

auth_bearersession_secret

Body

userIdanyrequired

The user ID.

passwordanyrequired

The password.

profileIdany

The profile ID to assign to the session.

profileSelectorany

A query string to select the profile to use.

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/session' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "userId": null,
    "password": null,
    "profileId": null,
    "profileSelector": null
  }'

400

401

403

404

409

500

501

503

default

400

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