πSessions
This page provides a description of the available API routes for managing sessions.
After a user is authenticated, a session is created. For all subsequent requests to the API, specific rules based on the user's authentication scheme must be applied. If the session resource is deleted, the user will no longer be able to use the token issued in the last authentication and will need to log in again. The session is represented by the Session
class.
API methods
Get sessions
GET
http://{server-address}/sessions
Returns all sessions that matches query parameters. Result is of type QueryResult<Session>
.
Query Parameters
sessionId
string
Supports NData syntax.
$skip
int
Pagination property. Describing number of records to skip from beginning of result collection.
$take
int
Pagination property. Maximum count of items to be returned.
$sort
string[]
Comma separated list of property names. Please see NData syntax.
$count
bool
If set to true
, response will not contain items
collection. Use to get resource count, not the resources themselves.
Headers
Authorization*
string
Authorization header with authorization token.
Get session
GET
http://{server-address}/sessions/{id}
Result is of type Session.
Path Parameters
id*
string
Unique session identifier.
Headers
Authorization*
string
Authorization header with authorization token.
Delete session
DELETE
http://{server-address}/sessions/{id}
Result is of type Session.
Required rights
No user rights are required to perform this method.
Path Parameters
id*
string
Unique session identifier.
Headers
Authorization*
string
Authorization header with authorization token.
Last updated