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

Bulk Entities Upload API (Early Access)

POST
https://app.balkan.id/api/rest/v0/entities/upload-url
Entities

BalkanID Entities Upload CSV Format#

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

Sample CSV#

AppName*Entity Type*Source System*Source ID*Source Type*Metadata VersionMetadata
azureAabbott 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"}
azureAaron 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"}
azureAaron Castroidentityazure63c16f61-d355-420b-87c6-615785ad8053userv1{"username":"aaron.castro@itadminbalkan.onmicrosoft.com","lastPasswordChange":"2023-12-14 04:55:00 +0000 UTC","userCreatedDateTime":"2023-12-14 04:55:00 +0000 UTC","jobTitle":"Analyst","department":"Operations"}
azureAaron Chenidentityazure63c16f61-d355-420b-87c6-615785ad8053userv1{"username":"aaron.chen@itadminbalkan.onmicrosoft.com","lastPasswordChange":"2023-12-14 04:50:34 +0000 UTC","userCreatedDateTime":"2023-12-14 04:50:34 +0000 UTC","jobTitle":"Engineer","department":"Product Administration"}
azureAaron Clayidentityazure63c16f61-d355-420b-87c6-615785ad8053userv1{"username":"aaron.clay@balkanit.onmicrosoft.com","lastPasswordChange":"2023-12-14 04:58:58 +0000 UTC","userCreatedDateTime":"2023-12-14 04:58:58 +0000 UTC","jobTitle":"SVP Legal","department":"Legal"}
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.

Upload the CSV file via the pre-signed URL#

After retrieving the pre-signed URL in the previous step, all that remains is to upload the CSV 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 CSV in BalkanID Entities CSV format.

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
integrationID
string 
required
The integration ID to which the entities belong to.
Example
{
    "integrationID": "string"
}

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/entities/upload-url' \
--header 'X-Api-Key-ID;' \
--header 'X-Api-Key-Secret;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "integrationID": "string"
}'

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
Modified at 2025-04-10 03:44:22
Previous
Bulk Entities Download API (Early Access)
Next
Bulk Entity Insights Download API (Early Access)
Built with