Activate user
This method activates an existing user who was suspended after entering incorrect credentials multiple times.
This method activates a suspended user. It does not activate an inactive user. |
Make sure there are no spaces in the URL. The following characters are not supported in URL values: + & % |
Select the method you want to use:
URL
|
Resource information
HTTP method |
POST |
Content type |
application/json |
Header parameter
Parameter |
Authorization (mandatory) |
Type |
String |
Description |
The token that identifies the session. |
Valid values |
A session token that was returned from the “Logon” method. |
Body parameters
Parameter |
Description |
id |
(Mandatory) The user's unique ID. Type: number |
URL
|
|
The following mandatory value is required in the URL:
Parameter |
UserName (mandatory) |
Type |
String |
Description |
The name of the user to activate. |
Default |
None |
Resource information
HTTP method |
PUT |
Content type |
application/json |
Header parameter
Parameter |
Authorization (mandatory) |
Type |
String |
Description |
The token that identifies the session. |
Valid values |
A session token that was returned from the “Logon” method. |
Body parameters
{ |
Parameter |
Suspended (optional) |
Type |
Boolean |
Description |
Whether or not the user will be activated. |
Valid values |
false |
Default |
Current value |
Result
{ |
Parameter |
FirstName |
Type |
String |
Description |
The user’s first name. |
Parameter |
LastName |
Type |
String |
Description |
The user’s last name. |
Parameter |
UserName |
Type |
String |
Description |
The name of the user. |
Parameter |
|
Type |
String |
Description |
The user’s email address. |
Parameter |
Source |
Type |
String |
Description |
Whether the user was created in the PrivateArk Client or the PVWA, or is an external user who was created from an LDAP directory. |
Valid values |
LDAP/Internal |
Parameter |
UserTypeName |
Type |
String |
Description |
The type of the user. |
Parameter |
ChangPasswordOnTheNextLogon |
Type |
Boolean |
Description |
Whether or not the user will be forced to change their password in their next logon. |
Parameter |
Expired |
Type |
Boolean |
Description |
Whether or not the user’s password has expired |
Parameter |
ExpiryDate |
Type |
DateTime |
Description |
The date when the user’s account will expire and become disabled. If the user account will never expire, ‘null’ will be returned. |
Parameter |
Disabled |
Type |
Boolean |
Description |
Whether or not the activated user is disabled. |
Parameter |
Suspended |
Type |
Boolean |
Description |
Whether or not the activated user is suspended. |
Parameter |
AgentUser |
Type |
Boolean |
Description |
Whether or not this user is a gateway user. |
Valid values |
true/false |
Parameter |
Location |
Type |
String |
Description |
The Location of the activated user in the Vault hierarchy. |
Return codes
For a complete list of return codes, see Return Codes.