Add a member to teams

POST
/api/v2/members/:id/teams

Add one member to one or more teams.

Path parameters

idstringRequired

The member ID

Request

This endpoint expects an object.
teamKeyslist of stringsRequired

List of team keys

Response

Member response

_idstring

The member’s ID

rolestring

The member’s built-in role. If the member has no custom roles, this role will be in effect.

emailstring

The member’s email address

_pendingInviteboolean

Whether the member has a pending invitation

_verifiedboolean

Whether the member’s email address has been verified

customRoleslist of strings

The set of custom roles (as keys) assigned to the member

mfastring

Whether multi-factor authentication is enabled for this member

_lastSeenlong

The member’s last session date (as Unix milliseconds since epoch)

creationDatelong

Timestamp of when the member was created

firstNamestringOptional

The member’s first name

lastNamestringOptional

The member’s last name

_pendingEmailstringOptional

The member’s email address before it has been verified, for accounts where email verification is required

excludedDashboardslist of stringsOptional

Default dashboards that the member has chosen to ignore

_lastSeenMetadataobjectOptional

Additional metadata associated with the member’s last session, for example, whether a token was used

_integrationMetadataobjectOptional

Details on the member account in an external source, if this member is provisioned externally

teamslist of objectsOptional

Details on the teams this member is assigned to

permissionGrantslist of objectsOptional

A list of permission grants. Permission grants allow a member to have access to a specific action, without having to create or update a custom role.

oauthProviderslist of stringsOptional

A list of OAuth providers

versionintegerOptional

Version of the current configuration

roleAttributesmap from strings to lists of stringsOptional

The role attributes for the member

Errors

Built with