Bulk Filters Download API

BalkanID Filters Download CSV Format

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

Sample CSV

ID	Name*	Type*	Value*
f1	Engineering employees	PEOPLE	`{"department":{"_in":["Engineering"]}}`
f2	Privileged identities outside Engineering	IDENTITIES	`{"_and":[{"labels":[{"key":"entitlement/privileged","val":{"_eq":"Privileged"}}]},{"_not":{"employee":{"department":{"_in":["Engineering"]}}}}]}`

NOTE: Columns with * are required always.

Column Definitions

Column Name	Column Description
ID	Required - ID of the filter.
Name	Required - The name of the filter. It appears in the applications.
Type	Required - The type of the filter. One of: PEOPLE, IDENTITIES, APPLICATIONS, ENTITLEMENTS, PEOPLE_ENTITLEMENTS, APPLICATION_ENTITLEMENTS, IDENTITIES_ENTITLEMENTS, REVIEWS
Value	Required - The filter value in JSON format.

Required Columns

Name, Type and Value are always required.
All other columns are optional.

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 Filters 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.

API Key

Add parameter in header

X-API-KEY-ID

Example:

X-API-KEY-ID: ********************

API Key

Add parameter in header

X-API-KEY-SECRET

Example:

X-API-KEY-SECRET: ********************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Bulk Filters Download API

BalkanID Filters Download CSV Format#

Sample CSV#

Column Definitions#

Required Columns#

Download the CSV file via the pre-signed URL#