Bulk Rules Upload API (Early Access)

BalkanID Rules Upload CSV Format

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

Sample CSV

ID	Name*	Label*	Enabled	Filters*	Logic*
r1	Privileged Identities	entitlement/privileged	true	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, inactive or deleted. Default is active.
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.

Upload the CSV file via the pre-signed URL

After retrieving the pre-signed URL in the previous step, all that remains
is to upload the CSV in BalkanID Rules CSV format to the pre-signed URL.

Below is a summary of the request using curl:


curl -X PUT <pre-signed url> --data-binary @./path/to/rules.csv

The request URL is the pre-signed URL from previous step.

The request method is PUT.

Required request body is the CSV in BalkanID Rules CSV
format.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

application/json

upload url response

Body

Upload URL endpoint response

url

string

required

The value is the pre-signed URL to which to upload your CSV file.

Example

{
    "url": "string"
}

Bulk Rules Upload API (Early Access)

BalkanID Rules Upload CSV Format#

Sample CSV#

Column Definitions#

Required Columns#

Upload the CSV file via the pre-signed URL#