Create bulk upload of accounts

This method allows a developer to add multiple accounts to existing Safes. The response contains the ID of the bulk account upload that was performed.

 

This option is only available if you have Add accounts, Update account content, and Update account properties authorization in at least one Safe.

URL

 
https://{PVWA_SERVER}/passwordvault/api/bulkactions/accounts
 

Make sure there are no spaces in the URL.

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

Resource information

HTTP method

Content type

POST

application/json

Header parameter

Parameter

Description

Authorization

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

Type: string

Mandatory: yes

Default value: none

Body parameters

 
{
  "source":"filename.csv",
  "accountsList": [
    { 
      "uploadIndex": "1",
      "username":"JohnDoe",
      "address":"192.0.2.0",
      "platformId":"WinDomain",
      "safeName":"WinDomainSafe",
      "secret":"123456",
      "platformAccountProperties": {
      "port":"111"
      },
      "secretManagement": {
      "automaticManagementEnabled":true,
      "manualManagementReason":""
      },
      "remoteMachinesAccess": {
      "accessRestrictedToRemoteMachines": true,
      "remoteMachines": "example.com"
      },
      "groupName":"DomainGroup"
    },
    {
     "uploadIndex": "2",
     "username":"JaneDoe",
     "address":"198.51.100.0",
     "platformId":"WinDesktopLocal",
     "safeName":"WinUsersSafe",
     "secret":"123456",
     "platformAccountProperties": {
     "port":"222"
     },
     "secretManagement": {
     "automaticManagementEnabled":true,
     "manualManagementReason":""
     },
     "remoteMachinesAccess": {
     "accessRestrictedToRemoteMachines": true,
     "remoteMachines": "example.net"
     },
     "groupName":"WinGroup"
     },
  ]
}

 

Parameter

Description

source

Free text that describes the source of the bulk account upload.

Type: string

Mandatory: no

Default value: null

accountsList

The object that contains a list of account objects. Each account object contains the parameters for that account. See Account details parameters below.

Mandatory: yes

Account details parameters

Parameter

Description

uploadIndex

The numeric identifier for the account.

Type: number

Mandatory: no

Valid values: unique numbers larger than 0

username

The account user's name.

Type: string

Mandatory: no

Valid values: user name

address

The name or address of the machine where the account will be used.

Type: string

Mandatory: no

Valid values: vDNS/IP/URL where the account is managed

platformId

The platform assigned to this account.

Type: string

Mandatory: yes

Valid values: valid platform IDs; for example, WinServerLocal

safeName

The Safe where the account will be created.

Type: string

Mandatory: yes

Valid values: Safe name

secret

The password value. This will not be returned in the API output.

Type: string

Mandatory: no

Valid values: password or private SSH key

platformAccountProperties

Object containing key-value pairs to associate with the account, as defined by the account platform. These properties are validated against the mandatory and optional properties of the specified platform's definition. Optional properties that do not exist on the account will not be returned here. Internal properties are not returned.

Type: string

Mandatory: no

Valid values: example - {"Location": "IT", "OwnerName": "MSSPAdmin","Port": "113"}

secretManagement

The object that contains the parameters for managing the account's secret. See Secret management parameters below.

Mandatory: no

remoteMachinesAccess

The object that contains the parameters for accessing remote machines. See Remote machines access parameters below.

Mandatory: no

groupName

The name of the group to associate the account with.

Type: string

Mandatory: no

Valid values: domain group name

Secret management parameters

Parameter

Description

automaticManagementEnabled

Whether the account secret is automatically managed by the CPM.

Type: boolean

Mandatory: no

Default value: true

Valid values: true/false

manualManagementReason

Reason for disabling automatic secret management.

Type: string

Mandatory: no

Valid values: reason

Remote machines access parameters

Parameter

Description

accessRestrictedToRemoteMachines

Whether or not to restrict access only to specific remote machines.

Type: boolean

Mandatory: no

Default value: false

Valid values: true/false

remoteMachines

List of remote machines, separated by semicolons.

Type: string

Mandatory: no

Valid values: list of machines - example, server1.cyberark.com;server2.cyberark.com

Result

Parameter

Description

id

The single identifier for the bulk account upload.

Type: number

Return codes

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