LoginUserPasswordTEF - Revision history

Rcalvo at 18:45, 4 June 2014

2014-06-04T18:45:15Z

Rcalvo at 17:56, 4 June 2014

2014-06-04T17:56:55Z

Rcalvo at 17:53, 4 June 2014

2014-06-04T17:53:13Z

Rcalvo at 17:52, 4 June 2014

2014-06-04T17:52:36Z

Rcalvo: Created page with "{{Api_Method_Spec| Description=This method can be used by Trusted Devices to generate a token. The generated Token will carry all the information regarding the device, user, etc...."

2014-06-04T17:50:26Z

Created page with "{{Api_Method_Spec| Description=This method can be used by Trusted Devices to generate a token. The generated Token will carry all the information regarding the device, user, etc...."

New page

{{Api_Method_Spec|
Description=This method can be used by Trusted Devices to generate a token. 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>

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.

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.

TODO: link with enumeration.

==== Geo-Location ====
This method applies GeoLocation restriction. It extracts the IP address from the request and retrieves the Country of the IP from the MaxMind Database. Then, it verifies if the Country from where the request was generated is linked to the instance (GVP_INSTANCES). If not, [[UNIAPI_Specification#UserTryingToRoamingException|UserTryingToRoamingException]] exception 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 ====
This method creates an entry in GVP_LogLogin collection (even if the login was successful or not)

|Parameters=
{{Api_Parameter|
ParamName=deviceType
|ParamType=int
|ParamRequired=required
|ParamDescription=The device type code (see #DeviceTypeCodes enumeration to know the list of device types allowed)
}}
{{Api_Parameter|
ParamName=instanceId
|ParamType=int
|ParamRequired=required
|ParamDescription=The id of the instance (OB) for the current environment. This ID might vary depending on the environment.
}}
{{Api_Parameter|
ParamName=userName
|ParamType=String
|ParamRequired=required
|ParamDescription=
}}
{{Api_Parameter|
ParamName=password
|ParamType=String
|ParamRequired=required
|ParamDescription=
}}

|Returns=
Returns a JSON object containing the Login object with all user's information.

'''Example:'''

{
: [[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|SuspendedUserException]]
* [[UNIAPI_Specification#ExcludedUserException|ExcludedUserException]]

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

! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}- valign="top"

{{!}}}

|SeeAlso=
}}

@@ Line 40: / Line 40: @@
 |Exceptions=
 * [[InvalidServiceErrorException]]
 |Cache=

@@ Line 1: / Line 1: @@
 {{Api_Method_Spec|
-Description=
+Description=Get the Login object with user's data, the LoginUserPasswordTEF use the GAL system to connect the GVP with the Telefonica System. This method only can be used by Telefonica users.
 |Parameters=

@@ Line 20: / Line 20: @@
 |ParamType=String
 |ParamRequired=required
-|ParamDescription=
+|ParamDescription=E-mail from the user that wants to recover the password.
 }}
 {{Api_Parameter|
@@ Line 26: / Line 26: @@
 |ParamType=String
 |ParamRequired=required
-|ParamDescription=
+|ParamDescription=Password sets by the customer in his settings.
 }}