Introduction

Introduction

The Miro SCIM API lets supported SSO/identity providers automate user and group provisioning in Miro. Use it to provision, manage, and deprovision users, and to manage user group membership. The SCIM API is available for Miro Enterprise accounts.

New synchronization model

A SCIM Group now corresponds directly to a Miro user group, replacing the previous model where a SCIM Group mapped to a Miro team. Creating, updating, or deleting a SCIM Group creates, updates, or deletes the corresponding user group, and adding or removing members changes that user group's membership immediately. A user group can be assigned to multiple teams so you can sync organizational structures that span multiple teams instead of being limited to a 1:1 user group to team mapping.

Standard and version

Miro's SCIM API is based on the open standard System for Cross-domain Identity Management (SCIM) and implements SCIM 2.0.

Supported resources

Miro's SCIM implementation supports these resource types:

• Users: Users in a company plan.
• Groups: User groups in a company plan.

What you can do with SCIM

With the SCIM API, you can:

• Retrieve all users in a company plan.
• Retrieve all user groups in a company plan.
• Create, update, and delete user groups.
• Add or remove user group members.
• Update users.
• Activate or deactivate users.
• Delete users.

What's not supported

• Bulk operations aren't supported. Each request must target a single resource.
• Password changes aren't supported via SCIM.
• ETag-based conditional requests aren't supported.

Supported identity providers

Miro supports automated provisioning with the following identity providers:

• Okta: Set up automated provisioning with Okta.
• Azure AD: Set up automated provisioning with Azure AD.
• OneLogin: Set up automated provisioning with OneLogin.
• CyberArk: Set up automated provisioning with CyberArk.