Skip to content

Session api

Overview

The 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 successfully 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" : "56814017-7485-46bd-89a6-54215414966d",
  "ui_callback_tokens" : [ {
    "extension_point" : "extension-point",
    "token" : "token-1-2",
    "completed" : false
  } ],
  "session_data" : {
    "idp_id" : "f61e9b40-60f0-41e4-a61a-4f34c636d7c8",
    "external_id" : "0d5fd25c-81d3-4d4e-a931-54289fe5083f",
    "postProcessActions" : [ "UI_AUTHENTICATION_POST_PROCESS_REQUIRED" ],
    "extension_custom_parameters" : {
      "appView" : [ "mobile" ],
      "key1" : [ "value1", "value2" ]
    }
  }
}

Definitions

post_process_action

Action to be executed in CIM after processing in extension has been completed.

Type : enum (SKIP_REQUIRED_EMAIL_VERIFICATION, UI_AUTHENTICATION_POST_PROCESS_REQUIRED)

session_data

Name Description Schema
extension_custom_parameters
optional
Custom Parameters represented as a Map that are passed via the SAML AuthnRequest extension. This is dynamic based on what is sent from the SAML Service Provider and persist until the SAML flow has completed.
Example : {<br> "appView" : [ "mobile" ],<br> "key1" : [ "value1", "value2" ]<br>}
object
external_id
optional
Identifier of a user returned by an external Identity Provider like for e.g.Facebook
Example : "0d5fd25c-81d3-4d4e-a931-54289fe5083f"
string
idp_id
optional
Identifier of a user within CIM
Example : "f61e9b40-60f0-41e4-a61a-4f34c636d7c8"
string
postProcessActions
optional
Additional properties required for callback actions (may be different for different actions)
Example : [ "[post_process_action](#post_process_action)" ]
< post_process_action > array

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 : false
boolean
extension_point
required
Identifier of extension which points to action that extension has to perform
Example : "extension-point"
string
token
required
Randomly generated token
Example : "token-1-2"
string

user_session_info

Object that contains user session data required for ui extensions

Name Description Schema
person_id
required
User individual identifier
Example : "56814017-7485-46bd-89a6-54215414966d"
string (uuid)
session_data
required
Example : "[session_data](#session_data)" session_data
ui_callback_tokens
required
Array of token objects for callback actions
Example : [ "[ui_callback_token](#ui_callback_token)" ]
< ui_callback_token > array