Enterprise Role Commands
Manage enterprise roles.
Usage
enterprise-role command [--options] OR er command [--option]Alias: er
Commands
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 IRoleDataManagementExample:
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
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:
PowerCommander
Command: New-KeeperEnterpriseNode
Aliases: keradd
Parameters:
-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.
-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:onoroff--visible-below- Visible to all nodes. 'add' only:onoroff--enforcement- Sets role enforcement. Format:KEY:VALUE. Can be repeated.-f,--force- Do not prompt for confirmation
Enterprise Role Edit
Edit enterprise role(s).
DotNet CLI
Command: enterprise-role update
Usage : enterprise-role update role-name --flags=values
flags:
-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:
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:
-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:onoroff--visible-below- Visible to all nodes:onoroff--enforcement- Sets role enforcement. Format:KEY:VALUE. Can be repeated.
Enterprise Role Delete
Delete enterprise role(s).
Python CLI
Command: enterprise-role delete
Parameter:
role- Role Name or ID. Can be repeated. (required)
Enterprise Role Admin
Manage enterprise admin role.
DotNet CLI
Command : enterprise-role add-users-to-admin-role <Role name> <Username> OR
er add-users-to-admin-role <Role name> <Username>
Example :
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:onoroff
Enterprise Role Membership
Manage enterprise role membership.
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.
Enterprise Role Copy
Copy role with enforcement.
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)
Enterprise Role Team Management
This command assigns or unassigne 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 IDvalue 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 IDvalue 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:
Enterprise Role Managed Node Add
This command/function helps to add a managed node to a role.
DotNet CLI
imCommand: enterprise-role <action> roll_name --node=<node_name> --cascade OR er <action> roll_name --node=<node_name> --cascade
Parameter:
roll_name - Role name or ID.
node_name - Node name or ID.
cascade - cascade includes it is true else false
Examples:
Reference:
DotNet SDK
Add Managed Node:
Function: RoleManagedNodeAdd
Usage:
Parameters:
role
EnterpriseRole object representing the role
node
EnterpriseNode object representing the node
cascade
do the privileges for this managed node apply to the children nodes - true / false
Example:
Reference:
PowerCommander
Command: Add-KeeperEnterpriseRoleManagedNode
Flags:
Role
Role Name or ID
Node
Node name or ID to add as a managed node
Cascade
Cascade node management to subnodes
Example:
Reference:
Enterprise Role Managed Node Update
This command/function helps to update a managed node to a role.
DotNet CLI
Command: enterprise-role <action> roll_name --node=<node_name> --cascade OR er <action> roll_name --node=<node_name> --cascade
Parameter:
roll_name - Role name or ID.
node_name - Node name or ID.
cascade - cascade includes it is true else false
Examples:
Reference:
DotNet SDK
Update Managed Node:
Function: RoleManagedNodeUpdate
Usage:
Parameters:
role
EnterpriseRole object representing the role
node
EnterpriseNode object representing the node
cascade
do the privileges for this managed node apply to the children nodes - true / false
Example:
Reference:
PowerCommander
Command:Update-KeeperEnterpriseRoleManagedNode
Flags:
Role
Role Name or ID
Node
Node name or ID to add as a managed node
Cascade
Cascade node management to subnodes
Example:
Reference:
Enterprise Role Managed Node Delete
This command/function helps to delete a managed node to a role.
DotNet CLI
Command: enterprise-role <action> roll_name --node=<node_name> OR er <action> roll_name --node=<node_name>
Parameter:
roll_name - Role name or ID.
node_name - Node name or ID.
Examples:
Reference:
DotNet SDK
Remove Managed Node:
Function: RoleManagedNodeRemove
Usage:
Parameters:
role
EnterpriseRole object representing the role
node
EnterpriseNode object representing the node
Example:
Reference:
PowerCommander
Command: Remove-KeeperEnterpriseRoleManagedNode
Flags:
Role
Role Name or ID
Node
Node name or ID to add as a managed node
Example:
Reference:
Enterprise Role Managed Node Privileges Add
This command/function helps to add a batch or individual privileges to managed node.
DotNet CLI
Command: enterprise-role <action> roll_name --node=<node_name> --privileges=<privilege1, privilege2> OR er <action> roll_name --node=<node_name> --privileges=<privilege1, privilege2>
Parameter:
roll_name - Role name or ID.
node_name - Node name or ID.
privileges - comma separated privileges inside a string.
Examples:
Reference:
DotNet SDK
Add Privileges to Managed Node:
Function: RoleManagedNodePrivilegeAddBatch
Usage:
Parameters:
role
EnterpriseRole object representing the role
node
EnterpriseNode object representing the node
privileges
Adds a list of privileges of type
Example:
Reference:
PowerCommander
Command: Add-KeeperEnterpriseRolePrivilege
Aliases: Add-KeeperRolePrivilege
Flags:
-Role
Role Name or ID (Mandatory, Position 0)
-Node
Node name or ID of the managed node (Mandatory, Position 1)
-Privilege
One or more privilege names to add. Valid values: MANAGE_NODES, MANAGE_USER, MANAGE_LICENCES, MANAGE_ROLES, MANAGE_TEAMS, TRANSFER_ACCOUNT, RUN_REPORTS, VIEW_TREE, MANAGE_BRIDGE, MANAGE_COMPANIES, SHARING_ADMINISTRATOR, APPROVE_DEVICE, MANAGE_RECORD_TYPES, RUN_COMPLIANCE_REPORTS (Mandatory, Position 2)
Example:
Reference:
Enterprise Role Managed Node Privileges Remove
This command/function helps to remove a batch or individual privileges to managed node.
DotNet CLI
Command: enterprise-role <action> roll_name --node=<node_name> --privileges=<privilege1, privilege2> OR er <action> roll_name --node=<node_name> --privileges=<privilege1, privilege2>
Parameter:
roll_name - Role name or ID.
node_name - Node name or ID.
privileges - comma separated privileges inside a string.
Examples:
Reference:
DotNet SDK
Remove Privileges of Managed Node:
Function: RoleManagedNodePrivilegeRemoveBatch
Usage:
Parameters:
role
EnterpriseRole object representing the role
node
EnterpriseNode object representing the node
privileges
Removes a list of privileges of type
Example:
Reference:
PowerCommander
Command: Remove-KeeperEnterpriseRolePrivilege
Aliases: Remove-KeeperRolePrivilege
Flags:
-Role
Role Name or ID (Mandatory, Position 0)
-Node
Node name or ID of the managed node (Mandatory, Position 1)
-Privilege
One or more privilege names to remove. Valid values: MANAGE_NODES, MANAGE_USER, MANAGE_LICENCES, MANAGE_ROLES, MANAGE_TEAMS, TRANSFER_ACCOUNT, RUN_REPORTS, VIEW_TREE, MANAGE_BRIDGE, MANAGE_COMPANIES, SHARING_ADMINISTRATOR, APPROVE_DEVICE, MANAGE_RECORD_TYPES, RUN_COMPLIANCE_REPORTS (Mandatory, Position 2)
Example:
Reference:
Enterprise Role Add Enforcement Policies
This command/function helps to add a batch or individual enforcement policies to a role.
DotNet CLI
Command: enterprise-role <action> role_name --enforcements="key1=value1; key2="value2"" OR er <action> role_name --enforcements="key1=value1; key2="value2""
Parameter:
roll_name - Role name or ID.
enforcements - Give enforcements in the form of key and value pair inside the string.
Examples:
Reference:
DotNet SDK
Add Enforcement Policies to Role:
Function: RoleEnforcementAddBatch
Usage:
Parameters:
role
EnterpriseRole object representing the role
enforcements
Adds a batch of enforcement policies of type
Dictionary<RoleEnforcementPolicies, string>
Example:
Reference:
PowerCommander
Command: Add-KeeperEnterpriseRoleEnforcement
Aliases: Add-KeeperRoleEnforcement
Flags:
-Role
Role Name or ID (Mandatory, Position 0)
-Enforcement
Enforcement(s) in KEY=value format. Can be semicolon or comma separated. Multiple enforcements can be provided as an array. Supports both = and : as separators. (Mandatory, Position 1)
Example:
Reference:
Enterprise Role Update Enforcement Policies
This command/function helps to update a batch or individual enforcement policies to a role.
DotNet CLI
Command: enterprise-role <action> role_name --enforcements="key1=value1; key2=value2" OR er <action> role_name --enforcements="key1=value1; key2=value2"
Parameter:
roll_name - Role name or ID.
enforcements - Give enforcements in the form of key and value pair inside the string.
Examples:
Reference:
DotNet SDK
Update Enforcement Policies to Role:
Function: RoleEnforcementUpdateBatch
Usage:
Parameters:
role
EnterpriseRole object representing the role
enforcements
Adds a batch of enforcement policies of type
Example:
Reference:
PowerCommander
Command: Update-KeeperEnterpriseRoleEnforcement
Aliases: Update-KeeperRoleEnforcement
Flags:
-Role
Role Name or ID (Mandatory, Position 0)
-Enforcement
Enforcement(s) in KEY=value format. Can be semicolon or comma separated. Multiple enforcements can be provided as an array. Supports both = and : as separators. (Mandatory, Position 1)
Example:
Separator as Semicolon:
Separator as Comma:
Reference:
Enterprise Role Remove Enforcement Policies
This command/function helps to Remove a batch or individual enforcement policies to a role.
DotNet CLI
Command: enterprise-role <action> role_name --enforcements="key1; key2; key3" OR er <action> role_name --enforcements="key1; key2; key3"
Parameter:
roll_name - Role name or ID.
enforcements - comma separated enforcements inside a string.
Examples:
Reference:
DotNet SDK
Remove Enforcement Policies to Role:
Function: RoleEnforcementRemoveBatch
Usage:
Parameters:
role
EnterpriseRole object representing the role
enforcements
Adds a batch of enforcement policies of type
Example:
Reference:
PowerCommander
Command: Remove-KeeperEnterpriseRoleEnforcement
Aliases: Remove-KeeperRoleEnforcement
Flags:
-Role
Role Name or ID (Mandatory, Position 0)
-Enforcement
Enforcement key(s) to remove. Can be semicolon or comma separated. For remove operations, use KEY only (no value). If KEY=value format is provided, only the key portion will be used. (Mandatory, Position 1)
Example:
Separator as Semicolon:
Separator as Comma:
Reference:
Last updated
Was this helpful?

