Class TeamMember

Miro Developer Platform <img src="https://content.pstmn.io/47449ea6-0ef7-4af2-bac1-e58a70e61c58/aW1hZ2UucG5n\" width="1685" height="593"> ### Miro Developer Platform concepts - New to the Miro Developer Platform? Interested in learning more about platform concepts?? Read our introduction page and familiarize yourself with the Miro Developer Platform capabilities in a few minutes. ### Getting started with the Miro REST API - Quickstart (video): try the REST API in less than 3 minutes. - Quickstart (article): get started and try the REST API in less than 3 minutes. ### Miro REST API tutorials Check out our how-to articles with step-by-step instructions and code examples so you can: - Get started with OAuth 2.0 and Miro ### Miro App Examples Clone our Miro App Examples repository to get inspiration, customize, and explore apps built on top of Miro's Developer Platform 2.0.

The version of the OpenAPI document: v2.0

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

Hierarchy

Properties

createdAt? createdBy? id modifiedAt? modifiedBy? orgId role teamId type?

Methods

update

Properties

Optional createdAt

createdAt?: Date

Date and time when member was invited to the team.

Optional createdBy

createdBy?: string

Id of the user who invited the team member.

id

id: string

Team member id.

Optional modifiedAt

modifiedAt?: Date

Date and time when the user's membership was last updated.

Optional modifiedBy

modifiedBy?: string

Id of the user who last updated the user's membership.

orgId

orgId: string

role

role: string

Role of the team member. * "member": Team member with full member permissions. * "admin": Admin of a team. Team member with permission to manage team. * "non_team": External user, non-team user. * "team_guest": Team-guest user, user with access only to a team without access to organization.

teamId

teamId: string

Team id

Optional type

type?: string = 'team-member'

Type of the object returned.

Methods

update

  • Updates team member role in team by id.

    Required scope

    organizations:teams:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Update team member

    Parameters

    Returns Promise<void>

@mirohq/miro-api