File Provider Integration Guide

Amir Avitzur
Amir Avitzur
  • Updated

Connecting Flat Files with Authomize

Authomize enables users to connect to any application via a custom connector that gets its data from an Excel file.

The connector leverages Authomize APIs to extract the content of the file and load it into Authomize. After a file has been loaded, Authomize creates a custom connector with its own unique ID. That ID can be used later with other APIs such as POST, PATCH and DELETE.

For more information on loading data, see Manual Data Loads in The Authomize Model.

Uploading the file

In addition to this guide, an Excel file template is provided in the installation wizard. You can download the Excel file, load data into it, save it, and then upload the file to Authomize.

Note: Some fields are mandatory, and Authomize will validate the file structure for you. 

Installation

  1. From the Integrations > Data Sources page, click Add New App.
  2. Click File Provider.
    The File Provider dialog is displayed:Integrate_File_Provider.png
    1. From step 1 in the dialog, download the Excel template and populate the file.
    2. Upload the populated Excel file.
    3. (Optional) It is recommended to upload a logo (PNG, JPG, or JPEG format).
    4. (Optional) You can enter a unique name for this integration. By default, the integration will be named File Provider.
    5. (Optional) You can select a current Authomize user as the app owner.
  3. Click Create.

When the integration is ready, the new connector is added to the connector list.

File_Provider_Integration-1.png

Types of File Provider

There are 2 types of file providers:

  • Campaign file provider – this type is for user access reviews and allows end users to update their entire review at one time without any dependencies between different entities such as Identities and assets. These file uploads are processed in the Authomize platform in a matter of seconds so you can start your user access review immediately. This version enables you to create access to apps and group membership types of campaigns.
  • File provider – this type supports a more complex model enabling you to build both user access reviews and more complex permissions graphs, with dependencies between entities such as users-groups-asset, for example. The processing time for these files is longer (up to one hour, depending on the amount and complexity of the data).

Data processing

  1. Campaign file provider
    1. Campaign permissions - built based on this API: https://api.authomize.com/documentation#tag/Campaign/operation/add_campaign_permissions_v2_apps__appId__campaigns__campaignId__permissions_post.   
      There are 4 types of data sets that need to be uploaded: Account, Reviewer, Privilege, Assets. The following fields are mandatory:
      1. Account
        1. Account ID (could be the user account ID, or email if the email is unique)
        2. Name of the user account
      2. Reviewer
        1. Email of the reviewer
      3. Privilege
        1. Privilege Type, the type of privilege such as read, write, admin, etc.
      4. Assets
        1. Asset ID (must be unique)
        2. Asset Name
    2. Group Membership - built based on this API: https://api.authomize.com/documentation#tag/Campaign/operation/add_campaign_memberships_v2_apps__appId__campaigns__campaignId__memberships_post.  
      There are 3 types of data sets that needed to be uploaded: Account, Reviewer, Group. The following fields are mandatory:
      1. Account
        1. Account ID (could be the user account ID, or email if the email is unique)
        2. Name of the user account
      2. Reviewer
        1. Email of the reviewer
      3. Group
        1. Group ID (must be unique)
        2. Name
  2. File Provider
    1. The file provider is built on the Connectors APIs here: https://api.authomize.com/documentation#tag/Connectors
    2. The following data can be collected:
Share this

Was this article helpful?

0 out of 0 found this helpful