Bulk Integrations Download API (Early Access)

BalkanID Integrations Download CSV Format

In this section, we will explain the BalkanID Integrations CSV format.

Sample CSV

ID*	Name*	Description	Last Run	Status*	Primary Owner	Message	Metadata	Reviewer Precedence	Provisioning Options	Extraction Options	Reviewer Count
1	Amazon Web Services		2021-07-26T18:00:00Z	active	jason.bond@balkan.id	Data Available	[{"name": "Client ID", "key": "client_id", "type": "public", "value": "}, {"name": "Client Secret", "key": "client_secret", "type": "secret", "value": "}, {"name": "Enterprise ID", "key": "enterprise_id", "type": "public", "value": "}]	manager, primaryowner, riskmanager	{}		1
2	Google	Cloud computing platform		inactive			{}	manager, primaryowner, riskmanager	{}		1
3	Slack		2021-07-26T18:00:00Z	active	alec.benjamin@balkan.id	Data Available	{}	manager, primaryowner, riskmanager	{}	{ "scim": false, "upload": true, "direct_configuration": false }	1
4	Okta		2021-07-26T18:00:00Z	active		1 error occured	{}	manager, primaryowner, riskmanager	{}		1

NOTE: Columns with * are required always.

Column Definitions

Column Name	Column Description
ID	Required - A unique identifier for the integration. This is the internal balkan id of the integration
Name	Required - The name of the integration. In the sample CSV, this is: Amazon Web Services, Google, etc.
Description	Optional - The description of the integration. In the sample CSV, this is: Cloud computing platform, etc.
Last Run	Optional - The last time the integration was run. In the sample CSV, this is: 2021-07-26T18:00:00Z, etc.
Status	Required - The status of the integration. In the sample CSV, this is: active, inactive
Primary Owner	Optional - The primary owner of the integration's email. In the sample CSV, this is: alec.benjamin@balkan.id, jason.bond@balkan.id, etc.
Message	Optional - The message log for the integration sync. In the sample CSV, this is: Data Available, 1 error occured, etc.
Metadata	Optional - The metadata of the integration.
Reviewer Precedence	Optional - The reviewer precedence of the integration.
Provisioning Options	Optional - The provisioning options of the integration.
Extraction Options	Optional - The extraction options of the integration.
Reviewer Count	Optional - The reviewer count of the integration.
Entity Request Values Templates	Optional - The entity request values templates of the integration.
Entity Request Values Defaults	Optional - The entity request values defaults of the integration.

Download the CSV file via the pre-signed URL

After retrieving the pre-signed URL in the previous step, all that remains is to download the CSV in BalkanID Relations CSV format from the pre-signed URL.
To use the polling URL, first send an HTTP request with the method HEAD to the pollingUrl.
If the response status code is 404, the file is not ready, and you should retry this polling request after a delay.
If the response status code is 200, the file is ready, and you may proceed to download the CSV from the received url.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

download url response

Body

Download URL endpoint response

pollingUrl

string

required

The value is the polling URL which you will use to poll to find if the data is ready for download.

url

string

required

The value is the download URL from which you will download your CSV file.

Example

{
    "pollingUrl": "string",
    "url": "string"
}

🔴500Server Error

Bulk Integrations Download API (Early Access)

BalkanID Integrations Download CSV Format#

Sample CSV#

Column Definitions#