Developer Hub
Request Demo
Request Demo
Support
  1. Requests
  • Getting Started
    • Introduction
  • API Reference
    • Admins
      • Bulk Admins Download API (Early Access)
    • Apps
      • Bulk Apps Download API (Early Access)
    • Business Owners
      • Bulk Business Owners Download API (Early Access)
      • Bulk Business Owners Upload API (Early Access)
    • Campaigns
      • Bulk Campaigns Download API (Early Access)
      • Bulk Campaigns Upload API (Early Access)
    • Configuration
      • Bulk Applied Labels Upload API (Early Access)
      • Bulk Entity Finding Rules Download API (Early Access)
      • Bulk Custom Insights (Entity Rules) Download API (Early Access)
      • Bulk Filters Download API (Early Access)
      • Bulk Filters Upload API (Early Access)
      • Bulk Findings Download API (Early Access)
      • Bulk Findings Upload API (Early Access)
      • Bulk Labels Download API (Early Access)
      • Bulk Labels Upload API (Early Access)
      • Bulk Privileged Download API (Early Access)
      • Bulk Privileged Upload API (Early Access)
      • Bulk RBAC Download API (Early Access)
      • Bulk RBAC Upload API (Early Access)
      • Bulk RBAC2 Download API (Early Access)
      • Bulk RBAC2 Upload API (Early Access)
      • Bulk Rules Download API (Early Access)
      • Bulk Rules Upload API (Early Access)
    • Employees
      • Bulk Employees Download API (Early Access)
      • Bulk Employees Upload API (Early Access)
    • Entitlements
      • Bulk Entitlements Download API (Early Access)
      • Bulk Entitlements Upload API (Early Access)
    • Entities
      • Bulk Entities Download API (Early Access)
      • Bulk Entities Upload API (Early Access)
    • EntityInsights
      • Bulk Entity Insights Download API (Early Access)
      • Bulk Entity Insights Upload API (Early Access)
    • EntityRelations
      • Bulk Entity Relations Download API (Early Access)
      • Bulk Entity Relations Upload API (Early Access)
    • EntityRBAC
      • Bulk Entity RBAC Download API
      • Bulk Entity RBAC Upload API
    • Integrations
      • Bulk Integrations Download API (Early Access)
      • Bulk Integrations Upload API (Early Access)
    • Purposes
      • Bulk Purposes Download API (Early Access)
      • Bulk Purposes Upload API (Early Access)
    • Relations
      • Bulk Relations Download API (Early Access)
      • Bulk Relations Upload API (Early Access)
    • Requests
      • Bulk Requests Download API (Early Access)
        POST
      • Bulk Requests Upload API (Early Access)
        POST
    • Reviews
      • Bulk Reviews Download API (Early Access)
      • Bulk Reviews Upload API (Early Access)
    • Playbooks
      • Bulk Playbook Templates Download API (Early Access)
      • Bulk Playbook Templates API (Early Access)
    • Webhooks
      • Bulk Webhook Templates Download API (Early Access)
      • Bulk Webhook Templates API (Early Access)
  • Playbooks
    • Overview
  1. Requests

Bulk Requests Download API (Early Access)

POST
https://app.balkan.id/api/rest/v0/requests/download-url
Requests

BalkanID Access Requests Download CSV Format#

In this section, we will explain the BalkanID Access Requests CSV format.
Sample CSV
Request ID*Requester*Username*Work Email*ReferenceDurationExpiration DateProvision DateSourceSource IDRequest TypeApp IDConnectionConnection TypeResourceResource TypePrivilege NamePrivilege ValueType*Metadata*Scheduled DateEntity Review IDPurpose IDPurpose Review ID
01H9VNFTZD1T44TCSKGEBWNTZDayden@email.comaydenjames@email.comsam@email.com2023-09-22 18:30:00grantgithub/01H965ZRNQHAS2B8GKJA85X75DCore Engineeringteamemployee_request"{"integration_to_scim_payload":{"aws/214195":{"username":"},"github/28329":{},"google/241523":{"firstName":","lastName":","password":","username":"}},"reason":"Need to perform current job duties","reference_department":null,"reference_employee":"sam@email.com","reference_title":null,"reference_type":"employee"}"
01H9VNFTZD1T44TCSKGEBWNTZDayden@email.comaydenjames@email.comsam@email.com2023-09-22 18:30:00grantgithub/01H965ZRNQHAS2B8GKJA85X75Dengineering-allteamemployee_request"{"integration_to_scim_payload":{"aws/214195":{"username":"},"github/28329":{},"google/241523":{"firstName":","lastName":","password":","username":"}},"reason":"Need to perform current job duties","reference_department":null,"reference_employee":"sam@email.com","reference_title":null,"reference_type":"employee"}"
01H9VNFTZD1T44TCSKGEBWNTZDayden@email.comaydenjames@email.comsam@email.com2023-09-22 18:30:00grantgithub/01H965ZRNQHAS2B8GKJA85X75DTest teamteamemployee_request"{"integration_to_scim_payload":{"aws/214195":{"username":"},"github/28329":{},"google/241523":{"firstName":","lastName":","password":","username":"}},"reason":"Need to perform current job duties","reference_department":null,"reference_employee":"sam@email.com","reference_title":null,"reference_type":"employee"}"
01H9TT26TBD20AW5NGB3X5MFTPayden@email.comaydenjames@email.comgrantaws/01GG223987S15JVJAR17GS3SQTcustomersgroupemployee_request"{"integration_to_scim_payload":{"aws/214195":{"username":"},"github/28329":{},"google/241523":{"firstName":","lastName":","password":","username":"}},"reason":"Need to perform current job duties","reference_department":null,"reference_employee":"sam@email.com","reference_title":null,"reference_type":"employee"}"
01H9TT26TBD20AW5NGB3X5MFTPayden@email.comaydenjames@email.comrevokeaws/01GG223987S15JVJAR17GS3SQTsupportgroupemployee_request"{"integration_to_scim_payload":{"aws/214195":{"username":"},"github/28329":{},"google/241523":{"firstName":","lastName":","password":","username":"}},"reason":"Need to perform current job duties","reference_department":null,"reference_employee":"sam@email.com","reference_title":null,"reference_type":"employee"}"
01H9T8PDBF8MZ9WTFYG2622Q91sam@email.comsamayden@email.comjames@email.com68m0srevokegoogleemployee_request"{"integration_to_scim_payload":{"aws/214195":{"username":"},"github/28329":{},"google/241523":{"firstName":","lastName":","password":","username":"}},"reason":"Need to perform current job duties","reference_department":null,"reference_employee":"sam@email.com","reference_title":null,"reference_type":"employee"}"
01H9TTPDBF8MZ9WTFYG2322H91sam@email.comsamjames@email.comayden@email.com45m0sgrantgoogleemployee_request"{"integration_to_scim_payload":{"aws/214195":{"username":"},"github/28329":{},"google/241523":{"firstName":","lastName":","password":","username":"}},"reason":"Need to perform current job duties","reference_department":null,"reference_employee":"sam@email.com","reference_title":null,"reference_type":"employee"}"
NOTE: Columns with * are required always.
Column Definitions#
Column NameColumn Description
Request IDRequired - This is a unique request ID for each request generated by the BalkanID processing engine and serves as an identifier.
RequesterRequired - Email of the request originator.
UsernameRequired - Full name of the request originator.
Work EmailRequired - Email of the employee the access is requested for, if other than the requester.
ReferenceOptional, Reference entitlements: contains employee email.
DurationOptional, How long is the access needed (in seconds, minutes, hours, etc). Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”. If one needs it for 1 hour, then it will be 1h or 60m.
Expiration DateOptional, Expiration Date of the access request.
Provision DateOptional, Provision Date of the access request.
SourceOptional, Source system.
Source IDOptional, Source system ID.
Request TypeRequired - Contains whether the request is for "grant" (provisioning) or "revoke" (deprovisioning) of a resource.
App IDRequired - App the access is requested for.
ConnectionOptional, Required if Connection Type is present - Name of the connection the access is requested for.
Connection TypeOptional, Required if Connection is present - Type of connection the access is requested for.
ResourceOptional, Required if Resource Type is present - Name of the resource the access is requested for.
Resource TypeOptional, Required if Resource is present - Type of the resource the access is requested for.
Privilege NameOptional, Required if Privilege Value is present - Alphanumeric name of the privilege, also referred to as fine-grained permissions in some applications.
Privilege ValueOptional, Required if Privilege Name is present - Alphanumeric with the extracted permission, either "true" or "false".
TypeRequired - Action type of the request
MetadataRequired - Metadata of the request
Scheduled DateOptional, Scheduled Date of the access request.
Entity Review IDOptional, Entity Review ID of the access request.
Purpose IDOptional, Purpose ID of the access request.
Purpose Review IDOptional, Purpose Review of the access request.

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 Access Requests 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

Header Params
X-Api-Key-ID
string 
optional
X-Api-Key-Secret
string 
optional
Content-Type
string 
optional
Default:
application/json
Body Params application/json
includeCompleted
boolean 
required
Include completed requests in the download.
Example
{
    "includeCompleted": true
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://app.balkan.id/api/rest/v0/requests/download-url' \
--header 'X-Api-Key-ID;' \
--header 'X-Api-Key-Secret;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "includeCompleted": true
}'

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
Modified at 2025-04-10 03:44:22
Previous
Bulk Relations Upload API (Early Access)
Next
Bulk Requests Upload API (Early Access)
Built with