Difference between revisions of "Protocols/WebAPI/Auth/Client/getConsent"

From NINA Wiki
Jump to navigation Jump to search
 
Line 1: Line 1:
 
{{Protocols/WebAPI}}
 
{{Protocols/WebAPI}}
  
 +
This page is about the getConsent method for [[Protocols/WebAPI/Auth|WebAPI authentication]].
  
 +
This method should only be used to obtain the user's consent (permission) to access an NINA/AIM Service on behalf of the user, when instructed to by the NINA/AIM Services with status code '340' along with a redirect URL.
 +
 +
== Initial Request ==
 +
 +
For client logins (token obtained via 'clientLogin' methods), the client must do a "direct" request to the getConsent Url along with the required parameters as specified below. The getConsent Url returned by the NINA/AIM Services contains only the "enc" parameter, so you must add the other required parameters specified below.
 +
 +
* URL
 +
** http(s)://api.screenname.nina.bz/auth/getConsent
 +
* 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)
 +
** enc (required)
 +
*** The encrypted token returned by the previous call to OpenAuth or NINA/AIM Open Service as part of the 'redirectUrl'. Since the getConsent url already contains the 'enc' parameter, you don't need to manually add it.
 +
** 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
 +
** context (optional)
 +
*** Context returned in previous getConsent request when additional challenges are required
 +
** word (optional)
 +
*** Captcha Word when Captcha challenge is returned in previous request
  
  

Revision as of 16:53, 25 March 2020

WebAPI Protocol
Basic
Introduction
Clients
Whimsicals
Host Interaction
Flow
Authentication
Client
WebApp
Other Services
Foodgroups

This page is about the getConsent method for WebAPI authentication.

This method should only be used to obtain the user's consent (permission) to access an NINA/AIM Service on behalf of the user, when instructed to by the NINA/AIM Services with status code '340' along with a redirect URL.

Initial Request

For client logins (token obtained via 'clientLogin' methods), the client must do a "direct" request to the getConsent Url along with the required parameters as specified below. The getConsent Url returned by the NINA/AIM Services contains only the "enc" parameter, so you must add the other required parameters specified below.

  • URL
    • http(s)://api.screenname.nina.bz/auth/getConsent
  • 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)
    • enc (required)
      • The encrypted token returned by the previous call to OpenAuth or NINA/AIM Open Service as part of the 'redirectUrl'. Since the getConsent url already contains the 'enc' parameter, you don't need to manually add it.
    • 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
    • context (optional)
      • Context returned in previous getConsent request when additional challenges are required
    • word (optional)
      • Captcha Word when Captcha challenge is returned in previous request