Bulk Purposes Download API (Early Access)

BalkanID Purposes Download CSV Format

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

Sample CSV

BRN*	Purpose Name*	Description*	Pre-Expiry Notification	Department	Job Title	Team	Owner	Birthright	Entity BRNs
brn:bid:balkanid:::01HWBCYJA11R3AA48K5V0DVM00:purpose:01JH1JR91K9N91Z04PHK2201WR	Kubernetes Development	Purpose which is meant for Kubernetes Development	168h	Software Development	Software Development Engineer	Software	aali@example.com	Department Birthright	brn:bid:balkanid:::01HWBCYJA11R3AA48K5V0DVM00:identity:04giq7jlHzhHyZ-cOvAn4Fn2dNc3bjqZrK4ufzx19Q0, brn:bid:balkanid:::01HWBCYJA11R3AA48K5V0DVM00:identity:04giq7jlHzhHyZ-cOvAn4Fn2dNc3bjqZrK4ufzx19Q1
brn:bid:balkanid:::01HWBCYJA11R3AA48K5V0DVM00:purpose:01JH1JR91K9N91Z04PHK2201WP	Infrastructure DevOps	Purpose which is meant for Infrastucture DevOps	168h	DevOps	DevOps Engineer	DevOps	mgomez@example.com	Department Birthright	brn:bid:balkanid:::01HWBCYJA11R3AA48K5V0DVM00:identity:04giq7jlHzhHyZ-cOvAn4Fn2dNc3bjqZrK4ufzx19Q2, brn:bid:balkanid:::01HWBCYJA11R3AA48K5V0DVM00:identity:04giq7jlHzhHyZ-cOvAn4Fn2dNc3bjqZrK4ufzx19Q3
brn:bid:balkanid:::01HWBCYJA11R3AA48K5V0DVM00:purpose:01JH1JR91K9N91Z04PHK2201WQ	Production Oncall	Purpose which is meant for Production Oncall	2h	Customer Support	Customer Support	Customer Support	xliu@example.com	Team Birthright	brn:bid:balkanid:::01HWBCYJA11R3AA48K5V0DVM00:identity:04giq7jlHzhHyZ-cOvAn4Fn2dNc3bjqZrK4ufzx19Q4
brn:bid:balkanid:::01HWBCYJA11R3AA48K5V0DVM00:purpose:01JH1JR91K9N91Z04PHK2201WS	Local Stack Development	Purpose which is meant for Local Stack Development	48h	Software Development	Software Development Engineer	Software	fasaud@example.com	Organization Birthright	brn:bid:balkanid:::01HWBCYJA11R3AA48K5V0DVM00:identity:04giq7jlHzhHyZ-cOvAn4Fn2dNc3bjqZrK4ufzx19Q0

Columns with * are required always.

Column Definitions

Column Name	Column Description
BRN	Required - Balkan Resource Name
Purpose Name	Required - Name of the purpose
Description	Required - Description of the purpose
Pre-Expiry Notification	Time duration before expiry of purpose request at which a notification is sent out
Department	Department associated to the purpose
Job Title	Job Title associated to the purpose
Team	Team associated to the purpose
Owner	Owner of the entity
Birthright	Birthright that the purpose represents
Entity BRNs	Comma separated list of Entity BRNs that are granted access to when starting a purpose

"BRN", "Purpose Name" and "Description" are required columns.
The only valid values for "Pre-Expiry Notification" are '', '2h', '4h', '24h', '48h', '168h'.

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

BalkanID Purposes Download CSV Format#

Sample CSV#

Column Definitions#