Bulk Rules Download API (Early Access)

BalkanID Rules Download CSV Format

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

Sample CSV

ID	Name*	Label*	Status	Filters*	Logic*
r1	Privileged Identities	entitlement/privileged	active	f1, f2	OR

NOTE: Columns with * are required always.

Column Definitions

Column Name	Column Description
ID	Optional - ID of the rule.
Name	Required - The name of the rule. It appears in the applications.
Label	Required - The code of the label to be applied. Label needs to be configured before.
Status	Optional - If the rule is active or inactive.
Filters	Required - The list of filter IDs to evaluate for the rule. Filters need to be configured before.
Logic	Required - The logic to use when applying the filters. OR results in union, AND results in intersection.

Required Columns

Name, Label, Filters and Logic 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 Rules 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 Rules Download API (Early Access)

BalkanID Rules Download CSV Format#

Sample CSV#

Column Definitions#

Required Columns#

Download the CSV file via the pre-signed URL#