Single Sign-On API \ Read SSO session details PHP SDK
Single Sign-On/SSO API Resources
Resource/URI - Base | GET | POST | PUT | DELETE |
---|---|---|---|---|
Single Sign-On Sessions
/sso/sessions.json
|
List SSO sessions | – | – | – |
Single Sign-On Session
/sso/sessions/<sso_session_token>.json
|
Read SSO session | – | – | Delete SSO session |
Resource/URI - Identity | GET | POST | PUT | DELETE |
---|---|---|---|---|
Single Sign-On Identity Session
/sso/sessions/identities/<identity_token>.json
|
Read SSO session | – | Start SSO session | Destroy SSO session |
Workflow
Request: the code to send to the API
Send a GET
request to the endpoint /sso/sessions/<sso_session_token>.json
to retrieve the details of a Single
Sign-On session. The <sso_session_token>
has to be replaced by the unique token of a Single Sign-On session.
Result: the code returned by the API
The API either returns a HTTP status code 200
and the details of the session or an appropriate message body with further
details on the error that occured.
Example Resultset
{ "response": { "request": { "date": "Tue, 10 Nov 2015 16:43:44 0100", "resource": "/sso/sessions/686c24dd-9843-4802-9528-d83bdbeee24d.json", "status": { "flag": "success", "code": 200, "info": "Your request has been processed successfully" } }, "result": { "data": { "sso_session": { "sso_session_token": "686c24dd-9843-4802-9528-d83bdbeee24d", "user_token": "b8551e23-49e0-4f1a-9f34-090011f67fb8", "identity_token": "45de5526-5022-4019-9d47-ed02f04bdff5", "top_realm": "garden", "sub_realm": "vegetables", "data": "carrot", "num_cookies_set": 1, "date_creation": "Tue, 10 Nov 2015 15:40:59 0100", "date_expiration": "Wed, 11 Nov 2015 15:40:59 0100" } } } } }