> ## Documentation Index
> Fetch the complete documentation index at: https://docs.opal.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Miro

> Learn how to connect Opal to Miro to review boards, and on Enterprise the organization, teams, and user groups.

With the Miro integration, you can see boards, and on an Enterprise plan the organization, its members, teams, and user groups:

* Sync boards on any plan
* On Enterprise, sync organization members, teams, and user groups

## Supported resources

| Resource | Read | Grant and revoke access | Notes |
| - | - | - | - |
| Miro boards | ✔️ | | Any plan. Viewer, Commenter, Editor, Co-owner, and Owner. |
| Miro organization | ✔️ | | One per connection. On Enterprise, roles are Internal user, Internal admin, Content Admin, User Admin, Security Admin, and custom admin role names. |
| Miro teams | ✔️ | | Enterprise. Member and Admin. A team can contain user groups. |
| Miro user groups | ✔️ | | Enterprise. |
| Miro users | ✔️ | | Synced as accounts. Active organization members on Enterprise. |

Organization external users and team guests are not roles. Opal does not use Miro SCIM.

## Requirements

* You must be an Opal admin.
* You must be able to create an app under your Miro avatar and install it on a team.
* For organization members, teams, and user groups, the plan must be Enterprise and the token must belong to a Company Admin.

## 1. Create a Miro app and install it

In Miro, open your avatar and go to **Settings → Your apps**. Create an app and install it on one team. This connection is a service account: there is no user login. Follow Miro's [service account use case](https://developers.miro.com/docs/rest-api-build-your-first-hello-world-app#service-account-use-case-for-rest-api) and [install the app](https://developers.miro.com/docs/rest-api-build-your-first-hello-world-app#step-3-install-the-app).

Grant scopes from [Permission scopes](https://developers.miro.com/reference/scopes):

| Scope | Plan | What it unlocks |
| - | - | - |
| `boards:read` | Any | Boards and board members. Required. |
| `organizations:read` | Enterprise | The organization and its members. |
| `organizations:teams:read` | Enterprise | Teams and team members. |
| `organizations:groups:read` | Enterprise | User groups and their members. |

Do not grant the write scopes. `team:read` does not list teams.

The token lifetime is chosen once, on the create-app dialog, with **Expire user authorization token**. Miro locks that choice. See [Authorization flow for expiring tokens](https://developers.miro.com/reference/authorization-flow-for-expiring-tokens).

**Non-expiring.** Leave the checkbox unchecked. Copy the access token from the install dialog. You do not need a client ID, client secret, or refresh token. The token stays valid until you uninstall the app. See [Use access token for REST API requests](https://developers.miro.com/reference/use-access-token-for-rest-api-requests).

**Expiring.** Check the box when you create the app. The install dialog then shows an access token and a refresh token. Copy both, and copy the client ID and client secret from the app settings page. A refresh token that is not used for 60 days expires. Install the app again and paste the new pair.

## 2. Create a Miro app in Opal

One connection is one Miro organization. Opal reads the organization from the token. You do not type an organization id.

In Opal, go to **Inventory > +App** and select **Miro**. Fill in the following fields and select **Create**.

| Field | Value |
| - | - |
| App name | A name for this account in Opal. |
| App admin | The team or user that should manage the Miro app in Opal. |
| Description | What this account is, for people looking at the app. |
| Access token | The access token from [Step 1](#1-create-a-miro-app-and-install-it). |
| Client ID | Leave blank when the token does not expire. Otherwise, the client ID from the app settings. |
| Client secret | Leave blank when the token does not expire. Otherwise, the client secret from the app settings. |
| Refresh token | Leave blank when the token does not expire. Otherwise, the refresh token from the install dialog. |

If you fill in any of Client ID, client secret, or refresh token, fill in all three.

## 3. Import Miro items

Organization members sync as accounts on the app when the plan is Enterprise.

After creating the app, import boards and the organization from **... > Import items**. On an Enterprise plan, that import also includes teams and user groups.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.