Miro Connector

Miro is the online workspace that enables distributed teams to design and build together. It offers a range of collaboration capabilities to create concepts, map user stories or customer journeys, or conduct roadmap planning with the help of Miro Boards.

Search AI enables easy integration with Miro and ingests the metadata of Boards, facilitating easy and efficient search.

Miro Connector Specifications

Type of Repository	Cloud
Content Supported	Boards Metadata
RACL Support	Yes
Content Filtering	No

Prerequisites

Search AI Connector uses Miro APIs to access the resources on the application and ingest the required content. To authenticate these API requests, Search AI uses the OAuth 2.0 authentication mechanism. Hence, it is required to generate credentials for the same.

Generate OAuth credentials

• In your Miro account, click on the user avatar and go to the Profile.
• Navigate to Your Apps tab and click +Create New App.
• Provide a name for the app.
• Add a Redirect URI for the app. Select one of the following URLs as per the region and deployment.
  • JP Region Callback URL: https://jp-bots-idp.kore.ai/workflows/callback
  • DE Region Callback URL: https://de-bots-idp.kore.ai/workflows/callback
  • Prod Callback URL: https://idp.kore.com/workflows/callback
• Enable following permissions for the app.
  • boards:read
  • organizations:read
  • projects:read
  • Organizations:teams:read
• Install the app. Note that the app can be used only when it is deployed.

Configure Miro Connector in Search AI

• Go to the Miro Connector, provide the following details under the Authorization tab and click Connect.
  • Name: Provide a unique name for the connector.
  • Authorization Type: Set it to OAuth 2.0
  • Grant Type: Set it to Authorization Code.
  • Client ID: Credentials generated for the OAuth app in Miro.
  • Client Secret: Credentials generated for the OAuth app in Miro.

Content Ingestion

The Miro Connector allows ingestion of information about Miro boards into the Search AI application. It captures the details of the boards, such as title, content, URL, and project to which the board belongs.

The content field in the ingested content contains the name and description of the board.

RACL Support

By default, when a board is created, it is automatically shared with the other members of the space, hence the sys_racl field is populated with spaceID.

Further, Miro boards can be shared using different access options. For each of the options, the sys_racl is populated as described below.

• Share with specific users via email - When users are directly added to a board, their email addresses are stored in the sys_racl field. The members of a space also have default access to the boards within the space. So, along with individual email addresses, the space ID (also referred to as project ID in Miro) is stored in sys_racl as a permission entity.
• Share with team members - If a board is shared with a team, the team ID is added to the sys_racl field. Since the space members are a subset of the team, when a board is shared with the team, sys_racl only contains team ID and spaceID is not added.
• Everyone in the company -When a board is shared at the company level, the Organization ID is stored in the sys_racl field. Since the space members are a subset of the members of the organization, when a board is shared with the organization, sys_racl only contains organizationID and spaceID is not added.
• Public Access: The sys_racl field is set to *, allowing unrestricted access.

ProjectID, TeamID and OrganizationID are added as permission entities. Use the Permission Entity APIs to associate users with the entities.