Change credentials immediately

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

■

Initiate CPM password management operations

URL

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

The following mandatory values are 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

{ "ChangeEntireGroup" : true }

Parameter	ChangeCredsForGroup
Type	Boolean
Description	Whether or not the CPM will change the credentials in all the accounts that belong to the same group. This parameter is only relevant for accounts that belong to an account group, and if this parameter does not belong to a group, it will be ignored. If this account is part of an account group and this value is not specified, the default value will be applied.
Valid values	true/false
Default	true

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

• Initiate CPM password management operations

URL

Make sure there are no spaces in the URL. The following characters are not supported in URL values: + & %

 

https://<IIS_Server_Ip>/PasswordVault/WebServices/PIMServices.svc/Accounts/{AccountID}/ChangeCredentials

The following mandatory value is required in the URL:

Parameter	AccountID
Type	Number
Description	The unique account ID of the account to change. This is retrieved by the Get account details web service.
Valid values	Account ID

Resource information

HTTP method	PUT
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

{    "ImmediateChangeByCPM":<Yes/No>,    "ChangeCredsForGroup":<Yes/No> }

 

Parameter	ImmediateChangeByCPM
Type	String
Description	Whether or not the account will be immediately changed by the CPM. Specify Yes to initiate a password change by the CPM.
Valid values	Yes/No
Parameter	ChangeCredsForGroup
Type	String
Description	Whether or not to change the password in all accounts that belong to the same group. This parameter is only relevant for accounts that belong to an account group. If this parameter does not belong to a group then it will be ignored.
Valid values	Yes/No
Default	Yes

Result

{ }