Skip to main content

Set up Cyera

Connect docs via MCP

Before configuring the Cyera workflow in Atlan, generate two sets of credentials:

  • A Cyera API token (Client ID and Client Secret) so Atlan can read metadata from Cyera. Atlan authenticates with Cyera using JWT-based authentication through the Cyera API endpoint (api.cyera.io).
  • An Atlan API token so the Cyera App can create the custom metadata structures it writes back to your Atlan workspace.

Prerequisites​

Before you begin, make sure you have:

  • A Cyera account with the DSPM Viewer role or higher, and permission to create API tokens
  • Access to your Atlan tenant as an Admin, with permission to create API tokens

Create Cyera API token​

Create an API token in Cyera to generate the credentials Atlan uses to authenticate.

  • Log in to your Cyera instance at app.cyera.io
  • Navigate to Settings → API Tokens (direct link)
  • Click Generate Token
  • Give the token a meaningful name, for example Atlan App
  • Assign a role to the token:
    • DSPM Viewer (recommended): Provides read-only access to datastores, classifications, issues, and identities across all Cyera projects.
    • DSPM Project Viewer: Scopes the token to a specific Cyera project. Use this if your organization requires project-level token isolation. Make sure the selected project includes all datastores you want to map in Atlan.
  • Click Create

Obtain client ID and client secret​

After creating the API token, copy the generated credentials for use in the Atlan workflow configuration.

  • Locate the newly created API token in the list
  • Copy the Client ID and store it securely
  • Copy the Client Secret and store it securely; this value is only shown once at creation time

Generate Atlan API token​

The Cyera App creates custom metadata structures (Cyera, CyeraIssues, and CyeraIdentities) in your Atlan workspace to hold the classifications, issues, and identity findings it enriches assets with. This requires an Atlan API token. Generate the token before configuring the Cyera workflow.

  1. In Atlan, navigate to your profile in the bottom-left corner and select API Tokens.
  2. Click Generate API Token.
  3. Provide the token details:
    • Name: Enter a descriptive name, for example Cyera App Token.
    • Description: Optionally describe the token's purpose.
    • Persona: Assign a persona with permission to manage custom metadata in your workspace.
  4. Click Save to create the token.
  5. Copy the generated API Token and store it securely; the full value is only shown once at creation time.

Paste this token into the Cyera workflow's Advanced Settings in the next step.

Next, enter all three credentials (Cyera Client ID, Cyera Client Secret, and Atlan API Token) in the Atlan workflow Credential step when crawling Cyera.

Get help​

If you run into issues while setting up Cyera:

Next steps​

  • Crawl Cyera: Configure and run the crawler to catalog your Cyera assets