Id02256 at 22:05, 15 November 2020

2020-11-15T22:05:00Z

Id02256: Created page with "{{Api_Method_Spec| Description=This method requires an authenticated token, and returns the Aura ID associated with the DeviceId in the token (from GVP_USERS_AUTH_TOKENS table..."

2020-11-15T22:04:42Z

Created page with "{{Api_Method_Spec| Description=This method requires an authenticated token, and returns the Aura ID associated with the DeviceId in the token (from GVP_USERS_AUTH_TOKENS table..."

New page

{{Api_Method_Spec|
Description=This method requires an authenticated token, and returns the Aura ID associated with the DeviceId in the token (from GVP_USERS_AUTH_TOKENS table).

If no Aura Id is found associated with the DeviceId, it triggers the JWT Bearer based authentication process and as a result, it returns the AuraId retrieved or an error code.

|Parameters=

{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The a logged token is required.
}}

|Returns=
Returns a JSON object containing the Aura ID

'''Example:'''

{
: "StatusCode": 0,
: "Severity": 1,
: "StatusMessage": "OK",
: "Content": {
:: "Pins": "auraId": "27a59005-4591-45ae-8f37-de8656631f1e"
: }
}

|Exceptions=
* AuthenticationRequired: 30. Returned when the method is called without a valid authenticated token
* FourthPlatformNotAvailable: 320. Returned when the 4P endpoints are not available or returned an error
* UserNotFoundInFourthPlatform : 321. Returned when the 4P User Profile search for the user UNIQUE ID doesn't return any results
* AuraBearerGenerationException : 322. Returned when there is an error in the generation of the JWT Bearer token (invalid private key)

|Cache=
This method is not cached.

|KnownIssues=
* None

|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 8.3
{{!}} Initial method design
{{!}} Francisco Milagro
{{!}}}

|SeeAlso=
}}

@@ Line 24: / Line 24: @@
 :    <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>,
 :    <span style="color: #a11;">"Content"</span>: <span style="color: #219;">{</span>
-::    <span style="color: #a11;">"Pins"</span>: <span style="color: #164;">"auraId": "27a59005-4591-45ae-8f37-de8656631f1e"</span>
+::    <span style="color: #a11;">"auraId"</span>: <span style="color: #164;">"27a59005-4591-45ae-8f37-de8656631f1e"</span>
 :    <span style="color: #a11;">}</span>
+}

GetAuraId - Revision history

Id02256 at 22:05, 15 November 2020

Id02256: Created page with "{{Api_Method_Spec| Description=This method requires an authenticated token, and returns the Aura ID associated with the DeviceId in the token (from GVP_USERS_AUTH_TOKENS table..."