Docs Menu
Docs Home
/ /
Atlas CLI
/ / /

atlas teams users delete

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Output
  • Examples

Remove the specified user from a team for your organization.

To use this command, you must authenticate with a user account or an API key with the Organization User Admin role.

Command Syntax
atlas teams users delete <userId> [options]
Name
Type
Required
Description

userId

string

true

Unique 24-digit string that identifies the user.

Name
Type
Required
Description

--force

false

Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action.

-h, --help

false

help for delete

--orgId

string

false

Organization ID to use. This option overrides the settings in the configuration file or environment variable.

--teamId

string

true

Unique 24-digit string that identifies the team.

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.

If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.

User '<Name>' deleted from the team
# Remove the user with the ID 5dd58c647a3e5a6c5bce46c7 from the team with the ID 5f6a5c6c713184005d72fe6e for the organization with ID 5e2211c17a3e5a48f5497de3:
atlas teams users delete 5dd58c647a3e5a6c5bce46c7 --teamId 5f6a5c6c713184005d72fe6e --orgId 5e1234c17a3e5a48f5497de3

Back

add