Miro Connectors for Okta Workflows allow you to easily automate repetitive and multistep Admin tasks in Miro. Learn how to set up workflow automation and simplify team and user management.
Relevant for: Enterprise Plan
Miro User Management Connector
Miro User Management Connector allows Miro enterprise customers with SCIM enabled to add users to their organization and manage users’ licenses and statuses.
Authorize your Miro User Management Connector:
When you add a Miro User Management card to a flow for the first time, you’ll be prompted to set up a connection for your organization. See Authorization.
Miro User Management Connector action cards:
Action | Description |
Create User | Creates a new user. |
Read User | Search an existing user in an organization by Email. |
Upgrade User License Type to Full | Updates an existing user resource, changing its User License Type to Full. |
Update User Status | Updates an existing user resource, changing its active status to a value of either true or false.The Miro User Management connector works using your SCIM token. Miro User Management is only available for enterprises with SSO and SCIM enabled. |
Authorization
You can create and manage multiple connections from the Connections page.
This is useful if you plan to operate with multiple organizations. Each connection for the Miro User Management Connector can point to only one Miro Organization.
To enable SCIM and obtain a new token, or to copy an existing token, follow the instructions in How to enable SCIM.
To create a new connection from an Action card:
- Click New Connection.
- Enter a Connection Nickname. We recommend a name that represents the organization.
-
Enable SCIM provisioning from Miro’s Enterprise integration page, following the instructions.
- Copy Base URL from Miro and paste it into Base URL field in the Connection
- Copy Api Token from Miro and paste it into Access Token field in Connection
- Click Create. This saves your connection and takes you back to your flow.
Create user
Creates a user within the organization.
Input
Field | Definition | Type | Required |
User Details | |||
The email address of the user. | String | TRUE | |
Active |
The status of the user.
When not specified, it defaults to false. |
Dropdown | FALSE |
User License Type |
The license type of the user.
When not specified, the user license is set according to internal Miro logic, which depends on the organization's plan. |
Dropdown | FALSE |
Role |
The role of the user within the organization.
When not specified, it defaults to Organization Member. |
Dropdown | FALSE |
Name | |||
Family Name | The family name or surname of the user. | String | FALSE |
Given Name | The given name of the user. | String | FALSE |
Display Name | The name to be displayed in Miro. | String | FALSE |
Output
Field | Definition | Type |
User | ||
User ID | The ID of the new user. | String |
Read User
Search an existing user in an organization by Email
Input
Field | Definition | Type | Required |
Query | |||
The email address of the user to search for | String | TRUE |
Output
Field | Definition | Type |
User | ||
User ID | The ID of the user. | Number |
User License Type | The license type of the user. | Number |
Active |
The status of the user.
|
Number |
Name | ||
Username | The email address of the user. | Number |
Family Name | The family name or surname of the user. | Number |
Given Name | The given name of the user. | Number |
Display Name | The name displayed in Miro. | Number |
Upgrade user license type to Full
Updates an existing user resource, changing its user type (license) to Full.
Input
Field | Definition | Type | Required |
User | |||
User ID | The ID of the user. | String | TRUE |
Output
Field | Definition | Type |
Response | ||
Status Code |
HTTP status of the request.
Codes indicating unsuccessful license update:
|
Number |
Update user status
Updates an existing user resource, changing its active status to a value of either true or false.
Input
Field | Definition | Type | Required |
User | |||
User ID | The ID of the user. | String | TRUE |
Active |
The new status of the user.
|
Dropdown | TRUE |
Output
Field | Definition | Type |
Response | ||
Status Code |
HTTP status of the request.
Codes indicating unsuccessful active status update:
|
Number |
Miro Administration Connector
Miro Administration Connector allows enterprise customers to create teams, and manage their team settings and members of the teams.
Authorize your Miro Administration Connector:
When you add a Miro card to a flow for the first time, you’ll be prompted to set up a connection for your organization. See Authorization.
Miro Administration Connector action cards:
Action | Description |
Create Team | Creates a new team in an existing organization. |
Search Teams | Search existing teams in an organization. The first 10 matching records are selected from the Result Set.. |
Add Member to Team | Adds a new member to an existing team. |
Update Team Member Role | Updates a team member role in an existing team. |
Get Team Settings | Retrieves the team settings of an existing team. |
Update Team Sharing Policies Settings | Updates the settings for the sharing policy of an existing team. |
Update Team Invitation Settings | Updates the settings for the invitation policy of an existing team. |
Update Team Collaboration Settings | Updates the settings for the collaboration policy of an existing team. |
Update Team Discovery Settings | Updates the settings for the discovery policy of an existing team. |
Update Team Copy Access Settings | Updates the settings for the copy access policy of an existing team. |
User Session Wipeout (BETA) | Wipes all user sessions for a given email address. |
Authorization
The Miro Administration Connector works using OAuth API Token. Miro Administration Connector is only available for customers on the Enterprises plan. To create a new connection, users must have the necessary permissions to install apps with the supported scopes below.
You can create and manage multiple connections from the Connections page.
This is useful if you plan to operate with multiple organizations. Each connection for the Miro Administration Connector can point to only one Miro Organization.
To create a new connection from an Action card:
- Click New Connection.
- Enter a Connection Nickname. We recommend a name that represents the organization.
- Get Organization ID and Access Token from the Miro’s Enterprise integration page, following the instructions.
- Click Create. This saves your connection and takes you back to your flow.
Supported scopes:
- organizations:teams:write
- organizations:teams:read
Create team
Creates a team in an existing organization.
Input
Field | Definition | Type | Required |
Team | |||
Team Name | The name of the team. | String | TRUE |
Output
Field | Definition | Type |
Response | ||
Team ID | The ID of the new team. | String |
Search Teams
Search existing teams in an organization. The first 10 matching records are selected from the Result Set.
Input
Field | Definition | Type | Required |
Query | |||
Team Name | Words to be matched with team name. Any team whose name contains those exact words to be returned as a resultset. Teams with names that are a full match to the query will be on top of the result. | String | FALSE |
Output
Field | Definition | Type |
Response | ||
Teams | List with 10 first teams found. Each team has the fields below. | List |
Team ID | The ID of the team | String |
Name | Name of the team | String |
Add member to team
Adds a new member to an existing team.
Input
Field | Definition | Type | Required |
Team | |||
Team ID | The ID of the team. | String | TRUE |
Member | |||
User Email | The email of the user that you want to add to the team. | String | TRUE |
Output
Field | Definition | Type |
Response | ||
Member ID | The ID of the new team member. | String |
Update team member role
Updates a team member's role in an existing team.
Input
Field | Definition | Type | Required |
Team | |||
Team ID | The ID of the team. | String | TRUE |
Member | |||
Member ID | The ID of the team member. | String | TRUE |
Role |
The new role of the member within the team.
|
Dropdown | TRUE |
Output
Field | Definition | Type |
Response | ||
Member ID | The ID of the team member. | String |
Role |
The new role assigned to the team member.
|
String |
Get Team settings
Retrieves the team settings of an existing team.
Input
Field | Definition | Type | Required |
Team | |||
Team ID | The ID of the team. | String | TRUE |
Output
Field | Definition | Type |
Team Invitation Settings | ||
Who can Invite |
|
String |
Invite External Users |
|
String |
Team Collaboration Settings | ||
Co-Owner Role |
|
String |
Team Copy Access Level Settings | ||
Copy Access Level |
|
String |
Copy Access Level Limitation |
|
String |
Team Discovery Settings | ||
Discovery |
|
String |
Team Sharing Policy Settings | ||
Default Board Access |
|
String |
Default Organization Access |
|
String |
Sharing on Organization
|
|
String |
Sharing on Team |
|
String |
Sharing via Public Link |
|
String |
Move Board to Team |
|
String |
Update Team Sharing Policy settings
Updates the settings for the sharing policy of an existing team.
Input
Field | Definition | Type | Required |
Team | |||
Team ID | The ID of the team. | String | TRUE |
Default Board Access |
|
Dropdown | FALSE |
Default Organization Access |
|
Dropdown | FALSE |
Sharing via Public Link |
|
Dropdown | FALSE |
Sharing on Team |
|
Dropdown | FALSE |
Sharing on Organization
|
|
Dropdown | FALSE |
Move Board to Team |
|
Dropdown | FALSE |
Output
Field | Definition | Type |
Team Sharing Policy Settings | ||
Default Board Access |
|
String |
Default Organization Access |
|
String |
Sharing on Organization
|
|
String |
Sharing on Team |
|
String |
Sharing via Public Link |
|
String |
Move Board to Team |
|
String |
Update Team Invitation settings
Updates the settings for the invitation policy of an existing team.
Input
Field | Definition | Type | Required |
Team | |||
Team ID | The ID of the team. | String | TRUE |
Invite External Users |
|
Dropdown | FALSE |
Who can Invite |
|
Dropdown | FALSE |
Output
Field | Definition | Type |
Team Invitation settings | ||
Invite External Users |
|
String |
Who can Invite |
|
String |
Update Team copy access settings
Updates the settings for the copy access policy of an existing team.
Input
Field | Definition | Type | Required |
Team | |||
Team ID | The ID of the team. | String | TRUE |
Copy Access Level |
|
Dropdown | FALSE |
Copy Access Level Limitation |
|
Dropdown | FALSE |
Output
Field | Definition | Type |
Team copy access settings | ||
Copy Access Level |
|
String |
Copy Access Level Limitation |
|
String |
Update Team Collaboration settings
Updates the settings for the collaboration policy of an existing team.
Input
Field | Definition | Type | Required |
Team | |||
Team ID | The ID of the team. | String | TRUE |
Co-Owner Role |
|
Dropdown | FALSE |
Output
Field | Definition | Type |
Team Collaboration settings | ||
Co-Owner Role |
|
String |
Update Team Discovery settings
Updates the settings for the discovery policy of an existing team.
Input
Field | Definition | Type | Required |
Team | |||
Team ID | The ID of the team. | String | TRUE |
Discovery |
|
Dropdown | FALSE |
Output
Field | Definition | Type |
Team Discovery settings | ||
Discovery |
|
String |
User Session Wipeout
Wipes all user sessions for a given email address.
Input
Field | Definition | Type | Required |
User Details | |||
The email address of the user whose sessions are to be wiped. | String | TRUE |
Output
Field | Definition | Type |
Response | ||
Status Code |
HTTP status of the request.
Codes indicating unsuccessful user session wipeout update:
|
Number |