Create access request for multiple accounts

This method allows a developer to request access to multiple accounts. The response contains the ID of the bulk action that was performed.

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

When requesting access to 1000 accounts or more, you may experience performance issues.

URL

https://<IIS_Server_Ip>/PasswordVault/API/MyRequests/

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

Body parameters

Use one of the following methods to request access to multiple accounts:

List of requests
Filtered requests

{
  "BulkItems": [
    {
      "Operation": "Add",
      "Item": {
        "accountID": "23_3",
        "reason": "MyReason",
        "TicketingSystemName": "ServiceNow",
        "multipleAccessRequired": false,
        "fromDate": 0,
        "toDate": 0,
        "AdditionalInfo": {
          "Emergency": false,
          "RefNo": ""
        }
      }
    },
    {
      "Operation": "Add",
      "Item": {
        "accountID": "23_6",
        "reason": "nosafe",
        "TicketingSystemName": "",
        "multipleAccessRequired": false,
        "fromDate": 0,
        "toDate": 0,
        "AdditionalInfo": {
          "Emergency": false,
          "RefNo": ""
        }
      }
    }
  ]
}

Parameter	Description
accountID	The ID of the account to access. Type: String Mandatory: Yes
reason	The reason for accessing the account. Type: String Mandatory: No
TicketingSystemName	The name of the ticketing system specified in the request. Type: String Mandatory: No
multipleAccessRequired	Whether or not the request is for multiple access. Type: Boolean Mandatory: No Default value: False
fromDate	If the request is for a timeframe, the time from when the user wants to access the account, in Unix time. Type: Integer Mandatory: No
toDate	If the request is for a timeframe, the time until the user wants to access the account, in Unix time. Type: Integer Mandatory: No
AdditionalInfo	Additional information included in the request. A list of values that are predefined in the configuration. Type: List (key:value) Mandatory: No

Request filter - Example 1

{
  "BulkFilter": {
    "CommonEntityProperties": {
      "Operation": "Add",
      "Item": {
        "reason": "MyReason",
        "TicketingSystemName": "ServiceNow",
        "multipleAccessRequired": false,
        "fromDate": 0,
        "toDate": 0,
        "AdditionalInfo": {
          "Emergency": false,
          "RefNo": ""
        }
      }
    },
    "ExcludedEntities": [ "28_102", "28_103"],
    "FilterParams": {
        "AccountsFilters": 
        {
            "SavedFilter": "Favorites"
        }
    }
  }
}

Request filter - Example 2

{
  "BulkFilter": {
    "CommonEntityProperties": {
      "Operation": "Add",
      "Item": {
        "reason": "MyReason",
        "TicketingSystemName": "ServiceNow",
        "multipleAccessRequired": false,
        "fromDate": 0,
        "toDate": 0,
        "AdditionalInfo": {
          "Emergency": false,
          "RefNo": ""
        }
      }
    },
    "ExcludedEntities": [ "28_102", "28_103"],
    "FilterParams": {
        "SearchParam": {
            "Search": "MyCustomSafeName"
        }
    }
  }
}

Parameter	Description
Requests filter	A search filter to find accounts that require access requests. Type: JSON format Mandatory: No Default value: {}
reason	The reason for accessing the account. Type: String Mandatory: No
TicketingSystemName	The name of the ticketing system specified in the request. Type: String Mandatory: No
multipleAccessRequired	Whether or not the request is for multiple access. Type: Boolean Mandatory: No Default value: False
fromDate	If the request is for a timeframe, the time from when the user wants to access the account, in Unix time. Type: Integer Mandatory: No
toDate	If the request is for a timeframe, the time until the user wants to access the account, in Unix time. Type: Integer Mandatory: No
AdditionalInfo	Additional information included in the request. A list of values that are predefined in the configuration. Type: List (key:value) Mandatory: No

Result

Parameter	Description
id	The single identifier for the bulk access request. Type: number

Return codes

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

Add multiple accounts from a file in V10 Interface