Protocols/WebAPI/Auth/Client/getConsent - Revision history

AD: AD moved page Protocols/WebAPI/Auth/getConsent to Protocols/WebAPI/Auth/Client/getConsent without leaving a redirect

2020-03-25T22:54:05Z

AD moved page Protocols/WebAPI/Auth/getConsent to Protocols/WebAPI/Auth/Client/getConsent without leaving a redirect

← Older revision	Revision as of 22:54, 25 March 2020
(No difference)

AD at 22:53, 25 March 2020

2020-03-25T22:53:57Z

← Older revision		Revision as of 22:53, 25 March 2020
Line 1:		Line 1:
	{{Protocols/WebAPI}}		{{Protocols/WebAPI}}

	This page is about the getConsent method for [[Protocols/WebAPI/Auth\|WebAPI ~~authentication~~]].		This page is about the getConsent method for [[Protocols/WebAPI/Auth/Client\|WebAPI Client]] 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.		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.
Line 127:		Line 127:
	[[Category:AIM]]		[[Category:AIM]]
	[[Category:Protocols/WebAPI]]		[[Category:Protocols/WebAPI]]
			[[Category:Protocols/WebAPI/Auth]]
			[[Category:Protocols/WebAPI/Auth/Client]]
	[[Category:Work_In_Progress]]		[[Category:Work_In_Progress]]

AD at 18:14, 25 March 2020

2020-03-25T18:14:10Z

@@ Line 4: / Line 4: @@
 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 ==
 * URL
@@ Line 17: / Line 17: @@
 *** your developer Id required to access NINA APIs
 ** f (required)
-*** the required format of the response (json or xml or qs)
+*** the required format of the response (XML, JSON, or the query string)
 ** 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.
@@ Line 41: / Line 41: @@
 ** url -- Url for obtaining Captcha (Refer to getCaptcha for more information)
 [[Category:Stub]]

AD at 17:12, 25 March 2020

2020-03-25T17:12:48Z

← Older revision		Revision as of 17:12, 25 March 2020
Line 30:		Line 30:
	** word (optional)		** word (optional)
	*** Captcha Word when Captcha challenge is returned in previous request		*** Captcha Word when Captcha challenge is returned in previous request

			== Response Format ==

			The following data elements will be returned in the response. If a 'challenge' is returned, the application must present the information to the user along with the captcha image/audio. Once the user enters the captcha word, send the 'getConsent' request again with the required parameters along with the user entered captcha word and context.

			* statusText -- contains the message that needs to be displayed to the user regarding the permission that is being granted to the Consumer application
			* challenge -- when user needs to be captcha challenged to get permission to access protected content
			** info -- Free form text to display to the user
			** context -- challenge context to be returned on subsquent getConsent requests
			** url -- Url for obtaining Captcha (Refer to getCaptcha for more information)

AD at 16:53, 25 March 2020

2020-03-25T16:53:45Z

← Older revision		Revision as of 16:53, 25 March 2020
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

AD: Created page with "{{Protocols/WebAPI}} Category:Stub Category:AOL Category:AIM Category:Protocols/WebAPI Category:Work_In_Progress"

2020-03-25T15:59:11Z

Created page with "{{Protocols/WebAPI}} Category:Stub Category:AOL Category:AIM Category:Protocols/WebAPI Category:Work_In_Progress"

New page

{{Protocols/WebAPI}}

[[Category:Stub]]
[[Category:AOL]]
[[Category:AIM]]
[[Category:Protocols/WebAPI]]
[[Category:Work_In_Progress]]