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

Name

Language

Description

Type

Min-Max Length

Reentr Key Member

Optional

1

Email

English (United States)

E-mail address of user whose password is being (re)set

email

7-128

Yes

No

2

UserToken

English (United States)

User's security token

usertoken

64-64

No

No

3

Password

English (United States)

Value to be used as user's new password

password

8-128

No

No

1

Email

Español (moderno)

Dirección de correo electrónico del usuario cuya contraseña desea (re)definir

email

7-128

Yes

No

2

UserToken

Español (moderno)

Llave de seguridad del usuario

usertoken

64-64

No

No

3

Password

Español (moderno)

Valor a ser utilizado como nueva contraseña del usuario

password

8-128

No

No

1

Email

Português (Brasil)

Endereço de e-mail do usuário cuja senha deseja (re)definir

email

7-128

Yes

No

2

UserToken

Português (Brasil)

Chave de segurança do usuário

usertoken

64-64

No

No

3

Password

Português (Brasil)

Valor a ser usado como a nova senha do usuário

password

8-128

No

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