Home Page
English (1.186)
VersaCloud (1.163)
VersaCloud API ′UserPasswordSetAllow′ Reference Documentation
Description
The following table displays the documentation for the 'UserPasswordSetAllow' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Requests to define a new password for a specific user |
Español (moderno) |
Solicita la definición de una nueva contraseña para un usuario específico |
Português (Brasil) |
Solicita a definição de uma nova senha para um usuário específico |
Parameters
The following table describes all of 'UserPasswordSetAllow''s parameters, in every language available.
ID: 1 - Name: Email
Language: English (United States)
Description: E-mail address of user whose password is being (re)set
Type: email - Min-Max Length: 7-128 - Reentr Key Member: Yes - Optional: No
ID: 2 - Name: UserToken
Language: English (United States)
Description: User's security token
Type: usertoken - Min-Max Length: 64-64 - Reentr Key Member: No - Optional: No
ID: 3 - Name: Password
Language: English (United States)
Description: Value to be used as user's new password
Type: password - Min-Max Length: 8-128 - Reentr Key Member: No - Optional: No
ID: 1 - Name: Email
Language: Español (moderno)
Description: Dirección de correo electrónico del usuario cuya contraseña desea (re)definir
Type: email - Min-Max Length: 7-128 - Reentr Key Member: Yes - Optional: No
ID: 2 - Name: UserToken
Language: Español (moderno)
Description: Llave de seguridad del usuario
Type: usertoken - Min-Max Length: 64-64 - Reentr Key Member: No - Optional: No
ID: 3 - Name: Password
Language: Español (moderno)
Description: Valor a ser utilizado como nueva contraseña del usuario
Type: password - Min-Max Length: 8-128 - Reentr Key Member: No - Optional: No
ID: 1 - Name: Email
Language: Português (Brasil)
Description: Endereço de e-mail do usuário cuja senha deseja (re)definir
Type: email - Min-Max Length: 7-128 - Reentr Key Member: Yes - Optional: No
ID: 2 - Name: UserToken
Language: Português (Brasil)
Description: Chave de segurança do usuário
Type: usertoken - Min-Max Length: 64-64 - Reentr Key Member: No - Optional: No
ID: 3 - Name: Password
Language: Português (Brasil)
Description: Valor a ser usado como a nova senha do usuário
Type: password - Min-Max Length: 8-128 - Reentr Key Member: No - Optional: No
---
Return Value
'UserPasswordSetAllow' 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 'UserPasswordSetAllow' 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
