Difference between revisions of "Protocols/WebAPI/Auth/Client/logout"
Jump to navigation
Jump to search
(Created page with "{{Protocols/WebAPI}} Category:Stub Category:AOL Category:AIM Category:Protocols/WebAPI Category:Work_In_Progress") |
|||
Line 1: | Line 1: | ||
{{Protocols/WebAPI}} | {{Protocols/WebAPI}} | ||
+ | This page is about the logout method for [[Protocols/WebAPI/Auth|WebAPI authentication]]. | ||
+ | Terminates the user's authentication session and invalidates the Authentication Tokens obtained via 'clientLogin' method. | ||
+ | |||
+ | == Initial Request == | ||
+ | |||
+ | * URL | ||
+ | ** http(s)://api.screenname.nina.bz/auth/logout | ||
+ | * HTTP Method | ||
+ | ** GET or POST | ||
+ | * Arguments | ||
+ | ** devId (required) | ||
+ | *** your developer Id required to access NINA APIs | ||
+ | ** f (required) | ||
+ | *** the required format of the response (json or xml or qs) | ||
+ | ** s (optional) | ||
+ | *** the loginID of the source user (if known) | ||
+ | ** language (optional) | ||
+ | *** the required language and locale of the error/status messages. This is always in "<lang>-<locale>" format. The lang is the 2 letter language code for I18N (default: en) and the locale is the 2 letter Locale code for I18N (default: us). If not passed in, the language will be extracted from HTTP header (Accept-Language) and if that is not available will default to "en-us". Check below for our current supported language list. | ||
+ | ** c (optional) | ||
+ | *** the callback method to use when using jsonp convention (argument f = json) | ||
+ | ** r (optional) | ||
+ | *** an URL safe string to be used as requestId - when passed it is returned back in the response | ||
+ | ** a (required) | ||
+ | *** the Authentication token returned by login or getToken methods | ||
+ | ** sig_sha256 (required) | ||
+ | *** Base64 encoded digital signature (HMAC-SHA256) of the request using the Session Key generated as below. | ||
+ | **** Session Key = base64_encode((HMAC-SHA256(key, data))) where key is the user's password and data is the session secret obtained from clientLogin response. | ||
+ | *** Please refer to [[Protocols/WebAPI/Auth/Signing_Requests|Signing Requests]] for information about how to generate signature. | ||
Revision as of 17:04, 25 March 2020
WebAPI Protocol |
Basic |
Introduction |
Clients |
Whimsicals |
Host Interaction |
Flow |
Authentication |
• Client |
• WebApp |
Other Services |
• |
Foodgroups |
This page is about the logout method for WebAPI authentication.
Terminates the user's authentication session and invalidates the Authentication Tokens obtained via 'clientLogin' method.
Initial Request
- URL
- http(s)://api.screenname.nina.bz/auth/logout
- HTTP Method
- GET or POST
- Arguments
- devId (required)
- your developer Id required to access NINA APIs
- f (required)
- the required format of the response (json or xml or qs)
- s (optional)
- the loginID of the source user (if known)
- language (optional)
- the required language and locale of the error/status messages. This is always in "<lang>-<locale>" format. The lang is the 2 letter language code for I18N (default: en) and the locale is the 2 letter Locale code for I18N (default: us). If not passed in, the language will be extracted from HTTP header (Accept-Language) and if that is not available will default to "en-us". Check below for our current supported language list.
- c (optional)
- the callback method to use when using jsonp convention (argument f = json)
- r (optional)
- an URL safe string to be used as requestId - when passed it is returned back in the response
- a (required)
- the Authentication token returned by login or getToken methods
- sig_sha256 (required)
- Base64 encoded digital signature (HMAC-SHA256) of the request using the Session Key generated as below.
- Session Key = base64_encode((HMAC-SHA256(key, data))) where key is the user's password and data is the session secret obtained from clientLogin response.
- Please refer to Signing Requests for information about how to generate signature.
- Base64 encoded digital signature (HMAC-SHA256) of the request using the Session Key generated as below.
- devId (required)