Docs Menu
Docs Home
/ /

atlas api teams

Returns, adds, edits, or removes teams.

The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.

Name
Type
Required
Description

-h, --help

false

help for teams

Name
Type
Required
Description

-P, --profile

string

false

Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

  • atlas api teams addGroupTeams - Adds one or more teams to the specified project.

  • atlas api teams addTeamUsers - Adds one or more MongoDB Cloud users from the specified organization to the specified team.

  • atlas api teams createOrgTeam - Creates one team in the specified organization.

  • atlas api teams deleteOrgTeam - Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier.

  • atlas api teams getGroupTeam - Returns one team to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier.

  • atlas api teams getOrgTeam - Returns one team that you identified using its unique 24-hexadecimal digit ID.

  • atlas api teams getTeamByName - Returns one team that you identified using its human-readable name.

  • atlas api teams listGroupTeams - Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier.

  • atlas api teams listOrgTeams - Returns all teams that belong to the specified organization.

  • atlas api teams removeGroupTeam - Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier.

  • atlas api teams removeUserFromTeam - Removes one MongoDB Cloud user from the specified team.

  • atlas api teams renameOrgTeam - Renames one team in the specified organization.

  • atlas api teams updateGroupTeam - Updates the project roles assigned to the specified team.

Back

withStreamSampleConnections

On this page