Log Off

Authenticated end-users can be logged off using this API.

Each authenticated end-user will be assigned a session key uniquely identifying them for all data requests. Logging the user off invalidates this session key so that it can't be used in future.

Session keys expire after a period of time or if some other event causes the validity of the key to become invalid.

Logoff Subscriber

POST Security/Logoff

This is a POST method which passes both the API and session keys as headers. If successful, then the session key is invalidated and can't be re-used.

Headers

Name
Value

Content-Type

application/json

SiteKey

API Key

DataServicesKey

Session Key

Body

No body is required as the API knows who the subscriber is from their session key.

Response

{
  "Success": true
}

Last updated