For the complete documentation index, see llms.txt. This page is also available as Markdown.

Enterprise Team Commands

Manage an enterprise team(s).

Usage

enterprise-team command [--options] OR et command [--option]

Alias: et

Commands

Command
Description
Alias

View enterprise team

v

Create enterprise team(s)

a

Edit enterprise team(s)

e

Delete enterprise team(s)

d

Manage enterprise team membership

m

Update user information in team

Approve queued teams and users provisioned by SCIM or Active Directory Bridge

ta

Enterprise Team View Command

This command is for viewing teams and their permissions.

DotNet CLI

Command: enterprise-team view <team_name> OR et view <team_name>

Parameter:

team_name team name (required)

Options:

  • -q, --queued - Include queued team/user information (for list/view)

Example:

My Vault> enterprise-team view "POD Team"           
      Team Name:  POD Team                       
       Team UID:  qS9qkAme2vl6o5UJggaagA         
  Restrict Edit:  No                             
 Restrict Share:  No                             
  Restrict View:  No                             
          Users:  dhananjay.tayade@metronlabs.com
                  satish.gaddala@metronlabs.com  
   Queued Users:                                 
           Node:  Metron Security 
DotNet SDK

Function: EnterpriseData.Teams

Usage: Enterprise users list can be obtained from EnterpriseData as a dictionary

Example:

var enterpriseTeam = EnterpriseData.Teams.FirstOrDefault(x =>
                    string.Compare(x.Name, identifier, StringComparison.CurrentCultureIgnoreCase) == 0);
PowerCommander

Command:Get-KeeperEnterpriseTeam

Syntax:

Aliases: ket

Parameters:

  • -Name - User email.

  • -Filter - Search filter.

  • -Format - Output format.

  • -Output - Output file name.

Example:

Command : Get-KeeperEnterpriseTeamUser

Parameters:

-Team : Name or Uid to filter users for a team.

Syntax:

Example:

Command: Get-KeeperAvailableTeam

Example:

Python CLI

Command: enterprise-team view

Flag:

  • -v, --verbose - Print verbose information

  • --format - Output format: json

  • --output - Output filename

  • team - Team Name or UID (required)

Python SDK

Function:

JavaScript SDK

Function: listTeams

Enterprise Team Add Command

Create enterprise team(s).

DotNet CLI

Usage

Parameter:

team team name

Options:

  • --node <node> - Node name or ID (for add/update)

  • --restrict-edit <ON|OFF> - Disable record editing

  • --restrict-share <ON|OFF> - Disable record re-sharing

  • --restrict-view <ON|OFF> - Disable password viewing/copying

Example:

DotNet SDK

Function: CreateTeam

Example:

PowerCommander

Command: New-KeeperEnterpriseTeam

Syntax:

Parameters:

  • -TeamName - Team name (required)

  • -ParentNode - Parent name or node ID

  • -RestrictEdit - Restrict editing

  • -RestrictShare - Restrict sharing

  • -RestrictView - Restrict viewing passwords

Examples:

Python CLI

Command: enterprise-team add

Parameter:

team - Team Name or Queued Team UID. Can be repeated. (required)

Team creation flags:

  • -f, --force - Do not prompt for confirmation

  • --parent - Parent node name or ID. Defaults to the root node.

  • --restrict-edit - Disable record edits: on or off

  • --restrict-share - Disable record re-shares: on or off

  • --restrict-view - Disable view or copy passwords: on or off

User operation flags:

  • -au, --add-user - Add user to team by email. Repeatable.

  • -ru, --remove-user - Remove user from team by email. Repeatable.

  • -hsf, --hide-shared-folders - User does not see shared folders: on or off. Use with --add-user only.

User identifier: enterprise user email, for example user@company.com.

User operation notes:

  • -hsf on adds the user with hidden shared folders.

  • -hsf off adds the user with visible shared folders.

  • If the user is already on the team and -hsf is omitted, a warning is shown and the user is skipped.

  • -ru @all is not supported on add. Use enterprise-team membership with -ru @all.

Role operation flags:

  • -ar, --add-role - Add role to team by name or ID. Repeatable.

  • -rr, --remove-role - Remove role from team by name or ID. Repeatable.

Role identifier: role name or role ID.

Role operation notes:

  • Admin roles cannot be assigned to teams. They are skipped with a warning.

  • If the role is already on the team, it is skipped silently.

  • -rr @all is not supported on add. Use enterprise-team membership with -rr @all.

Examples:

Python SDK

Function:

JavaScript SDK

Function: addTeams

Enterprise Team Edit Command

Edit enterprise team(s).

DotNet CLI

Command:

enterprise-team update [team] [--options] OR et update [team] [--options]

Parameter:

team team name

Options:

  • --node <node> - Node name or ID (for add/update)

  • --restrict-edit <ON|OFF> - Disable/Enable record editing

  • --restrict-share <ON|OFF> - Disable/Enable record re-sharing

  • --restrict-view <ON|OFF> - Disable/Enable password viewing/copying

Example:

DotNet SDK

Function: UpdateTeam

Example:

PowerCommander

Command: Update-KeeperEnterpriseTeam

Syntax:

Aliases: kete

Parameters:

  • -Team - Team UID or team name (required)

  • -TeamName - New team display name

  • -ParentNode - Parent node name or ID

  • -RestrictView - Disable or enable password viewing/copying: ON or OFF

  • -RestrictEdit - Disable or enable record editing: ON or OFF

  • -RestrictShare - Disable or enable record re-sharing: ON or OFF

Examples:

Python CLI

Command: enterprise-team edit

Parameter:

team - Team Name or UID. Can be repeated. (required)

Team property flags:

  • -f, --force - Do not prompt for confirmation

  • --name - Set team display name. Single team only. Returns an error if multiple team values are given.

  • --parent - Parent node name or ID. If omitted, keeps the first team's current parent node.

  • --restrict-edit - Disable record edits: on or off

  • --restrict-share - Disable record re-shares: on or off

  • --restrict-view - Disable view or copy passwords: on or off

Restriction note: If --restrict-edit, --restrict-share, or --restrict-view are omitted, they are treated as off when the edit is applied.

User operation flags:

  • -au, --add-user - Add user to team by email. Repeatable.

  • -ru, --remove-user - Remove user from team by email. Repeatable.

  • -hsf, --hide-shared-folders - User does not see shared folders: on or off. Use with --add-user only.

User identifier: enterprise user email, for example user@company.com.

Hide shared folders values:

Value
Effect

on

User added with hidden shared folders

off

User added with visible shared folders

omitted

Default team user type

User operation notes:

  • If the user is already on the team, a warning is shown and the user is skipped unless -hsf changes the user type.

  • -ru @all is not supported on edit. Use enterprise-team membership with -ru @all.

Role operation flags:

  • -ar, --add-role - Add role to team by name or ID. Repeatable.

  • -rr, --remove-role - Remove role from team by name or ID. Repeatable.

Role identifier: role name or role ID.

Role operation notes:

  • Admin roles cannot be assigned to teams. They are skipped with a warning.

  • If the role is already on the team, it is skipped silently.

  • -rr @all is not supported on edit. Use enterprise-team membership with -rr @all.

Examples:

Python SDK

Function:

JavaScript SDK

Function: updateTeams

Enterprise Team Delete Command

Delete enterprise team(s).

DotNet CLI

Command: enterpise-team delete teamID

Parameter:

team team name or team ID

Example:

DotNet SDK

Function: DeleteTeam

Example:

PowerCommander

Command: Remove-KeeperEnterpriseTeam

Syntax:

Aliases: ketdel

Parameters:

  • -Team - Team UID or team name (required)

  • -Force - Do not prompt for confirmation before deleting the team

Examples:

Python CLI

Command: enterprise-team delete

Parameter:

  • team - Team Name or UID. Can be repeated. (required)

Python SDK

Function:

JavaScript SDK

Function: deleteTeams

Enterprise Team Membership Command

Manage enterprise team membership.

DotNet CLI

Not Implemented

DotNet SDK

Functions:

AddUsersToTeams - This function is for adding user to given team.

RemoveUsersFromTeams - This function is for removing users from team.

Example:

PowerCommander

Commands:

Add-KeeperEnterpriseTeamMember - This command is for adding user to given team.

Remove-KeeperEnterpriseTeamMember - This command is for removing users from team.

Syntax:

Aliases: keta, ketu

Parameters:

  • -Team - Team UID or name

  • -Emails- User email

Examples:

Python CLI

Command: enterprise-team membership

Parameter:

team - Team Name or UID. Can be repeated. (required)

Flag:

  • -au, --add-user - Add user to team. Can be repeated.

  • -ru, --remove-user - Remove user from team. @all. Can be repeated.

  • -ar, --add-role - Add role to team. Can be repeated.

  • -rr, --remove-role - Remove role from team, @all. Can be repeated.

Python SDK

Function:

JavaScript SDK

Function: comming soon

Enterprise Team User Update Command

This command/function is used to update the usertype in a team

DotNet CLI

Command: enterprise-user <action> username --team=<team_name> --user-type=<user_type>

Parameter:

email - User email or ID.

team - Team name or ID

user-type - 0=user, 1=admin, 2=admin_only (means he wont see the shared folders but can add users to the team)

Examples:

DotNet SDK

Enterprise Team User Update:

Function: TeamEnterpriseUserUpdate

Usage:

Parameters:

Description

enterpriseTeam

EnterpriseTeam object representing the team

enterpriseUser

EnterpriseUser object representing the user

userType

0=user, 1=admin, 2=admin_only (means he wont see the shared folders but can add users to the team)

Example:

PowerCommander

Command: Update-KeeperEnterpriseTeamUser

Flags:

Parameter
Description

User

Updates enterprise user information.

Team

Team name or UID

UserType

User type: 0, 1, or 2 0 - User (Normal User) 1 - Administrator 2 - Administrator Only

Example:

Python CLI

Comming Soon

Python SDK

Comming Soon

Enterprise Team Approve Command

DotNet CLI

Command: team-approve or ta

Parameter:

--team Approve queued teams only.

--email Approve queued team users only.

--restrict-edit <on|off> Restrict or allow record editing for approved teams.

--restrict-share <on|off> Restrict or allow record sharing for approved teams.

--restrict-view <on|off> Restrict or allow viewing or copying passwords for approved teams.

--dry-run Display planned approvals without executing them.

--format <table|csv|json> Output format for dry-run results.

--output <file_name> Output file for CSV or JSON dry-run results.

--force Reload enterprise and queued-team data before approval.

By default, both queued teams and queued users are approved.

Examples:

DotNet SDK

Function: ApproveQueuedTeams

Usage:

Parameters:

Description

ApproveTeams

Approve queued teams

ApproveUsers

Approve queued team users.

RestrictEdit

Restrict record editing for approved teams.

RestrictShare

Restrict record sharing for approved teams.

RestrictView

Restrict viewing or copying passwords for approved teams.

DryRun

Return planned approvals without executing them.

Example:

PowerCommander

Command: Invoke-KeeperTeamApprove

Alias: kta

Flags:

Parameter
Description

-TeamsOnly

Approve queued teams only.

-UsersOnly

Approve queued team users only

-RestrictEdit

Restrict record editing for approved teams.

-RestrictShare

Restrict record sharing for approved teams.

-RestrictView

Restrict viewing or copying passwords for approved teams.

-Force

Reload enterprise and queued-team data before approval.

-DryRun

Display planned approvals without executing them.

Example:

JavaScript SDK

Function: comming soon

Last updated

Was this helpful?