Link an account

This method enables a user to associate a linked account to an existing source account. The linked account can be a Reconcile account, Logon account, or other type of linked account that is defined in the platform configuration.

The type of linked accounts that are allowed are determined by the Platform settings. Each platform can support different types of linked accounts.

To run this service, the user must have the following Safe member authorizations:

List accounts - For both the Safe of the linked account and the Safe of the source account

Update account properties - For the Safe of the source account

URL

https://<subdomain>.privilegecloud.cyberark.cloud/PasswordVault/API/Accounts/{accountId}/LinkAccount/

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/

Resource information

HTTP method	Content type
POST	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

URL parameter

Parameter	Description
accountId	The unique ID of the account. Type: String Mandatory: Yes Default value: None

Parameter

Description

accountId

The unique ID of the account.

Type: String

Mandatory: Yes

Default value: None

Body parameters

{

"safe": "<LinkedAccount safe>",

"extraPasswordIndex": <1/2/3>,

"name": "<LinkedAccount name>",

"folder" "<LinkedAccount folder>"

}

Parameter	Description
safe	The Safe in which the linked account is stored. Type: String Mandatory: Yes Default value: None
extraPasswordIndex	The linked account's extra password index. The index can be for a Reconcile account, Logon account, or other linked account that is defined in the Platform configuration. Type: String Mandatory: Yes Default value: None
name	The linked account name. Type: String Mandatory: Yes Default value: None
folder	The folder in which the linked account is stored. Type: String Mandatory: Yes Default value: None

Result

None.

Return Codes

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