Bulk Filters Upload API (Early Access)

BalkanID Filters Upload CSV Format

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

Sample CSV

ID	Name*	Type*	Value*	Status*
f1	Engineering employees	PEOPLE	`{"department":{"_in":["Engineering"]}}`	deleted
f2	Privileged identities outside Engineering	IDENTITIES	`{"_and":[{"labels":[{"key":"entitlement/privileged","val":{"_eq":"Privileged"}}]},{"_not":{"employee":{"department":{"_in":["Engineering"]}}}}]}`

NOTE: Columns with * are required always.

Column Definitions

Column Name	Column Description
ID	Optional - ID of the filter if already exists. It should be used to update.
Name	Required - The name of the filter. It appears in the applications.
Type	Required - The type of the filter. One of: CAMPAIGN, ENTITLEMENTS, REVIEWS, EMPLOYEES, IDENTITIES, INTEGRATIONS, PEOPLE, IDENTITIES_ENTITLEMENTS, RBAC_BALKAN_ROLE_ENTITLEMENTS, INTEGRATION_ENTITLEMENTS, RESOURCE_ENTITLEMENTS, PEOPLE_ENTITLEMENTS, RBAC_BALKAN_ROLE_IDENTITIES, INTEGRATION_IDENTITIES, RESOURCE_IDENTITIES, RBAC_BALKAN_ROLE_CONNECTIONS, INTEGRATION_CONNECTIONS, CONNECTIONS, INTEGRATION_RESOURCES, RESOURCES, RBAC_BALKAN_ROLE_RESOURCES, RBAC_USERS, RBAC_CONNECTIONS, CONNECTION_IDENTITIES, CONNECTION_ENTITLEMENTS, MANAGER_PEOPLE, RBAC_OUTLIERS, RBAC_BALKAN_ROLES, RBAC_ROLE_USAGE, PEOPLE_IDENTITIES, PRIVILEGED_ENTITLEMENTS, APPLICATIONS, APPLICATION_ENTITLEMENTS
Value	Required - The filter value in JSON format.
Status	Optional - The status of the filter. One of deleted or empty string.

Required Columns

Name, Type and Value are always required.
All other columns are optional.

Filter Value Format

The filter value is a nested JSON object with logical operators which can be used to build complex filters.

At base layer, there are two options -

Type	Operator	Description
Included	_and	All of the conditions must be true
Excluded	_not	All of the conditions must be false

Inside each of these layer, we have multiple filter conditions. Each filter condition is a JSON object with the following structure:

{
    <field>: {
        <operator>: <value>
    }
}

Here,
Field - is the field name of the filter condition. Refer to filter fields for the list of supported fields.
Operator - is the operator to be used for the filter condition. It is usually either _in or _eq.
Value - is the value to be used for the filter condition. It can be a string(incase of _eq) or an array of strings(incase of _in).

The only exception to this, is if the filter field is labels. In this case, the filter condition is a JSON object with the following structure:

{
    "labels": [
        {
            "key": <key>,
            "val": {
                <operator>: <value>
            }
        }
    ]
}

Here,
Key - is the ID of the label.
Operator - is the operator to be used for the filter condition. It is usually _eq.
Value - is the name of the label.

Filter Fields

Different filter types support different fields. Below is the list of supported fields for each filter type:

PEOPLE FILTER

Field	Description
ID	ID of the employee
labels	List of labels associated with the employee
manager	Manager of the employee
title	Job title of the employee
department	Department of the employee
employmentType	Employment type of the employee

IDENTITIES FILTER

Field	Description
brn	BRN of the identity
identity_type	Type of the identity
ID	ID of the identity
labels	List of labels associated with the identity
employee	Employee associated with the identity, has subfields same as PEOPLE FILTER
integration	Integration associated with the identity
entitlement	Entitlement associated with the identity, has subfields same as ENTITLEMENTS FILTER
labels	List of labels associated with the identity

APPLICATIONS FILTER

Field	Description
ID	ID of the application
app	Name of the application

ENTITLEMENTS FILTER

Field	Description
employee	Employee associated with the entitlement, has subfields same as PEOPLE FILTER
identity_type	Type of the identity
handle	Handle of the entitlement
labels	List of labels associated with the entitlement
app	Application of the entitlement
integration	Integration of the entitlement
permission	Permission of the entitlement
permission value	Value of the permission
role	Role of the entitlement
connection_type	Connection type of the entitlement
resource	Resource of the entitlement
resource_type	Resource type of the entitlement
source	Source of the entitlement upload
project	Project of the entitlement

APPLICATION_ENTITLEMENTS FILTER

Field	Description
brn	BRN of the identity
identity_type	Type of the identity
permission	Permission of the entitlement
permission value	Value of the permission
role	Role of the entitlement
connection_type	Connection type of the entitlement
resource	Resource of the entitlement
resource_type	Resource type of the entitlement
labels	List of labels associated with the entitlement

PEOPLE_ENTITLEMENTS FILTER

Field	Description
integration	Integration of the entitlement
app	Application of the entitlement
brn	BRN of the identity
permission	Permission of the entitlement
permission value	Value of the permission
role	Role of the entitlement
connection_type	Connection type of the entitlement
resource	Resource of the entitlement
resource_type	Resource type of the entitlement
labels	List of labels associated with the entitlement

IDENTITIES_ENTITLEMENTS FILTER

Field	Description
role	Role of the entitlement
permission	Permission of the entitlement
permission value	Value of the permission
connection_type	Connection type of the entitlement
resource	Resource of the entitlement
resource_type	Resource type of the entitlement
labels	List of labels associated with the entitlement

REVIEWS FILTER

Field	Description
employee	Employee associated with the review, has subfields same as PEOPLE FILTER
handle	Handle of the review
idenetity_type	Type of the identity
workflow	Workflow of the review
status	Status of the review
role	Role of the entitlement
permission	Permission of the entitlement
permission value	Value of the permission
connection_type	Connection type of the entitlement
labels	List of labels associated with the entitlement
app	Application of the entitlement
integration	Integration of the entitlement

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

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

BalkanID Filters Upload CSV Format

Sample CSV

Column Definitions

Required Columns

Filter Value Format

Filter Fields

PEOPLE FILTER

IDENTITIES FILTER

APPLICATIONS FILTER

ENTITLEMENTS FILTER

APPLICATION_ENTITLEMENTS FILTER

PEOPLE_ENTITLEMENTS FILTER

IDENTITIES_ENTITLEMENTS FILTER

REVIEWS FILTER

Upload the CSV file via the pre-signed URL

Request

Request samples

Responses

Bulk Filters Upload API (Early Access)

BalkanID Filters Upload CSV Format#

Sample CSV#

Column Definitions#

Required Columns#

Filter Value Format#

Filter Fields#

PEOPLE FILTER#

IDENTITIES FILTER#

APPLICATIONS FILTER#

ENTITLEMENTS FILTER#

APPLICATION_ENTITLEMENTS FILTER#

PEOPLE_ENTITLEMENTS FILTER#

IDENTITIES_ENTITLEMENTS FILTER#

REVIEWS FILTER#

Upload the CSV file via the pre-signed URL#

Request

Request samples

Responses

BalkanID Filters Upload CSV Format

Sample CSV

Column Definitions

Required Columns

Filter Value Format

Filter Fields

PEOPLE FILTER

IDENTITIES FILTER

APPLICATIONS FILTER

ENTITLEMENTS FILTER

APPLICATION_ENTITLEMENTS FILTER

PEOPLE_ENTITLEMENTS FILTER

IDENTITIES_ENTITLEMENTS FILTER

REVIEWS FILTER

Upload the CSV file via the pre-signed URL