Bulk Relations Upload API (Early Access)

BalkanID Relations Upload CSV Format

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

Sample CSV

Identity ID*	Username*	Identity email	Identity name*	App ID*	App Name*	Relation type	Employee email	Employee name	Employee department	Employee job title
id/U-ysy2l6niyJmThu_Z-9urozE8tQBAEmJhjZ4nVxphg	ses-smtp-user.20220203-154927		ses-smtp-user.20220203-154927	aws/01FX103897S15JVJAR17GS3SQT	Amazon Web Services	owns	sam@example.com
id/xjyKMctjdu6l3iaJwo6OkvJ8BMtvFrmWEz4yIK5xrks	anrew.garfield		anrew.garfield	aws/01FX103897S15JVJAR17GS3SQC	Amazon Web Services
id/YPvK3hg7UfMQTz5VdEb8HraIouOCr35BQxpYlVKrYdg	michael.keaton		michael.keaton	aws/01FX103897S15JVJAR17GS3SQC	Amazon Web Services
email/0g3BUiakDZW63KtF3wajG85noCRZdlzVH9SKKVXMfT0	james@example.com	james@example.com	James S	google/01H965ZRNQHAS2B8GKJA85X75C	Google
email/0urU-a0COLlg3FIyI1pPAcmZM7d9zpmG8O2b3HAuirs	sam@example.com	sam@example.com	Sam L	google/01H965ZRNQHAS2B8GKJA85X75C	Google	is	sam@example.com	Sam L	Engineering	Staff Engineer
email/CUp7jz61_N5K2qctJNyKsSFy1pZSpDneEStYN89dImw	michael@example.com	michael@example.com	Michael K	google/01H965ZRNQHAS2B8GKJA85X75C	Google	is	michael@example.com	Micheal K	Engineering	Head of Engineering

NOTE: Columns with * are required always.

Column Definitions

Column Name	Column Description
Identity ID	Required, unique Identity ID
Username	Required, username of the identity
Identity email	Optional, Email of the Identity
Identity name	Required, Name of the identity
App ID	Required, Unique ID of the application
App Name	Required, name of the application
App Description	Optional
Relation type	Required, Type of relationship, currently support "IS", "OWNS"
Employee email	Optional, the email of the employee according to the balkanid tenant
Employee name	Optional, Name of the employee
Employee department	Optional, Department of the employee
Employee job title	Optional, Title of the employee

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 Relations CSV format.

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 Relations Upload API (Early Access)

BalkanID Relations Upload CSV Format#

Column Definitions#

Upload the CSV file via the pre-signed URL#

Request

Request samples

Responses

BalkanID Relations Upload CSV Format

Column Definitions

Upload the CSV file via the pre-signed URL