Enterprise Role Commands

Manage enterprise roles.

Usage

enterprise-role command [--options] OR er command [--option]

Alias: er

Commands

Command
Description
Alias

View enterprise role

v

Create enterprise role(s)

a

Edit enterprise role(s)

e

Delete enterprise role(s)

Manage enterprise admin role

Manage enterprise role membership

m

Copy role with enforcements

Enterprise Role view

View enterprise role.

Dotnet CLI

Command: enterprise-role name

Example:

My Vault> enterprise-role view "IT Admin" OR er view "IT Admin"
DotNet SDK

Data can be retrieved from RoleData

Function: RoleData

 public interface IRoleDataManagement

Example:

await roleData.Enterprise.Load();
PowerCommander

Command: Get-KeeperEnterpriseRole

Syntax:

Aliases: ker

Parameters:

  • -RoleId - Role ID (optional, lists all if omitted)

Examples:

Command: Get-KeeperEnterpriseRoleUsers / Get-KeeperEnterpriseRoleTeams

Get role members

Syntax:

Aliases: keru, kert

Parameters:

  • -RoleId - Role ID (required)

Examples:

Python CLI

Command: enterprise-role view

Parameter:

role - Role Name or ID (required)

Flag:

  • -v, --verbose - Print verbose information

  • --format - Output format: json

  • --output - Output filename

Python SDK

Function:

Enterprise Role Add

Create enterprise role(s).

Dotnet CLI

Command: enterprise-role add "Role Name" --node "Node Name" OR er add "Role Name" --node "Node Name"

Example:

DotNet SDK

Function: CreateRole

Example:

PowerCommander

Command: New-KeeperEnterpriseNode

Aliases: keradd

Parameters:

Parameter
Required
Description

-Role

Yes

Role name(s). Can specify multiple roles.

-Parent

No

Parent node name or ID. Defaults to root node.

-NewUser

No

Assign role to new users. Values: on, off. Default: off.

-VisibleBelow

No

Make role visible to subnodes. Values: on, off. Default: off.

-Enforcement

No

Role enforcement in KEY:VALUE format. Can be repeated. list can be found here

-Force

No

Skip confirmation when role name already exists.

Example:

Python CLI

Command: enterprise-role add

Parameter:

role - Role Name. Can be repeated. (required)

Flag:

  • --parent - Parent node name or ID

  • --new-user - Assign this role to new users: on or off

  • --visible-below - Visible to all nodes. 'add' only: on or off

  • --enforcement - Sets role enforcement. Format: KEY:VALUE. Can be repeated.

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

Python SDK

Function:

Enterprise Role Edit

Edit enterprise role(s).

DotNet CLI

Command: enterprise-role update

Usage : enterprise-role update role-name --flags=values

flags:

Parameter
Description

-new-user

Set role as default for new users in the node

-visible-below

Set role visibility to subnodes

-new-role-name

New role display name

Example:

DotNet SDK

Function: UpdateRole

Usage:

Parameters:

Description

newUserInherit

Sets the current role we are editing as a default role

visibleBelow

Set role visibility to subnodes. If null, property is not changed

displayName

New role display name. If null, property is not changed.

Example:

PowerCommander

Command: Set-KeeperEnterpriseRole

Usage: Set-KeeperEnterpriseRole <Role Name> -NewUserInherit $true

Options:

Parameter
Description

-Role

Role Name, ID, or EnterpriseRole object (mandatory)

-NewUserInherit

Set role as default for new users in the node

-VisibleBelow

Set role visibility to subnodes

-NewDisplayName

New role display name

Example:

Python CLI

Command: enterprise-role edit

Parameter:

role - Role Name or ID. Can be repeated. (required)

Flag:

  • --parent - Parent node name or ID

  • --name, --displayname - Set role display name

  • --new-user - Assign this role to new users: on or off

  • --visible-below - Visible to all nodes: on or off

  • --enforcement - Sets role enforcement. Format: KEY:VALUE. Can be repeated.

Python SDK

Function:

Enterprise Role Delete

Delete enterprise node(s).

DotNet CLI

Command: enterprise-role delete <"Node name"> OR er delete <"Node name">

Example:

DotNet SDK

Function: DeleteRole()

Usage:

Example:

PowerCommander

Command : Remove-KeeperEnterpriseRole

Aliases : kerdel

Example:

Python CLI

Command: enterprise-role delete

Parameter:

  • role - Role Name or ID. Can be repeated. (required)

Python SDK

Function:

Enterprise Role Admin

Manage enterprise admin role.

DotNet CLI

Not Implemented

DotNet SDK

Function: AddUserToAdminRole

Usage:

PowerCommander

Command: Get-KeeperEnterpriseAdminRole

Get roles with admin privileges for user

Syntax:

Aliases: kerap

Parameters:

  • -Email - User email

Examples:

Python CLI

Command: enterprise-role admin

Parameter:

role - Role Name or ID (required)

Flag:

  • -aa, --add-admin - Add managed node to role. Can be repeated.

  • -ra, --remove-admin - Remove managed node from role. Can be repeated.

  • -ap, --add-privilege - Add privilege to managed node. Can be repeated.

  • -rp, --remove-privilege - Remove privilege from managed node. Can be repeated.

  • --cascade - Apply to the child nodes. "--add-admin" only: on or off

Python SDK

Function:

Enterprise Role Membership

Manage enterprise role membership.

DotNet CLI

Command: enterprise-role add-members "Role Name"

Aliases: er

Example:

DotNet SDK

Function:

AddUserToAdminRole - To add user as admin

RemoveUserFromRole - To remove admin role from user

Examples:

PowerCommander

Add Users to a given Role

Command: Grant-KeeperEnterpriseRoleToUser

Aliases: kerua

Flags:

  • -Role : Role Name, ID, or EnterpriseRole object

  • -User : User email, ID, or EnterpriseUser object

Example:

Remove Users from a given role:

Command: Revoke-KeeperEnterpriseRoleFromUser

Aliases: kerur

Flags:

  • -Role : Role Name, ID, or EnterpriseRole object

  • -User : User email, ID, or EnterpriseUser object

Example:

Python CLI

Command: enterprise-role membership

Parameter:

  • role - Role Name or ID (required)

Options: -h, --help show this help message and exit -au, --add-user EMAIL - add user to role. Can be repeated. -ru, --remove-user EMAIL - remove user (Email, User ID, @all) from role. Can be repeated. -at, --add-team TEAM - add team to role. Can be repeated. -rt, --remove-team TEAM - remove team (Name, Team UID, @all) from role. Can be repeated.

Warning: This action cannot be undone and will remove all users, roles, teams, and subnodes.

Python SDK

Function:

Enterprise Role Copy

Copy role with enforcement.

DotNet CLI

Not Implemented

DotNet SDK

Not Implemented

PowerCommander

Not Implemented

Python CLI

Command: enterprise-role copy

Parameter:

role - Role Name or ID (required)

Flag:

  • --node - New role node name or ID (required)

  • --name, --displayname - New role name (required)

Python SDK

Function:

Enterprise Role Team Management

This command assigns or unassigns a role to team

DotNet CLI

Command: enterprise-role

Add Team to a Role:

Action: add-members

Flags:

  • --help : Display this help screen.

  • --version : Display version information.

  • value pos. 0 : KSM command: "add-members"

  • value pos. 1 : Role Name or ID

  • value pos. 2 : User Email, User ID, Team Name, or Team UID (space-separated list)

Example:

Remove Team from a Role:

Action: remove-members

Flags:

  • --help : Display this help screen.

  • --version : Display version information.

  • value pos. 0 : KSM command: "remove-members"

  • value pos. 1 : Role Name or ID

  • value pos. 2 : User Email, User ID, Team Name, or Team UID (space-separated list)

Example:

DotNet SDK

Add Team to a Role:

Function: AddTeamToRole

Arguments:

role - EnterpriseRole object representing the role to which the team will be added

team - EnterpriseTeam object representing the team to be added to the role

Remove Team from a Role:

Function: RemoveTeamFromRole

Arguments:

role - EnterpriseRole object representing the role from which the team will be removed

team - EnterpriseTeam object representing the team to be removed from the role

PowerCommander

Add Team to a Role:

Command: Grant-KeeperEnterpriseRoleToTeam

Aliases: kerta

Flags:

  • -Role : Role Name, ID, or EnterpriseRole object

  • -Team : Team UID, Name, or EnterpriseTeam object

Example:

Remove Team from a Role:

Command: Revoke-KeeperEnterpriseRoleFromTeam

Aliases: kertr

Flags:

  • -Role : Role Name, ID, or EnterpriseRole object

  • -Team : Team UID, Name, or EnterpriseTeam object

Example:

Last updated

Was this helpful?