Home Page
English (1.167)
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 |
Name |
Language |
Description |
Type |
Min-Max Length |
Reentr Key Member |
Optional |
|---|---|---|---|---|---|---|---|
1 |
User |
English (United States) |
E-mail address of user trying to log in |
7-128 |
No |
No |
|
2 |
Password |
English (United States) |
User's password |
8-128 |
No |
No |
|
3 |
Duration |
English (United States) |
Maximum time interval (in seconds) user will be allowed to stay logged in |
1-8 |
No |
Yes |
|
1 |
User |
Español (moderno) |
Dirección de correo electrónico de usuario registrado |
7-128 |
No |
No |
|
2 |
Password |
Español (moderno) |
Contraseña de usuario registrado |
8-128 |
No |
No |
|
3 |
Duration |
Español (moderno) |
Intervalo máximo de tiempo (en segundos) que será permitido al usuario mantenerse conectado |
1-8 |
No |
Yes |
|
1 |
User |
Português (Brasil) |
Endereço de e-mail de usuário registrado |
7-128 |
No |
No |
|
2 |
Password |
Português (Brasil) |
Senha de usuário registrado |
8-128 |
No |
No |
|
3 |
Duration |
Português (Brasil) |
Intervalo máximo de tempo (em segundos) que será permitido ao usuário se manter conectado |
1-8 |
No |
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#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#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 |
US Patent Requested
