Bulk RBAC2 Upload API (Early Access)

BalkanID RBAC2 Upload 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	Status	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":"}]	active	{"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.
Status	Optional - 'active' or 'delete'. Defaults to 'active'. 'delete' removes the record.
Metadata	Optional The metadata of the role.

Required Columns

Required columns are Identity Username. All other columns are optional.

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 RBAC2 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/rbac.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 RBAC2 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 RBAC2 Upload API (Early Access)

BalkanID RBAC2 Upload CSV Format#

Sample CSV#

Column Definitions#

Required Columns#

Upload the CSV file via the pre-signed URL#