Developer Hub
Request Demo
Request Demo
Support
  1. EntityRBAC
  • 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
        POST
      • Bulk Entity RBAC Upload API
        POST
    • 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)
      • Bulk Requests Upload API (Early Access)
    • 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. EntityRBAC

Bulk Entity RBAC Download API

POST
https://app.balkan.id/api/rest/v0/entity-rbac/download-url
EntityRBAC

BalkanID Entity RBAC Download Zip Format#

In this section, we will explain the BalkanID Entities Zip format. The zip will contain two files: rbac_entities.csv and rbac_entity_relations.csv.

Sample Zip - rbac_entities.csv#

BRNTimestampAppIntegrationNameEntity TypeSource SystemSource IDSource TypeMetadata VersionMetadata
brn:bid:balkanid:::01HWBCYJA11R3AA48K5V0DVM00:identity:04giq7jlHzhHyZ-cOvAn4Fn2dNc3bjqZrK4ufzx19Q02024-04-27 06:33:31 +0000 UTCawsAaron Ellisidentityazure63c16f61-d355-420b-87c6-615785ad8053userv1{"username":"aaron.ellis@itadminbalkan.onmicrosoft.com","lastPasswordChange":"2023-12-14 04:39:56 +0000 UTC","userCreatedDateTime":"2023-12-14 04:39:56 +0000 UTC","jobTitle":"Media Consultant","department":"Media and Pulic Relations"}
brn:bid:balkanid:::01HWBCYJA11R3AA48K5V0DVM00:identity:04giq7jlHzhHyZ-cOvAn4Fn2dNc3bjqZrK4ufzx19Q02024-04-27 06:33:31 +0000 UTCawsAaron Comptonidentityazure63c16f61-d355-420b-87c6-615785ad8053userv1{"username":"aaron.compton@adminbalkan.onmicrosoft.com","lastPasswordChange":"2023-12-14 05:01:10 +0000 UTC","userCreatedDateTime":"2023-12-14 05:01:10 +0000 UTC","jobTitle":"Accountant","department":"Finance"}
brn:bid:balkanid:::01HWBCYJA11R3AA48K5V0DVM00:identity:04giq7jlHzhHyZ-cOvAn4Fn2dNc3bjqZrK4ufzx19Q02024-04-27 06:33:31 +0000 UTCawsAabbott Reeseidentityazure63c16f61-d355-420b-87c6-615785ad8053userv1{"username":"aabbott.reese@balkanit.onmicrosoft.com","lastPasswordChange":"2023-12-14 04:42:12 +0000 UTC","userCreatedDateTime":"2023-12-14 04:42:12 +0000 UTC","jobTitle":"Software Engineer","department":"Engineering"}
brn:bid:balkanid:::01HWBCYJA11R3AA48K5V0DVM00:identity:04giq7jlHzhHyZ-cOvAn4Fn2dNc3bjqZrK4ufzx19Q02024-04-27 06:33:31 +0000 UTCawsAaron Alvaradoidentityazure63c16f61-d355-420b-87c6-615785ad8053userv1{"username":"aaron.alvarado@itadminbalkan.onmicrosoft.com","lastPasswordChange":"2023-12-14 05:02:01 +0000 UTC","userCreatedDateTime":"2023-12-14 05:02:01 +0000 UTC","jobTitle":"Analyst","department":"Operations"}
RBAC Entities Column Definitions#
Column NameColumn Description
BRNBalkan Resource Name
TimestampTimestamp of the entity
AppApplication the Entity is associated with
IntegrationIntegration ID the entity is assoicated with
NameName of the entity
Entity TypeThe type of the entity
Source SystemSource System of the entity
Source IDID of the source system
Source TypeType of the source system
Metadata VersionVersion of the metadata, according to the metadata schema
MetadataMetadata for the entity

Sample Zip - rbac_entity_relations.csv#

AppTimestampIntegrationParent Entity BRNEntity BRNEntity TypeSource System>Metadata VersionMetadata
okta2024-06-13 06:17:04 +0000 UTCokta/01J07X778EK4BH2M2A1VY4HCYFbrn:bid:balkanid:::01J06J6V8JT92BP4RGFDTG5G97:identity:pww8lnoprwDRmRLIOjC9zUbvOmfn5HholuclUQe5QNUbrn:bid:balkanid:::01J06J6V8JT92BP4RGFDTG5G97:connection:-HebVJVI8ca3kmd0FMm9t5hXMmsv4Ygc54hW2u7KQdgconnectionoktav1{"connectionType":"group","privilegeName":"member","privilegeValue":true,"project":"https://your-org.okta.com"}
okta2024-06-13 06:17:04 +0000 UTCokta/01J07X778EK4BH2M2A1VY4HCYFbrn:bid:balkanid:::01J06J6V8JT92BP4RGFDTG5G97:identity:G2byRnP_n1pDW7xjogBKF6Y1JF4c57xdFdKfbmVVsOUbrn:bid:balkanid:::01J06J6V8JT92BP4RGFDTG5G97:connection:w32pXdsNUfaXli5UF8dkDd2VX2re6yQNS_D3uw-Qqa8connectionoktav1{"connectionType":"group","privilegeName":"member","privilegeValue":true,"project":"https://your-org.okta.com"}
okta2024-06-13 06:17:04 +0000 UTCokta/01J07X778EK4BH2M2A1VY4HCYFbrn:bid:balkanid:::01J06J6V8JT92BP4RGFDTG5G97:identity:Ys9cdJadCykeoVYD9wyObNhGMRBiTyz2UZtFl4OHCfobrn:bid:balkanid:::01J06J6V8JT92BP4RGFDTG5G97:connection:w32pXdsNUfaXli5UF8dkDd2VX2re6yQNS_D3uw-Qqa8connectionoktav1{"connectionType":"group","privilegeName":"member","privilegeValue":true,"project":"https://your-org.okta.com"}
okta2024-06-13 06:17:04 +0000 UTCokta/01J07X778EK4BH2M2A1VY4HCYFbrn:bid:balkanid:::01J06J6V8JT92BP4RGFDTG5G97:identity:DIcLfBZzPVSrxySOaqSyIFEaC3gTIgUf6gN7Dcq5mdwbrn:bid:balkanid:::01J06J6V8JT92BP4RGFDTG5G97:connection:w32pXdsNUfaXli5UF8dkDd2VX2re6yQNS_D3uw-Qqa8connectionoktav1{"connectionType":"group","privilegeName":"member","privilegeValue":true,"project":"https://your-org.okta.com"}
RBAC Entity Relations Column Definitions#
Column NameColumn Description
TimestampTimestamp of the entity relation
AppApplication the Entity Relation is associated with
IntegrationIntegration ID the entity is assoicated with
Parent Entity BRNBRN of the parent entity, must exist in the last synced entities
Entity BRNBRN of the entity, must exist in the last synced entities
Entity TypeThe type of the entity, types: identity, connection, resource
Source SystemSource System of the entity
Metadata VersionVersion of the metadata, according to the metadata schema
MetadataMetadata for the entity

Download the zip file via the pre-signed URL#

After retrieving the pre-signed URL in the previous step, all that remains is to download the zip 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

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/entity-rbac/download-url' \
--header 'X-Api-Key-ID;' \
--header 'X-Api-Key-Secret;' \
--header 'Content-Type: application/json'

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
Previous
Bulk Entity Relations Upload API (Early Access)
Next
Bulk Entity RBAC Upload API
Built with