Session api
Overview
This Session api allows to fetch parts of the session data for a given session token
Version information
Version : 1.0.0
Paths
Get user session data
GET /api/session
Description
The endpoint allows to get user session data. The response is provided in JSON format.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header | X-Onegini-Session-Mgmt-Token required |
Session management token from cookie | string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Session data obtained succesfully | user_session_info |
401 | Unauthorized | No Content |
404 | Session data not found | No Content |
405 | Unsupported method | No Content |
500 | Api disabled | No Content |
Produces
application/json
Example HTTP request
Request path
/api/session
Request header
"string"
Example HTTP response
Response 200
{
"person_id" : "string",
"ui_callback_tokens" : [ {
"extension_point" : "string",
"token" : "string",
"completed" : true
} ],
"session_data" : {
"string" : "object"
}
}
Definitions
ui_callback_token
Object that contains callback details required to identify extension points and mark their completion
Name | Description | Schema |
---|---|---|
completed required |
Completion flag Example : true |
boolean |
extension_point required |
Identifier of extension which points to action that extension has to perform Example : "string" |
string |
token required |
Example : "string" |
string |
user_session_info
Object that contains user session data required for ui extensions
Name | Description | Schema |
---|---|---|
person_id required |
User individual identifier Example : "string" |
string (uuid) |
session_data required |
Additional properties required for callback actions (may be different for different actions Example : {<br> "string" : "object"<br>} |
< string, object > map |
ui_callback_tokens required |
Array of token objects for callback actions Example : [ "[ui_callback_token](#ui_callback_token)" ] |
< ui_callback_token > array |