## Set up Mode

URL: https://docs.atlan.com/apps/connectors/business-intelligence/mode/how-tos/set-up-mode

> If you do not see the prompts to enter details for the user above, you are probably already signed in to Mode. Sign out of Mode first, and then accept the invite in the service account email.

:::warning Who can do this?
 You will probably need your Mode administrator to follow the below steps - you may not have access yourself. The Mode administrator will also need to be a connection admin for every connection you want Atlan to be able to crawl.

:::

## Invite a user

To [invite a user](https://mode.com/help/articles/organizations/#add-a-member) for Atlan to use when [integrating with Mode](https://docs.atlan.com/llms/connectors/mode/crawl-mode/llms.txt):

1. From the upper left corner of your Mode instance, click the dropdown with your workspace name and name, and then click **Invite to Mode...**.
2. For _Email Address_, enter a valid email address, for example for the service account.
3. Click the **Invite** button.
4. In your service account's email, open the email from Mode and click **Accept invite**.
5. For _Set up your account_, enter details about the service account:
 1. For _Full name_, enter a name for the service account, such as `Atlan Crawler`.
 2. For _Username_, enter a username for the service account, such as `atlan_crawler`.
 3. For _Password_ and _Confirm password_, enter the same password to use for the service account.
6. At the bottom of the form, click the **Continue** button.

:::warning

If you do not see the prompts to enter details for the user above, you are probably already signed in to Mode. Sign out of Mode first, and then accept the invite in the service account email.

:::

## Set permissions

To set the minimum permissions required to [crawl Mode](https://docs.atlan.com/llms/connectors/mode/crawl-mode/llms.txt):

1. Log into Mode as an administrator again. (If you just completed the steps above, you'll need to log out from the service account first.)
2. From the upper left corner of your Mode instance, click the dropdown with your workspace name and name, and then **Workspace settings**.
3. Under the _People_ heading on the left, click **Members**.
4. Next to the _Search_ box, click the dropdown and select **Current members**.
5. Confirm the user you invited is listed with _Member_ under the _Status_ column.
 - If not, change the _Search_ box dropdown to _Pending members_ and confirm the invitation has been accepted.
 - If yes, change the _Search_ box dropdown to _Former members & requests_, click the three-dots icon to the far right of the service account's row, and then **Reinvite to org**.
6. Under the _Data_ heading on the left, click **Manage Connections**.
7. From the _Manage Connections_ table, for each connection you want to access in Atlan:
 1. Click the row for that connection.
 2. Change to the **Permissions** tab.
 3. At the top of the _Connection access_ table, click the **Add members** button.
 4. Search for and select the service account user, and change the dropdown for access type to **View**. Learn more about the _View_ permission in [Mode documentation](https://mode.com/help/articles/permissions#set-up-connection-permissions).
 5. At the bottom of the form, click the **Add members** button.

:::info **Did you know?** 
 Atlan does **not** make any API requests or queries that will update the workspaces, collections, reports, charts, or queries in your Mode instance.

:::

## Generate API token

Atlan supports the following [API tokens](https://mode.com/help/articles/api-reference) generated in Mode for authentication in Atlan:

- [Workspace token](#workspace-token)
- [Member token](#member-token)
- [Personal token](#personal-token)

### Workspace token

[Workspace tokens](https://mode.com/help/articles/api-tokens#workspace-tokens) allow admin access to the workspace. You will need to be an admin user in Mode to create and manage a workspace token.

To generate a workspace API token for [crawling Mode](https://docs.atlan.com/llms/connectors/mode/crawl-mode/llms.txt):

1. Log in to Mode as an administrator.
2. From the upper left corner of your Mode instance, click the dropdown with your workspace name and name, and then click **Workspace settings**.
3. Under the _Features_ heading on the left, click **API Keys**.
4. On the _API Keys_ page, under _Workspace API Keys_, click the **Create API key** button.
5. In the _Create new API key_ dialog, enter the following details:
 1. For _Display name_, enter a meaningful name - for example, `atlan-crawler`.
 2. For _Key expiration_, keep the default selection or set a longer expiration period.
 3. Click the **Create** button.
 4. From the corresponding _Key secret_ dialog, copy the values for **Key ID** and **Secret** and store them in a secure location. You will not be able to see them again in Mode after leaving this screen.

### Member token

:::warning

Before you can create a member token, you will need your Mode administrator to [enable Member API key creation](https://mode.com/help/articles/api-tokens#member-tokens).

:::

[Member tokens](https://mode.com/help/articles/api-tokens#member-tokens) match an individual user's permissions to access workspace resources in Mode.

To generate a member API token for [crawling Mode](https://docs.atlan.com/llms/connectors/mode/crawl-mode/llms.txt):

1. Log in to Mode as a member.
2. From the upper left corner of your Mode instance, click the dropdown with your workspace name and name, and then click **Workspace settings**.
3. Under the _Workspace_ heading on the left, click **Personal**.
4. Under the _Personal_ heading on the left, click **My API Keys**.
5. In the upper right of the _API Keys_ page, click the **Create API key** button.
6. In the _Create new API key_ dialog, enter the following details:
 1. For _Display name_, enter a meaningful name - for example, `atlan-crawler`.
 2. For _Key expiration_, keep the default selection or set a longer expiration period.
 3. Click the **Create** button.
 4. From the corresponding _Key secret_ dialog, copy the values for **Key ID** and **Secret** and store them in a secure location. You will not be able to see them again in Mode after leaving this screen.

### Personal token

:::warning

Mode will deprecate personal token use on February 28, 2025. You can currently continue to use existing [personal API tokens](https://mode.com/help/articles/api-reference/#personal-tokens), but you will not be able to generate new personal tokens.

:::

---