Home Page
English (1.186)
VersaCloud (1.163)
VersaCloud API ′UserLoginAllow′ Reference Documentation
Description
The following table displays the documentation for the 'UserLoginAllow' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Requests login for a specific user on the VersaCloud platform (no reentrancy limitations to allow for simultaneous login from various sources) |
Español (moderno) |
Solicita inicio de sesión para un usuario específico en la plataforma VersaCloud (sin limitaciones de reentrancia para permitir login simultáneo a partir de múltiplos dispositivos) |
Português (Brasil) |
Solicita login para um usuário específico na plataforma VersaCloud (sem limitações de reentrância para permitir login simultâneo a partir de múltiplos dispositivos) |
Parameters
The following table describes all of 'UserLoginAllow''s parameters, in every language available.
ID: 1 - Name: User
Language: English (United States)
Description: E-mail address of user trying to log in
Type: email - Min-Max Length: 7-128 - Reentr Key Member: No - Optional: No
ID: 2 - Name: Password
Language: English (United States)
Description: User's password
Type: password - Min-Max Length: 8-128 - Reentr Key Member: No - Optional: No
ID: 3 - Name: Duration
Language: English (United States)
Description: Maximum time interval (in seconds) user will be allowed to stay logged in
Type: unsigned - Min-Max Length: 1-8 - Reentr Key Member: No - Optional: Yes
ID: 1 - Name: User
Language: Español (moderno)
Description: Dirección de correo electrónico de usuario registrado
Type: email - Min-Max Length: 7-128 - Reentr Key Member: No - Optional: No
ID: 2 - Name: Password
Language: Español (moderno)
Description: Contraseña de usuario registrado
Type: password - Min-Max Length: 8-128 - Reentr Key Member: No - Optional: No
ID: 3 - Name: Duration
Language: Español (moderno)
Description: Intervalo máximo de tiempo (en segundos) que será permitido al usuario mantenerse conectado
Type: unsigned - Min-Max Length: 1-8 - Reentr Key Member: No - Optional: Yes
ID: 1 - Name: User
Language: Português (Brasil)
Description: Endereço de e-mail de usuário registrado
Type: email - Min-Max Length: 7-128 - Reentr Key Member: No - Optional: No
ID: 2 - Name: Password
Language: Português (Brasil)
Description: Senha de usuário registrado
Type: password - Min-Max Length: 8-128 - Reentr Key Member: No - Optional: No
ID: 3 - Name: Duration
Language: Português (Brasil)
Description: Intervalo máximo de tempo (em segundos) que será permitido ao usuário se manter conectado
Type: unsigned - Min-Max Length: 1-8 - Reentr Key Member: No - Optional: Yes
---
Return Value
'UserLoginAllow' returns a value of type operationHandle (minimum length of returned values is 48 characters characters, while maximum length of returned values is 48 characters characters).
Please note that all APIs returning values of types that allow for localized values (like e.g. boolean or country) always return the standard type values.
Specific Error Codes
If an error happens during the execution of any VersaCloud call, an errorcode is returned instead of the standard return value described above.
The following table lists errorcodes returned specifically by the 'UserLoginAllow' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):
Errorcode |
Language |
Description |
|---|---|---|
:@Err#Usr0000002 |
English (United States) |
Value provided as user e-mail is not registered with VersaCloud |
:@Err#Usr0000003 |
English (United States) |
Values provided do not identify a VersaCloud user securely |
:@Err#Usr0000021 |
English (United States) |
Users' initial validity date has not yet been reached |
:@Err#Usr0000022 |
English (United States) |
Users' final validity date has already been surpassed |
:@Err#Usr0000002 |
Español (moderno) |
Valor informado como correo electrónico de usuario no está registrado en VersaCloud |
:@Err#Usr0000003 |
Español (moderno) |
Valores informados no identifican un usuario VersaCloud de manera segura |
:@Err#Usr0000021 |
Español (moderno) |
La fecha de validez inicial del usuario todavía no ha sido alcanzada |
:@Err#Usr0000022 |
Español (moderno) |
La fecha de validez final del usuario ya ha sido superada |
:@Err#Usr0000002 |
Português (Brasil) |
Valor informado como e-mail de usuário não está registrado em VersaCloud |
:@Err#Usr0000003 |
Português (Brasil) |
Valores informados não identificam um usuário VersaCloud de forma segura |
:@Err#Usr0000021 |
Português (Brasil) |
A data de validade inicial do usuário ainda não foi atingida |
:@Err#Usr0000022 |
Português (Brasil) |
A data de validade final do usuário já foi ultrapassada |
US Patent Requested
