Errors

Interacting with our APIs may result in an error instead of the expecting result. Miro tries to respond with a detailed error message that will help you figure out what went wrong and how to fix it.

SCIM error schema
Error response examples:

{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:Error"
    ],
    "status": "404",
    "detail": "No valid resources: [{memberId=3074457345618258730, display=null}, {memberId=4567543256789076, display=null}]"
}
{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:Error"
    ],
    "status": "409",
    "detail": "[email protected] is not whitelisted"
}
{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:Error"
    ],
    "status": "400",
    "scimType": "invalidValue",
    "detail": "User name '[email protected]' is invalid: 'not unique'"
}
{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:Error"
    ],
    "status": "429",
    "scimType": "tooManyRequests",
    "detail": "The user has sent too many requests in a given amount of time"
}

Possible errors:

StatusDescription
400

Bad Request.

Unexpected request.
The detail attribute of the resource should provide information on what request/attribute value is unexpected.

401

Unauthorized.

Miro cannot authorize the organization with the authorization token.

403

Forbidden.

SCIM integration is disabled.

404

Not Found.

The requested resource wasn't found by looking up its ID.

405

Method not allowed.

Miro doesn't support the requested method.

409

Conflict.

Miro cannot update a resource because of a business logic conflict.
The logic conflict can vary, depending on the real-life scenario.
For example:
  • Try to allow an email address that isn't included in the allow list (whitelist).
  • Try to add or update the email address of a user whose status is inactive.
  • Try to update the details of a user who belongs to more than one organization.
  • Try to update the details of an enterprise user who exists in Miro as an uncaptured user: the user profile exists in Miro, but the profile isn't a member of a team within the enterprise; therefore, enterprise admins cannot retrieve it.
413

Payload too large.

The payload exceeds the maximum payload of 800000 bytes.

415

Unsupported Media Type.

The endpoint doesn't support the provided media type.

429

Too many requests.

The request is rejected by rate limits.

500

Internal Server Error.

An unexpected error of application.
Please, contact Miro support to clarify the reason for such an error.