Bulk RBAC Download API (Early Access)

BalkanID RBAC Download CSV Format

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

Sample CSV

ID	Name	Value	Integration ID	Role	Employees	Created At	Updated At	Department	Job Title
01H90W5FM2RY663D6AFNG9HEJ9	developer	[ {department: engineering, job-title: engineer, ratio: 0.90 } ]	google/01H90W5FM2RY663D6AFNG9HEJ9	[policy/APIGatewayServiceRolePolicy, group/blkn-ue2-dev-pipeline-cluster-k8s-developer]	abc@balkan.id	2023-12-03T09:00:00+05:30	2023-12-04T18:00:00+05:30	Engineering	Intern

NOTE: Columns with * are required always.

Column Definitions

Column Name	Column Description
ID	The ID of the role.
Name	The name of the role.
Value	The value of the role.
Integration ID	The integration ID of the role.
Role	List of connections of the role.
Employees	List of employees having the role.
Created At	The date and time when the role was created.
Updated At	The date and time when the role was last updated.
Department	The department of the employee.
Job Title	The job title of the employee.

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

BalkanID RBAC Download CSV Format#

Sample CSV#

Column Definitions#