Skip to main content

Set up BigID

Create a BigID system user account and generate an API token for Atlan to access BigID metadata. This guide walks through creating a custom role, system user, and API token.

Permissions required​

To successfully set up BigID for Atlan integration, confirm that your user role has the necessary permissions:

  • BigID: Administrator access to create roles and system users

Create custom role​

Create a custom role for Atlan to access BigID metadata. Follow these steps that provide privileges only to read metadata of assets and not the actual data contained in Catalog objects.

  • Log in to your BigID instance
  • Navigate to Settings → Access Management → Roles
  • Click Add New Role
  • Give a meaningful and unique name. For example, Atlan Integration as the role name
  • Select root as scope.
  • Add the following permissions:
    • Catalog: Read, Export, Get Attributes Value, View Sensitive Values, Manual Fields (Read), Business Attributes (Read)
    • Data Sources: Read
    • Policies: Read
    • Security Posture: Read
  • Click Save

Create system user​

Atlan uses a system user to authenticate and retrieve metadata from BigID. Follow these steps to create a system user:

  • Navigate to Settings → Access Management → System Users
  • Click Add New Role
  • Fill in the required user details
  • Click Connect Roles and select the Atlan Integration role
  • Click Save

Generate API token​

Atlan uses the API token in Workflow configure to autheticate with BigID. Follow these steps to generate an API token for the system user:

  • Select the system user you just created
  • In the details panel, click Generate under Tokens
  • Set the token expiry period and click Generate
  • Copy and save the token securely for use in Atlan workflow configuration
  • Click Save

Need help​

If you encounter issues during the BigID setup process:

  • BigID documentation: Refer to the BigID documentation for detailed information about roles, system users, and API tokens
  • Contact Atlan support: For issues related to Atlan integration, contact Atlan support

Next steps​