Bureaucrats, editor, Administrators
282
edits
Changes
Jump to navigation
Jump to search
This method will verify that the Device(deviceType/deviceId) provided is linked to the current user as TrustedDevice, and it will verify that the Device is enabled.
TODO: link with enumeration.
no edit summary
{{Api_Method_Spec|
Description=This method can be used by Trusted Devices to generate a valid tokenbased on the users' credentials. The generated Token will carry all the information regarding the device, user, etc. and is required to consume most of the methods of UNIAPI with specific user context. The token generated is valid during the next 24 hours (configurable in GVP).
The logged token can be easily identified because it starts with the chars: <span style="color: #a11;">AU_</span>
The UNIAPI will only allow users in Active status to login (excluded and suspended users will return an exception). For users in AwaitingEmailConfirmation status, it depends on a flag configured at instance level (''GVP_INSTANCES.AllowLoginBeforeEmailConfirmationFlag''):
* If ''AllowLoginBeforeEmailConfirmationFlag = true'', if the user tries to login in AwaitingEmailConfirmation status, the login will be allowed and the user status will be changed to Active status.
* If ''AllowLoginBeforeEmailConfirmationFlag = false'', then [[UNIAPI_Specification#UserNotYetActivatedException|UserNotYetActivatedException]] is thrown.
The user can be marked as Geoblocking whitelist (inside User Profile, GVP_USERS). In this case, the Geoblocking is not applied for this user.
==== BI ====
|ParamType=int
|ParamRequired=required
|ParamDescription=The device type code (see #DeviceTypeCodes [[DeviceType]] enumeration to know the list of device types allowed)
}}
{{Api_Parameter|
ParamName=deviceIdinstanceId|ParamType=stringint
|ParamRequired=required
|ParamDescription=Device ID that uniquely identifies The id of the instance (OB) for the devicecurrent environment. This is usually a device factory identifier. In order to login with a device as TrustedDevice, the user needs to previously register ID might vary depending on the device as trusted device (using [[UNIAPI_Specification#Registration Service|Registration Service]] methods)environment.
}}
{{Api_Parameter|
ParamName=instanceIduserName|ParamType=intString|ParamRequired=required|ParamDescription=E-mail from the user that wants to recover the password.}}{{Api_Parameter|ParamName=password|ParamType=String
|ParamRequired=required
|ParamDescription=The id of Password sets by the instance (OB) for the current environment. This ID might vary depending on the environmentcustomer in his settings.
}}
|Returns=
{
: "[[StatusCode]]": 0, : "[[Severity]]": 1,: "StatusMessage": "OK",: "Content": {:: [[Login]] Object: }
}
|Exceptions=
* [[UNIAPI_Specification#InvalidInstanceForUserException|InvalidInstanceForUserException]]* [[UNIAPI_Specification#InvalidDeviceIdException|InvalidDeviceIdException]]* [[UNIAPI_Specification#UserDeviceDisabledException|UserDeviceDisabledException]]* [[UNIAPI_Specification#UserTryingToRoamingException|UserTryingToRoamingException]]* [[UNIAPI_Specification#InvalidUserException|InvalidUserException]]* [[UNIAPI_Specification#UserNotYetActivatedException|UserNotYetActivatedException]]* [[UNIAPI_Specification#SuspendedUserException|SuspendedUserExceptionInvalidPasswordException]]* [[UNIAPI_Specification#ExcludedUserException|ExcludedUserExceptionInvalidUserNameException]]
|Cache=
This method is not cached.
