Protocols/WebAPI/Auth/WebApp/logout

WebAPI Protocol

Basic

Introduction

Clients

Whimsicals

Host Interaction

Flow

Authentication

• Client

• WebApp

Other Services

•

Foodgroups

This page is about the logout method for WebAPI Web App authentication.

Terminates the user's authentication session and invalidates the Authentication Tokens assigned to all Web Sites/Applications for the current user. The logout method can be invoked either as a redirect with succUrl argument or as a JSON/JSONP call in a browser and also can be invoked from Server

• URL
  • http(s)://api.nina.chat/auth/logout
• HTTP Method
  • o 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)
  • succUrl (optional)
    • the destination url where the site wants the user to be redirected to upon successful logout. If no succUrl is provided, it would be assumed that the calling site is using JSON/JSONPcall and the response is simply returned as a JSON object.
    • NOTE: The succUrl is used as the "Trust Url" that's displayed to the users and also used to limit the scope of the Authentication Token.
    • If no succUrl is used, the REFERER header will be used as the "Trust Url".
    • If neither succUrl nor REFERER header are available, then the request would be blocked.
  • 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

Response Format

Response would contain the statusCode indicating whether the logout was successful or not.

If the requested response format is xml or json and 'succUrl' parameter is provided in the request, the response data will be url encoded and appended to the 'succUrl' as a Query Parameter "res". ex. ${succUrl}?res=<response-data>.

The XML standard wrapper

       <response>
            <statusCode />
            <statusText />
            <statusDetailCode />
            <requestId />

       </response> 

The JSON standard wrapper

   {"response":{
        "statusCode":""
        "statusText":"",
        "statusDetailCode":""

        "requestId":""
   }}
        

Query String

The following parameters will be returned back as URL query parameters to your succUrl:

         statusCode
         statusText
         statusDetailCode
         requestId

• Error Codes
  • 200 - Success (Ok)
  • 304 - Not modified
  • 400 - Invalid request
  • 405 - Method not allowed
  • 408 - Request timeout
  • 430 - Source rate limit reached
  • 440 - Invalid Key
  • 441 - Key usage limit reached
  • 442 - Key invalid IP
  • 443 - Key used from unauthorized site
  • 444 - token used from unauthorized site (Referer doesn't match the value in token)
  • 460 - Missing required parameter
  • 461 - Source required
  • 462 - Parameter error
  • 500 - Generic Server Error

Sample Response

XML

    <response xmlns="https://api.login.aol.com">
        <statusCode>200</statusCode>

        <statusText>OK</statusText>
    </response>

JSON

    {"response":{
        "statusCode":200,
        "statusText":"OK"

    }}

Query String

    statusCode=200&statusText=OK