Prerequisites

User Authorization

To obtain authorization for your app:

  1. Send the request authorization link to the user. For more information, see Create authorization request link.
  2. Request the user to open the request authorization link in their browser. Using our earlier example, the user opens the following link in their browser:
https://miro.com/oauth/authorize?response_type=code&client_id=3074457363680401096&redirect_uri=https://localhost:3000/&state=123xyz&team_id=3074457362577833142

The Install & authorize page appears in the user's browser.

  1. The user must click the Install & authorize button.

  2. Miro redirects the user to the redirect_uri provided in your authorization request link. The redirect URI also contains the following information:

    • A temporary code in the code parameter. This is an authorization code that can only be exchanged once and expires 10 minutes after issuance.

    • If you provided a value for the state parameter in the authorization request link, the same state string is returned in the state parameter.

Using our earlier example, the user is redirected to the following URI:

https://localhost:3000/?code=IIze1u&state=123xyz&client_id=3074457363680401096&team_id=3074457362577833142  

Where:

Redirect URI Query parameter

Description

redirect_uri

URI of the page that loaded after the user provided the authorization.
Sample value:
https://localhost:3000

code
(authorization code)

Authorization code that can only be exchanged once and expires 10 minutes after issuance.

Sample value:
IIze1u

state

The same state value that was provided in the authorization request URL.

Sample value:
123xyz

client_id

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

Sample value:
3074457363680401096

team_id

Team ID for the team where the app is being installed. As the app is authorized on a per-user basis, you must obtain authorization from each user.

Sample value:
3074457362577833142