To obtain authorization for your app, you must create an authorization request link that you can send to users. The authorization flow begins by redirecting a browser to the authorization request link with a set of query parameters.
Prerequisites
- Create a Developer team in Miro
- Create your app in Miro
- Configure your app in Miro
- Install your app in Miro
Create the Authorization request link
Authorization request link
https://miro.com/oauth/authorize?response_type=code&client_id={required_client_id_value}&redirect_uri={required_redirect_uri_value}&state={optional_state_value}&team_id={optional_team_id_value}
Authorization request link with line breaks
(We've added line breaks for better readability. Delete the line breaks for actual use.)
https://miro.com/oauth/authorize?response_type=code
&client_id={required_client_id_value}
&redirect_uri={required_redirect_uri_value}
&state={optional_state_value}
&team_id={optional_team_id_value}
Where:
| Query parameter | Description | Sample value |
|---|---|---|
response_typerequired | Indicates the response type. As we use the authorization code grant type, set the response_type query parameter value to code. | code |
client_id required | The Client ID of the app that is requesting for user authorization. To obtain your client ID: in Miro, go to your apps. Then, in 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. | 3074457363680401096 |
redirect_urirequired | The URI of the page that you want to load after the user provides the authorization. | [<https://localhost:3000>](https://localhost:3000`) |
stateoptional | 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. | 123xyz |
team_idoptional | 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: in Miro, go to the Profile Settings page. In the User & Team Management section, click Teams. In the team list on the right pane, click the team name for which you want to obtain the team ID. Copy the team ID from the URL. Sample URL: <https://miro.com/app/settings/team/3004457345010752790/users> | 3074457362577833142 |
Sample authorization request link with required query parameters
Authorization request link
https://miro.com/oauth/authorize?response_type=code&client_id=3074457363680401096&redirect_uri=https://localhost:3000/
Authorization request link with line breaks
(We've added line breaks for better readability. Delete the line breaks for actual use.)
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
Authorization request link
https://miro.com/oauth/authorize?response_type=code&client_id=3074457363680401096&redirect_uri=https://localhost:3000/&state=123xyz&team_id=3074457362577833142
Authorization request link with line breaks
(We've added line breaks for better readability. Delete the line breaks for actual use.)
https://miro.com/oauth/authorize?response_type=code
&client_id=3074457363680401096
&redirect_uri=https://localhost:3000/
&state=123xyz
&team_id=3074457362577833142