Device Admin Commands
Admin commands for managing devices across enterprise users
Overview
These commands let enterprise administrators view and manage devices for users they control.
Enterprise device commands require administrator privileges.
Device Admin List
Lists devices for one or more enterprise users.
DotNet CLI
Command : device-admin-list [user] [--format <table|json>]
Parameters
user
Enterprise user email, user ID, or "all". If omitted, lists devices for every enterprise user.
--format
Output format: table (default) or json.
Examples
PowerCommander
Command : Get-KeeperAdminUserDevice [[-User] <String>] [-Format <String>]
Parameters
-User
Enterprise user email or ID. If omitted (or "all"), lists devices for every enterprise user.
-Format
table (default) or json.
Examples:
Python CLI
Command: device-admin-list
Parameters:
enterprise_user_idsOne or more enterprise user IDs--formatOutput format. Values:tableorjson. Default:table--outputOutput file name. Ignored fortableformat
Example:
Python SDK
Function: list_admin_devices
Parameters:
keeper_auth_contextLogged-inKeeperAuthsessionenterprise_user_idsOne or more enterprise user IDs
Example:
Device Admin Logout
Log out a user from selected device.
DotNet CLI
Command : device-admin-action logout <user> <devices> [--yes]
Parameters
action
One of: logout, remove, lock, unlock, account-lock, account-unlock.
user
Enterprise user email or ID that owns the target device(s).
devices
Comma-separated device identifiers. Accepts: id:<prefix> (device ID prefix), name:<text> (device name substring), #<row> (1-based row number, resolved against this user's device list only), a bare value (tried as row number, then ID prefix, then name), or "all".
--yes
Skips the confirmation prompt shown before remove, lock, and account-lock. Use for unattended/scripted runs.
Examples:
PowerCommander
Command : Invoke-KeeperAdminUserDeviceAction [-Action] [-User] [-Devices] <String[]> [-Confirm] [-WhatIf]
Parameters
-Action
One of: logout, remove, lock, unlock, account-lock, account-unlock.
-User
Enterprise user email or ID that owns the target device(s).
-Devices
Device ID(s), device name(s), id:<prefix>, name:<text>, #<row> (row number from Get-KeeperAdminUserDevice for this user), or "all". Accepts a comma-separated string or an array of strings.
-Confirm / -WhatIf
Standard PowerShell ShouldProcess switches. remove, lock, and account-lock prompt for confirmation by default (ConfirmImpact = High); pass -Confirm:$false to skip the prompt in scripts, or -WhatIf to preview without acting.
Identifiers that match more than one device are reported as ambiguous and skipped, unless "all" is specified.
Examples
Python CLI
Command: device-admin-action logout
Parameters:
enterprise_user_idEnterprise user IDdeviceDevice ID fromdevice-admin-listor exact device name
Example:
Python SDK
Function: logout_admin_user_devices
Parameters:
keeper_auth_contextLogged-inKeeperAuthsessionenterprise_user_idEnterprise user IDdevice_identifiersOne or more device IDs or exact device names
Example:
Device Admin Remove
Removes a selected device from a user account.
DotNet CLI
Command : device-admin-action remove <user> <devices> [--yes]
Parameters
action
One of: logout, remove, lock, unlock, account-lock, account-unlock.
user
Enterprise user email or ID that owns the target device(s).
devices
Comma-separated device identifiers. Accepts: id:<prefix> (device ID prefix), name:<text> (device name substring), #<row> (1-based row number, resolved against this user's device list only), a bare value (tried as row number, then ID prefix, then name), or "all".
--yes
Skips the confirmation prompt shown before remove, lock, and account-lock. Use for unattended/scripted runs.
Examples
PowerCommander
Command : Invoke-KeeperAdminUserDeviceAction [-Action] [-User] [-Devices] <String[]> [-Confirm] [-WhatIf]
Parameters
-Action
One of: logout, remove, lock, unlock, account-lock, account-unlock.
-User
Enterprise user email or ID that owns the target device(s).
-Devices
Device ID(s), device name(s), id:<prefix>, name:<text>, #<row> (row number from Get-KeeperAdminUserDevice for this user), or "all". Accepts a comma-separated string or an array of strings.
-Confirm / -WhatIf
Standard PowerShell ShouldProcess switches. remove, lock, and account-lock prompt for confirmation by default (ConfirmImpact = High); pass -Confirm:$false to skip the prompt in scripts, or -WhatIf to preview without acting.
Identifiers that match more than one device are reported as ambiguous and skipped, unless "all" is specified.
Examples
Python CLI
Command: device-admin-action remove
Parameters:
enterprise_user_idEnterprise user IDdeviceDevice ID fromdevice-admin-listor exact device name
Example:
Python SDK
Function: remove_admin_user_devices
Parameters:
keeper_auth_contextLogged-inKeeperAuthsessionenterprise_user_idEnterprise user IDdevice_identifiersOne or more device list indexes fromdevice-admin-list, or exact device names
Example:
Device Admin Lock
Locks a selected device for the target user.
DotNet CLI
Command : device-admin-action lock <user> <devices> [--yes]
Parameters
action
One of: logout, remove, lock, unlock, account-lock, account-unlock.
user
Enterprise user email or ID that owns the target device(s).
devices
Comma-separated device identifiers. Accepts: id:<prefix> (device ID prefix), name:<text> (device name substring), #<row> (1-based row number, resolved against this user's device list only), a bare value (tried as row number, then ID prefix, then name), or "all".
--yes
Skips the confirmation prompt shown before remove, lock, and account-lock. Use for unattended/scripted runs.
Examples:
PowerCommander
Command : Invoke-KeeperAdminUserDeviceAction [-Action] [-User] [-Devices] <String[]> [-Confirm] [-WhatIf]
Parameters
-Action
One of: logout, remove, lock, unlock, account-lock, account-unlock.
-User
Enterprise user email or ID that owns the target device(s).
-Devices
Device ID(s), device name(s), id:<prefix>, name:<text>, #<row> (row number from Get-KeeperAdminUserDevice for this user), or "all". Accepts a comma-separated string or an array of strings.
-Confirm / -WhatIf
Standard PowerShell ShouldProcess switches. remove, lock, and account-lock prompt for confirmation by default (ConfirmImpact = High); pass -Confirm:$false to skip the prompt in scripts, or -WhatIf to preview without acting.
Identifiers that match more than one device are reported as ambiguous and skipped, unless "all" is specified.
Examples
Python CLI
Command: device-admin-action lock
Parameters:
enterprise_user_idEnterprise user IDdeviceDevice ID fromdevice-admin-listor exact device name
Example:
Python SDK
Function: lock_admin_user_devices
Parameters:
keeper_auth_contextLogged-inKeeperAuthsessionenterprise_user_idEnterprise user IDdevice_identifiersOne or more device list indexes fromdevice-admin-list, or exact device names
Example:
Device Admin Unlock
Unlocks a selected device for the target user.
DotNet CLI
Command : device-admin-action unlock <user> <devices> [--yes]
Parameters
action
One of: logout, remove, lock, unlock, account-lock, account-unlock.
user
Enterprise user email or ID that owns the target device(s).
devices
Comma-separated device identifiers. Accepts: id:<prefix> (device ID prefix), name:<text> (device name substring), #<row> (1-based row number, resolved against this user's device list only), a bare value (tried as row number, then ID prefix, then name), or "all".
--yes
Skips the confirmation prompt shown before remove, lock, and account-lock. Use for unattended/scripted runs.
Examples:
PowerCommander
Command : Invoke-KeeperAdminUserDeviceAction [-Action] [-User] [-Devices] <String[]> [-Confirm] [-WhatIf]
Parameters
-Action
One of: logout, remove, lock, unlock, account-lock, account-unlock.
-User
Enterprise user email or ID that owns the target device(s).
-Devices
Device ID(s), device name(s), id:<prefix>, name:<text>, #<row> (row number from Get-KeeperAdminUserDevice for this user), or "all". Accepts a comma-separated string or an array of strings.
-Confirm / -WhatIf
Standard PowerShell ShouldProcess switches. remove, lock, and account-lock prompt for confirmation by default (ConfirmImpact = High); pass -Confirm:$false to skip the prompt in scripts, or -WhatIf to preview without acting.
Identifiers that match more than one device are reported as ambiguous and skipped, unless "all" is specified.
Examples
Python CLI
Command: device-admin-action unlock
Parameters:
enterprise_user_idEnterprise user IDdeviceDevice ID fromdevice-admin-listor exact device name
Example:
Python SDK
Function: unlock_admin_user_devices
Parameters:
keeper_auth_contextLogged-inKeeperAuthsessionenterprise_user_idEnterprise user IDdevice_identifiersOne or more device list indexes fromdevice-admin-list, or exact device names
Example:
Device Admin Account-lock
Account-locks a selected device for the target user.
DotNet CLI
Command : device-admin-action account-lock <user> <devices> [--yes]
Parameters
action
One of: logout, remove, lock, unlock, account-lock, account-unlock.
user
Enterprise user email or ID that owns the target device(s).
devices
Comma-separated device identifiers. Accepts: id:<prefix> (device ID prefix), name:<text> (device name substring), #<row> (1-based row number, resolved against this user's device list only), a bare value (tried as row number, then ID prefix, then name), or "all".
--yes
Skips the confirmation prompt shown before remove, lock, and account-lock. Use for unattended/scripted runs.
Examples:
PowerCommander
Command : Invoke-KeeperAdminUserDeviceAction [-Action] [-User] [-Devices] <String[]> [-Confirm] [-WhatIf]
Parameters
-Action
One of: logout, remove, lock, unlock, account-lock, account-unlock.
-User
Enterprise user email or ID that owns the target device(s).
-Devices
Device ID(s), device name(s), id:<prefix>, name:<text>, #<row> (row number from Get-KeeperAdminUserDevice for this user), or "all". Accepts a comma-separated string or an array of strings.
-Confirm / -WhatIf
Standard PowerShell ShouldProcess switches. remove, lock, and account-lock prompt for confirmation by default (ConfirmImpact = High); pass -Confirm:$false to skip the prompt in scripts, or -WhatIf to preview without acting.
Identifiers that match more than one device are reported as ambiguous and skipped, unless "all" is specified.
Examples
Python CLI
Command: device-admin-action account-lock
Parameters:
enterprise_user_idEnterprise user IDdeviceDevice ID fromdevice-admin-listor exact device name
Example:
Python SDK
Function: account_lock_admin_user_devices
Parameters:
keeper_auth_contextLogged-inKeeperAuthsessionenterprise_user_idEnterprise user IDdevice_identifiersOne or more device list indexes fromdevice-admin-list, or exact device names
Example:
Device Admin Account-unlock
Account-unlocks a selected device for the target user.
DotNet CLI
Command : device-admin-action account-unlock <user> <devices> [--yes]
Parameters
action
One of: logout, remove, lock, unlock, account-lock, account-unlock.
user
Enterprise user email or ID that owns the target device(s).
devices
Comma-separated device identifiers. Accepts: id:<prefix> (device ID prefix), name:<text> (device name substring), #<row> (1-based row number, resolved against this user's device list only), a bare value (tried as row number, then ID prefix, then name), or "all".
--yes
Skips the confirmation prompt shown before remove, lock, and account-lock. Use for unattended/scripted runs.
Examples:
PowerCommander
Command : Invoke-KeeperAdminUserDeviceAction [-Action] [-User] [-Devices] <String[]> [-Confirm] [-WhatIf]
Parameters
-Action
One of: logout, remove, lock, unlock, account-lock, account-unlock.
-User
Enterprise user email or ID that owns the target device(s).
-Devices
Device ID(s), device name(s), id:<prefix>, name:<text>, #<row> (row number from Get-KeeperAdminUserDevice for this user), or "all". Accepts a comma-separated string or an array of strings.
-Confirm / -WhatIf
Standard PowerShell ShouldProcess switches. remove, lock, and account-lock prompt for confirmation by default (ConfirmImpact = High); pass -Confirm:$false to skip the prompt in scripts, or -WhatIf to preview without acting.
Identifiers that match more than one device are reported as ambiguous and skipped, unless "all" is specified.
Examples
Last updated

