v5

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-02-283466592.5 MB

Account members

Add a member to teams

Add one member to one or more teams.

post/api/v2/members/{id}/teams

Path parameters

idstring string required

The member ID

Request body

teamKeysstring[] required

List of team keys

Example request

{
  "teamKeys": [
    "team1",
    "team2"
  ]
}

Response

Member response

_linksobject required

The location and content type of related resources

_idstring required

The member's ID

firstNamestring

The member's first name

lastNamestring

The member's last name

rolestring required

The member's base role. If the member has no additional roles, this role will be in effect.

emailstring required

The member's email address

_pendingInviteboolean required

Whether the member has a pending invitation

_verifiedboolean required

Whether the member's email address has been verified

_pendingEmailstring

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

customRolesstring[] required

The set of additional roles, besides the base role, assigned to the member

mfastring required

Whether multi-factor authentication is enabled for this member

excludedDashboardsstring[]

Default dashboards that the member has chosen to ignore

_lastSeeninteger required

creationDateinteger required

oauthProvidersOAuthProviderKind[]

A list of OAuth providers

versioninteger

Version of the current configuration

roleAttributesRoleAttributeMap

Example response

{
  "_id": "507f1f77bcf86cd799439011",
  "firstName": "Ariel",
  "lastName": "Flores",
  "role": "reader",
  "email": "ariel@acme.com",
  "_verified": true,
  "customRoles": [
    "devOps",
    "backend-devs"
  ],
  "_lastSeenMetadata": {
    "tokenId": "5b52207f8ca8e631d31fdb2b"
  },
  "teams": [
    {
      "customRoleKeys": [
        "access-to-test-projects"
      ],
      "key": "team-key-123abc",
      "name": "QA Team"
    }
  ],
  "permissionGrants": [
    {
      "actions": [
        "maintainTeam"
      ],
      "resource": "team/qa-team"
    }
  ],
  "version": 1
}