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 Upload API

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

Note#

The S3 upload link returned from this API accepts only .zip files. The .zip file that is uploaded needs to contain the Entities and Entity Relations CSV files.

BalkanID Entity RBAC Upload CSV Formats#

AppName*Entity Type*Source System*Source ID*Source Type*Metadata VersionMetadata
entity_rbac_zipninja - kazekage - aws1roleentity_rbac_zip00u46wmgwtJKFot20700rbac rolev1{"description":"Kage of Sunagakure", "integrations": ["okta/01HT3JB8RY70G42CJEVAFKYPH0"]}
entity_rbac_zipninja - raikage - aws1roleentity_rbac_zip00u5ixtfqORqYYfE0701rbac rolev1{"description":"Kage of Kumogakure", "integrations": ["okta/01HT3JB8RY70G42CJEVAFKYPH0"]}
entity_rbac_zipninja - mizukage - aws1roleentity_rbac_zip00ua2cw60j82uItfr702rbac rolev1{"description":"Kage of Kirigakure", "integrations": ["okta/01HT3JB8RY70G42CJEVAFKYPH0"]}
entity_rbac_zipninja - hokage - aws1roleentity_rbac_zip00ua2lxejvI1NXZYB703rbac rolev1{"description":"Kage of Konohagakure", "integrations": ["okta/01HT3JB8RY70G42CJEVAFKYPH0"]}
entity_rbac_zipninja - tsuchikage - aws1roleentity_rbac_zip00g4l1fpphwhKeL6C704rbac rolev1{"description":"Kage of Iwagakure", "integrations": ["okta/01HT3JB8RY70G42CJEVAFKYPH0"]}
Columns with * are required always.
Column Definitions#
Column NameColumn Description
AppApplication the Entity is associated with
NameRequired - Name of the entity
Entity TypeRequired - The type of the entity
Source SystemRequired - Source System of the entity
Source IDRequired - ID of the source system
Source TypeRequired - Type of the source system
Metadata VersionVersion of the metadata, according to the metadata schema
MetadataMetadata for the entity
"Name", "Entity Type", "Source System", "Source ID", "Source Type" and required columns. If metadata is present, metadata version has to be specified.

Sample Entity Relations CSV#

Parent Entity Integration IDParent Entity Source ID*Parent Entity Type*Entity Integration IDEntity Source ID*Entity Type*Source SystemMetadata VersionMetadata
entity_rbac_zip/01JBMHA5YPPZREF7QAGBP7078100u46wmgwtJKFot20700roleokta/01HT3JB8RY70G42CJEVAFKYPH000g4l1fpphwhKeL6C696connectionentity_rbac_zipv1{}
entity_rbac_zip/01JBMHA5YPPZREF7QAGBP7078100u5ixtfqORqYYfE0701roleokta/01HT3JB8RY70G42CJEVAFKYPH000g4l1fpphwhKeL6C696connectionentity_rbac_zipv1{}
entity_rbac_zip/01JBMHA5YPPZREF7QAGBP7078100ua2cw60j82uItfr702roleokta/01HT3JB8RY70G42CJEVAFKYPH000g4l1fpphwhKeL6C696connectionentity_rbac_zipv1{}
entity_rbac_zip/01JBMHA5YPPZREF7QAGBP7078100ua2lxejvI1NXZYB703roleokta/01HT3JB8RY70G42CJEVAFKYPH000g4l1fpphwhKeL6C696connectionentity_rbac_zipv1{}
entity_rbac_zip/01JBMHA5YPPZREF7QAGBP7078100g4l1fpphwhKeL6C704roleokta/01HT3JB8RY70G42CJEVAFKYPH000g4l30r7eVUVhS3O800employeeentity_rbac_zipv1{"ratio":0.5}
Columns with * are required always.
Column Definitions#
Column NameColumn Description
Parent Entity Integration IDIntegration ID of the parent entity
Parent Entity Source IDRequired - Source ID of the parent entity, must exist in the last synced entities
Parent Entity TypeRequired - Type of the parent entity, types: identity, connection, resource
Entity Integration IDIntegration ID of the entity
Entity Source IDRequired - Source ID of the entity, must exist in the last synced entities
Entity TypeRequired - The type of the entity, types: identity, connection, resource
Source SystemRequired - Source System of the entity
Metadata VersionVersion of the metadata, according to the metadata schema
MetadataMetadata for the entity
"Parent Entity Source ID", "Parent Entity Type", "Entity Source ID", "Entity Type" and required columns. If metadata is present, metadata version has to be specified.

Upload the ZIP file via the pre-signed URL#

After retrieving the pre-signed URL in the previous step, all that remains is to upload the ZIP file holding the Entities and Entity Relations CSV files in BalkanID Canonical CSV format to the pre-signed URL.
Below is a summary of the request using curl:
The request URL is the pre-signed URL from previous step.
The request method is PUT.
Required request body is the ZIP file containing the Entities and Entity Relations CSV files in the BalkanID Entities CSV format and BalkanID Entity Relations CSV format respectively.

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

Responses

🟢200OK
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"
}
🔴500Server Error
Previous
Bulk Entity RBAC Download API
Next
Bulk Integrations Download API (Early Access)
Built with