Change credentials, set next password

This method enables users to set the account's credentials to use for the next CPM change.

The user who runs this web service requires the following permissions in the Safe where the privileged account is stored:

  • Initiate CPM password management operations

  • Specify next password value

URL

  • Make sure there are no spaces in the URL.

  • The following characters are not supported in URL values: + & %

  • If the URL includes a dot (.), add a forward slash (/) at the end of the URL. For example: api/Safes/MySafe/Members/user@cyber.com/

 

 

 
https://<IIS_Server_Ip>/PasswordVault/API/Accounts/<AccountID>/SetNextPassword/

The following mandatory value is required in the URL:

Parameter

AccountID

Type

String

Description

The unique ID of the account.

Valid values

Account ID

Resource information

HTTP method

POST

Content type

application/json

Header parameter

Parameter

Description

Authorization

The token that identifies the session, encoded in BASE 64. See Authentication.

Type: String

Mandatory: Yes

Default value: None

Body parameters

  
{

"ChangeImmediately" : true,

"NewCredentials": "<credentials>"

}

 

Parameter

ChangeImmediately

Type

String

Description

Whether or not the password will be changed immediately in the Vault.

Valid values

-

Default

-

Parameter

NewCredentials (mandatory)

Type

String

Description

The new account credentials that will be allocated to the account in the Vault.

 
  • Digits are never placed as the first or last character of the password, regardless of the password policy or specifications.
  • If the specified password contains leading and/or trailing white spaces, they will automatically be removed.

Valid values

-

Default

-

Return codes

For a complete list of return codes, see Return Codes.