Single Sign-On API \ List all open SSO sessions PHP SDK

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.json to obtain the list of active Single Sign-On sessions.

Result: the code returned by the API

The API either returns a HTTP status code 200 and the list of SSO sessions or an appropriate message body with further details on the error that occured. Requests that return multiple entries are paginated to 250 items by default.

Example Resultset

{
    "response": {
        "request": {
            "date": "Fri, 24 Jan 2014 11:40:34  0100",
            "resource": "/sso/sessions.json",
            "status": {
                "flag": "success",
                "code": 200,
                "info": "Your request has been processed successfully"
            }
        },
        "result": {
            "data": {
                "sso_sessions": {
                    "pagination": {
                        "current_page": 1,
                        "total_pages": 1,
                        "entries_per_page": 250,
                        "total_entries": 2,
                        "order": {
                            "field": "date_creation",
                            "direction": "desc"
                        }
                    },
                    "count": 2,
                    "entries": [
                        {
                            "sso_session_token": "8ffbe7d7-b899-4176-8220-54c136949b01",
                            "user_token": "b8551e23-49e0-4f1a-9f34-090011f67fb8",
                            "identity_token": "45de5526-5022-4019-9d47-ed02f04bdff5",
                            "top_realm": "garden",
                            "sub_realm": "vegetables",
                            "data": "carrot",
                            "date_update": "Fri, 24 Jan 2014 10:46:52  0100",
                            "date_creation": "Thu, 23 Jan 2014 14:26:05  0100",
                            "date_expiration": "Sat, 25 Jan 2014 10:46:52  0100"                            
                        },
                        {         
                            "sso_session_token": "fce86b47-ead4-41ae-a903-0cfe7e86fd40",
                            "user_token": "65b36eab-ef01-4809-b074-0541613d0c80",
                            "identity_token": "faa09285-edaf-4c1c-a27f-8fe1315f2819",
                            "top_realm": "garden",
                            "sub_realm": "vegetables",
                            "data": "tomato",
                            "date_update": "Fri, 24 Jan 2014 10:46:52  0100",
                            "date_creation": "Thu, 23 Jan 2014 14:26:05  0100",
                            "date_expiration": "Sat, 25 Jan 2014 10:46:52  0100"                            
                        }
                    ]
                }
            }
        }
    }
}

User Contributed Notes