Bulk Entity Relations Upload API (Early Access)

BalkanID Entity Relations Upload CSV Format

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

Sample CSV

App	Parent Entity Source ID*	Parent Entity Type*	Entity Source ID*	Entity Type*	Source System	Metadata Version	Metadata
okta	00u46wmgwtJKFot20696	identity	00g4l1fpphwhKeL6C696	connection	okta	v1	{"project":"https://your-org.okta.com","privilegeName":"member","privilegeValue":true,"connectionType":"group"}
okta	00u5ixtfqORqYYfE0696	identity	00g4l1fpphwhKeL6C696	connection	okta	v1	{"project":"https://your-org.okta.com","privilegeName":"member","privilegeValue":true,"connectionType":"group"}
okta	00ua2cw60j82uItfr697	identity	00g4l1fpphwhKeL6C696	connection	okta	v1	{"project":"https://your-org.okta.com","privilegeName":"member","privilegeValue":true,"connectionType":"group"}
okta	00ua2lxejvI1NXZYB697	identity	00g4l1fpphwhKeL6C696	connection	okta	v1	{"project":"https://your-org.okta.com","privilegeName":"member","privilegeValue":true,"connectionType":"group"}
okta	00g4l1fpphwhKeL6C696	identity	00g4ls2o1l9NQ4uEG696	connection	okta	v1	{"project":"https://your-org.okta.com","privilegeName":"member","privilegeValue":true,"connectionType":"group"}
okta	00g4l1fpphwhKeL6C696	identity	00g4l30r7eVUVhS3O696	connection	okta	v1	{"project":"https://your-org.okta.com","privilegeName":"member","privilegeValue":true,"connectionType":"group"}

Columns with * are required always.

Column Definitions

Column Name	Column Description
App	Application the Entity is associated with
Parent Entity Source ID	Required - Source ID of the parent entity, must exist in the last synced entities
Parent Entity Type	Required - Type of the parent entity, types: identity, connection, resource
Entity Source ID	Required - Source ID of the entity, must exist in the last synced entities
Entity Type	Required - The type of the entity, types: identity, connection, resource
Source System	Required - Source System of the entity
Metadata Version	Version of the metadata, according to the metadata schema
Metadata	Metadata 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 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 Entity Relations 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 entity relations belong to.

Example

{
    "integrationID": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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"
}

Bulk Entity Relations Upload API (Early Access)

BalkanID Entity Relations Upload CSV Format#

Sample CSV#

Column Definitions#

Upload the CSV file via the pre-signed URL#

Request

Request samples

Responses

BalkanID Entity Relations Upload CSV Format

Sample CSV

Column Definitions

Upload the CSV file via the pre-signed URL