To obtain authorization for your app, you must create an authorization request link that you can send to users.

Prerequisites

Authorization request link

Create the following authorization request link:

https://miro.com/oauth/authorize?response_type=code&client_id={client_id_value}&redirect_uri={redirect_uri_value}&state={state_value}&team_id={team_id_value} 

Examples:

  • Sample authorization request link with required query parameters
https://miro.com/oauth/authorize?response_type=code&client_id=3074457363680401096&redirect_uri=https://localhost:3000/
  • Sample authorization request link with required and optional query parameters
https://miro.com/oauth/authorize?response_type=code&client_id=3074457363680401096&redirect_uri=https://localhost:3000/&state=123xyz&team_id=3074457362577833142

Where:

Query parameter

Description

response_type
 *required

Indicates the response type. Set the response_type query parameter value to code.

client_id
 *required

The Client ID of the app that is requesting for user authorization.

To obtain your client ID:

  1. In Miro, go to your apps.

  2. On the Created apps section, click the app for which you want to obtain the Client ID.
    The Client ID appears in the App Credentials section.

Sample value:
3074457363680401096

redirect_uri
 *required

The URI of the page that you want to load after the user provides the authorization.

Sample value:
https://localhost:3000/

state
 optional

This is an extra security measure used to prevent CSRF attacks.

Provide a random string as the state value in the request and then validate that the same state value was received after the user authorized the app.

For request-specific data, you can use the state parameter to store data that will be included after the user is redirected.

Sample value:
123xyz

team_id
 optional

Specify the team ID to display the corresponding team name by default in the Install & authorize app window.

To obtain the team ID for a specific team:

  1. In Miro, go to the Profile Settings page.

  2. In the User & Team Management section, click Teams.

  3. In the team list on the right pane, click the team name for which you want to obtain the team ID.

  4. Copy the team ID from the URL.

Sample URL: https://miro.com/app/settings/team/3004457345010752790/users

Sample team_id value:
3074457362577833142