Bulk RBAC2 Download API (Early Access)

BalkanID RBAC2 Download CSV Format

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

Sample CSV

ID	Name	Value	Integration	Employee Email	Identity Username*	Connection	Connection Type	Resource	Resource Type	Privilege Name	Privilege Value	Label	Metadata
01H90W5FM2RY663D6AFNG9HEJ9	developer	[ {department: engineering, job-title: engineer, ratio: 0.90 } ]	google/01H90W5FM2RY663D6AFNG9HEJ9		adam.williams@balkan.id	Datadog Admin Role	Role					[{ "key": "entitlement/outlier", "value": { "text": "outlier", "version":", "type":"Unique Connection(s) or No role or No connection or Below threshold", "explanation":"balkanid generated explanation."}, "created_at":datetime bigint, "updated_at":datetime bigint, "source":"}]	{"summary":"This is a summary"}

NOTE: Columns with * are required always.

Column Definitions

Column Name	Column Description
ID	Optional The ID of the role.
Name	Optional The name of the role.
Value	Optional The value of the role.
Integration	Optional The integration BRN of the role.
Employee Email	Optional The email of the employee.
Identity Username	Required The username of the employee.
Connection	Optional The connection of the role.
Connection Type	Optional The connection type of the role.
Resource	Optional The resource of the role.
Resource Type	Optional The resource type of the role.
Privilege Name	Optional The privilege name of the role.
Privilege Value	Optional The privilege value of the role.
Label	Optional The label of the role.
Metadata	Optional The metadata of the role.

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 RBAC2 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 RBAC2 Download API (Early Access)

BalkanID RBAC2 Download CSV Format#

Sample CSV#

Column Definitions#