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

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

2020-03-25T22:53:35Z

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

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

AD at 22:53, 25 March 2020

2020-03-25T22:53:27Z

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

	This page is about the getInfo method for [[Protocols/WebAPI/Auth\|WebAPI ~~authentication~~]].		This page is about the getInfo method for [[Protocols/WebAPI/Auth/Client\|WebAPI Client]] authentication.

	Validates the Authentication Token issued by clientLogin method and returns user's loginId, displayName and the authentication time stamp. This method also provides a way (see 'reqRights' argument below) for the client to obtain user's consent and manage it securely.		Validates the Authentication Token issued by clientLogin method and returns user's loginId, displayName and the authentication time stamp. This method also provides a way (see 'reqRights' argument below) for the client to obtain user's consent and manage it securely.
Line 31:		Line 31:
	*** Base64 encoded digital signature (HMAC-SHA256) of the request using the Session Key generated as below.		*** 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.		**** 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.		*** Please refer to [[Protocols/WebAPI/Auth/Client/Signing_Requests\|Signing Requests]] for information about how to generate signature.

	== Response Format ==		== Response Format ==
Line 143:		Line 143:
	[[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:19, 25 March 2020

2020-03-25T18:19:59Z

← Older revision		Revision as of 18:19, 25 March 2020
Line 62:		Line 62:
	"statusText":"",		"statusText":"",
	"statusDetailCode":""		"statusDetailCode":""

	"requestId":""		"requestId":""
	"data":{		"data":{
Line 113:		Line 112:
	<userData>		<userData>
	<loginId>ChattingChuck</loginId>		<loginId>ChattingChuck</loginId>

	<displayName>Chuck</displayName>		<displayName>Chuck</displayName>
	<lastAuth>1161932570000</lastAuth>		<lastAuth>1161932570000</lastAuth>

AD: /* Response Format */

2020-03-25T18:19:19Z

Response Format

← Older revision		Revision as of 18:19, 25 March 2020
Line 41:		Line 41:
	** displayName -- User's Display Name		** displayName -- User's Display Name
	** lastAuth -- Seconds since the user was last authenticated		** lastAuth -- Seconds since the user was last authenticated
	* redirectURL		* redirectURL -- Redirect URL where the user should be redirected to.

	=== The XML standard wrapper ===		=== The XML standard wrapper ===

AD at 18:18, 25 March 2020

2020-03-25T18:18:37Z

@@ Line 15: / Line 15: @@
 *** 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)
 ** 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.
@@ Line 35: / Line 35: @@
 == Response Format ==
-The following data elements would be returned in the response:
+The following data elements would be returned in the response
 * userData
@@ Line 41: / Line 41: @@
 ** displayName -- User's Display Name
 ** lastAuth -- Seconds since the user was last authenticated
-* redirectURL -- Redirect URL where the user should be redirected to.
+* redirectURL
 [[Category:Stub]]

AD at 17:15, 25 March 2020

2020-03-25T17:15:22Z

← Older revision		Revision as of 17:15, 25 March 2020
Line 32:		Line 32:
	**** 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.		**** 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.		*** Please refer to [[Protocols/WebAPI/Auth/Signing_Requests\|Signing Requests]] for information about how to generate signature.

			== Response Format ==

			The following data elements would be returned in the response:

			* userData
			** loginId -- User's Login Identifier
			** displayName -- User's Display Name
			** lastAuth -- Seconds since the user was last authenticated
			* redirectURL -- Redirect URL where the user should be redirected to.

AD at 17:02, 25 March 2020

2020-03-25T17:02:23Z

← Older revision		Revision as of 17:02, 25 March 2020
Line 30:		Line 30:
	** sig_sha256 (required)		** sig_sha256 (required)
	*** Base64 encoded digital signature (HMAC-SHA256) of the request using the Session Key generated as below.		*** 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.		**** 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.		*** Please refer to [[Protocols/WebAPI/Auth/Signing_Requests\|Signing Requests]] for information about how to generate signature.

AD at 17:01, 25 March 2020

2020-03-25T17:01:45Z

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

			This page is about the getInfo method for [[Protocols/WebAPI/Auth\|WebAPI authentication]].

			Validates the Authentication Token issued by clientLogin method and returns user's loginId, displayName and the authentication time stamp. This method also provides a way (see 'reqRights' argument below) for the client to obtain user's consent and manage it securely.

			== Initial Request ==

			* URL
			** http(s)://api.screenname.nina.bz/auth/getInfo
			* 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)
			** 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.
			** reqAuthFreshness (optional)
			*** required Authentication freshness in secs ( time since the user was last authenticated). Default is 24 hrs (86400 secs)
			** 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
			** ts (required)
			*** current timestamp in seconds since epoch used to make sure the request cannot be replayed after a few mins
			** 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.

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

2020-03-25T15:59:20Z

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]]