Detailed Description

Examples for Logout Customer

Example 1 - Logout a customer when SP initiated SSO is disabled

This example demonstrates the following:

Logging out a customer.
Response when SP initiated single sign-on is disabled

XML

Request

Method	URL
POST	`/ws/v15/context/authentication/user/logout`

Request headers

Name	Value
X-egain-session	Valid session ID
Accept	application/xml
Accept-Language	en-US

Response:
HTTP/1.1 200 OK

Response headers

Name	Values
X-egain-session	terminated session ID
Content-Type	`application/xml`

Response body

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<logout xmlns="http://bindings.egain.com/ws/model/v15/gen/platform">
    <spAuthenticationEnabled>false</spAuthenticationEnabled>
</logout>

JSON

Request

Method	URL
POST	`/ws/v15/context/authentication/user/logout`

Request headers :

Name	Value
X-egain-session	Valid session ID
Accept	application/json
Accept-Language	en-US

Response:
HTTP/1.1 200 OK

Response headers

Name	Values
X-egain-session	terminated session ID
Content-Type	`application/json`

Response body

{
    "spAuthenticationEnabled": false
}

Example 2 - Logout a customer when SP initiated SSO is enabled

This example demonstrates the following:

Logging out a customer.
Response when SP initiated single sign-on is enabled.

XML

Request

Method	URL
POST	`/ws/v15/context/authentication/user/logout`

Request headers

Name	Value
X-egain-session	Valid session ID
Accept	application/xml
Accept-Language	en-US

Response:
HTTP/1.1 200 OK

Response headers

Name	Values
X-egain-session	terminated session ID
Content-Type	`application/xml`

Response body

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<logout xmlns="http://bindings.egain.com/ws/model/v15/gen/platform">
    <spAuthenticationEnabled>true</spAuthenticationEnabled>
    <idpLogoutUrl>https://idp_server1.com/trust/saml2/http-redirect/slo/574499</idpLogoutUrl>
    <samlRequest>PD94bWwgdmVyc2lvbj0iMS4wIiBlbmN...</samlRequest>
    <providers>
        <provider id="186A0">
            <idp>
                <idpLogoutURL>https://idp_server1.com/trust/saml2/http-redirect/slo/574499</idpLogoutURL>
                <samlRequest>PD94bWwgdmVyc2lvbj0iMS4wIiBlbmN...</samlRequest>
            </idp>
            <default>true</default>
        </provider>
        <provider id="186A1">
            <idp>
                <idpLogoutURL>https://idp_server2.com/trust/saml2/http-redirect/slo/574499</idpLogoutURL>
                <samlRequest>XPD94bWwgdmVyc2lv...</samlRequest>
            </idp>
            <default>false</default>
        </provider>
    </providers>
</logout>

JSON

Request

Method	URL
POST	`/ws/v15/context/authentication/user/logout`

Request headers :

Name	Value
X-egain-session	Valid session ID
Accept	application/json
Accept-Language	en-US

Response:
HTTP/1.1 200 OK

Response headers

Name	Values
X-egain-session	terminated session ID
Content-Type	`application/json`

Response body

{
    "spAuthenticationEnabled": true,
    "idpLogoutUrl": "https://idp_server1.com/trust/saml2/http-redirect/slo/574499",
    "samlRequest": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmN...",
    "providers": {
        "provider": [{
            "idp": {
                "idpLogoutURL": "https://idp_server1.com/trust/saml2/http-redirect/slo/574499",
                "samlRequest": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmN..."
            },
            "default": true,
            "id": "186A0"
        }, {
            "idp": {
                "idpLogoutURL": "https://idp_server2.com/trust/saml2/http-redirect/slo/574499",
                "samlRequest": "XPD94bWwgdmVyc2lv..."
            },
            "default": false,
            "id": "186A1"
        }]
    }
}