api_auth

<back to all web services

LogoutRequest

The following routes are available for this service:
POST/api/logoutClears one or more sessions between current user and bit.pub web site. Optionally also clears site\application authorizations.
LogoutRequest Parameters:
NameParameterData TypeRequiredDescription
TokenbodystringNoFor internal use only - do not set.
SiteIDbodylong?NoSite to remove all authorizations from
AppIDbodylong?NoApplication to remove all authorizations from
SessionIDbodylong?NoSpecific session to remove
AllSessionsbodyboolNoSet to clear all sessions
AllAppsbodyboolNoSet to clear all application authorizations

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/logout HTTP/1.1 
Host: 1.hyper.id 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<LogoutRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bitpub.Api.Auth.Common">
  <AllApps>false</AllApps>
  <AllSessions>false</AllSessions>
  <AppID>0</AppID>
  <SessionID>0</SessionID>
  <SiteID>0</SiteID>
  <Token>String</Token>
</LogoutRequest>