This Device Commands

This page gives information of subcommands for currently logged in device Operations.

Overview

This page provides documentation related to functionalities of keeper which can be done related to the currently logged in device. enabling some of these functionalities helps with easing of logging in process and other useful functionalities from next login.

The following commands are supported

• Device Information Command

• Device Register Command

• Device Persistent Login Command

• Set Device Logout Timer Command

• Device Rename Command

• Device IP AutoApprove Command

• Device-Yubikey Relation Command

Device Information Command

This command informs of the current device and helps setting device controls for login support.

DotNet CLI

Command: this-device

Example:

My Vault> this-device

         Device Name: PowerShell Commander
      Client Version: Commander 17.0.0
    Data Key Present: True
     IP Auto Approve: True
    Persistent Login: False
      Logout Timeout: 1 hour(s)
     Biometric Login: False

Available sub-commands: rename, register, persistent_login, ip_disable_auto_approve, timeout, bio

DotNet SDK

Not Available

PowerCommander

Command: Get-KeeperDeviceSettings

Aliases: this-device

Syntax:

Get-KeeperDeviceSettings [<CommonParameters>]

Examples:

PS> Get-KeeperDeviceSettings

DeviceName          : PowerShell Commander
PersistentLogin     : False
DataKeyPresent      : True
IpAutoApprove       : True
IsSsoUser           : False
DeviceLogoutTimeout : 60 minute(s)

Python CLI

Command: this-device

Example:

My Vault> this-device
          Device Name  Python Keeper API
     Data Key Present  False
      IP Auto Approve  True
     Persistent Login  False
Device Logout Timeout  30 days
          Is SSO User  False

Python SDK

Function: load_account_summary

keeper_auth.load_account_summary(auth_context)

Device Register Command

This command is used to encrypts the user's data key with the device public key in order to utilize persistent login sessions

DotNet CLI

Command: this-device register

Example:

My Vault> this-device register
Device already registered.

DotNet SDK

Function: RegisterDataKeyForDevice

public static async Task RegisterDataKeyForDevice(this IAuthentication auth, DeviceInfo device)

Example:

// assuming device is DeviceInfo object
if (!device.EncryptedDataKeyPresent)
{
    await _auth.RegisterDataKeyForDevice(device);
}

PowerCommander

Command: Set-KeeperDeviceSettings

Parameters:

• -Register - Register

Syntax:

Set-KeeperDeviceSettings -Register

Python CLI

Command: this-device register

Flags: NA

Example:

My Vault> this-device register
Successfully registered device

Python SDK

Function: register_data_key_for_device

keeper_auth.register_data_key_for_device(auth_context)

Device Persistent Login Commandthis-device persistent-login

Use this command to turn on or off the "Stay Logged In" setting for your account

DotNet CLI

Command: this-device persistent_login

Example:

My Vault> this-device persistent_login ON

My Vault> this-device persistent_login OFF

DotNet SDK

Command: SetSessionParameter

public static async Task SetSessionParameter(this IAuthentication auth, string name, string value)

Example:

await _auth.SetSessionParameter("this-device", "1");

PowerCommander

Command: Set-KeeperDeviceSettings

Parameters:

• -PersistentLogin - Enable/disable persistent login

Examples:

Set-KeeperDeviceSettings -PersistentLogin $true

Python CLI

Command: this-device persistent-login

Flags: NA

Example:

My Vault> this-device persistent-login on
Successfully ENABLED Persistent Login on this account

Python SDK

Function: set_user_setting

keeper_auth.set_user_setting(auth_context, 'persistent_login', '1')

Set Device Logout Timer Command

Use this command to set inactivity duration before automatic logout. Default unit is minutes (can be set to hours or days by appending "h" or "d", respectively).

DotNet CLI

Command: this-device timeout

Example:

My Vault> this-device timeout 200 

DotNet SDK

Function: SetSessionParameter

public static async Task SetSessionParameter(this IAuthentication auth, string name, string value)

Example:

await _auth.SetSessionInactivityTimeout(200);

PowerCommander

Command: Set-KeeperDeviceSettings

Parameters:

• -Timeout - Session timeout in minutes

Example:

Set-KeeperDeviceSettings -Timeout 30

Python CLI

Command: this-device timeout

Flags: NA

Example:

My Vault> this-device timeout 30d
Successfully set "logout_timer" to 30 days.

Python SDK

Function: set_user_setting

keeper_auth.set_user_setting(auth_context, 'logout_timer', str(timeout_in_minutes))

Device Rename Command

Use this command to change the name of the device

DotNet CLI

Command: this-device rename <NewNameHere>

Example:

My Vault> this-device

         Device Name: MacKeeper
      Client Version: Commander 17.0.0
    Data Key Present: True
     IP Auto Approve: True
    Persistent Login: False
      Logout Timeout: 3.3333333333333335 hour(s)
     Biometric Login: False

Available sub-commands: rename, register, persistent_login, ip_disable_auto_approve, timeout, bio

My Vault> this-device rename NewMacKeeper

My Vault> this-device

         Device Name: NewMacKeeper
      Client Version: Commander 17.0.0
    Data Key Present: True
     IP Auto Approve: True
    Persistent Login: False
      Logout Timeout: 3.3333333333333335 hour(s)
     Biometric Login: False

Available sub-commands: rename, register, persistent_login, ip_disable_auto_approve, timeout, bio

DotNet SDK

Command: Not Applicable

PowerCommander

Command: Set-KeeperDeviceSettings -NewName <SomeNewName>

Example:

PS> Get-KeeperDeviceSettings                     

DeviceName          : NewMacKeeper
PersistentLogin     : False
DataKeyPresent      : True
IpAutoApprove       : True
IsSsoUser           : False
DeviceLogoutTimeout : 3 hour(s)

PS> Set-KeeperDeviceSettings -NewName MacKeeper
PS> Get-KeeperDeviceSettings                        

DeviceName          : MacKeeper
PersistentLogin     : False
DataKeyPresent      : True
IpAutoApprove       : True
IsSsoUser           : False
DeviceLogoutTimeout : 3 hour(s)

Python CLI

Command: this-device rename

Flags: NA

My Vault> this-device rename "New Device Name"
Successfully renamed device to New Device Name

Python SDK

Function: rename_device

keeper_auth.rename_device(auth_context, 'New Device Name')

Device IP AutoApprove Command

Use this command to control the IP Address device auto-approval security setting for your account

DotNet CLI

Command: this-device timeout

Example:

My Vault> this-device ip_disable_auto_approve ON

DotNet SDK

Function: SetSessionParameter

public static async Task SetSessionParameter(this IAuthentication auth, string name, string value)

Example:

await SetSessionParameter("ip_disable_auto_approve, "1");

PowerCommander

Command: Set-KeeperDeviceSettings -IpAutoApprove OFF

Example:

PS> Set-KeeperDeviceSettings -IpAutoApprove OFF

Python CLI

Command: this-device ip-auto-approve

Flags: NA

Example:

My Vault> this-device ip-auto-approve on
Successfully ENABLED `ip_auto_approve`

Python SDK

Function: set_user_setting

keeper_auth.set_user_setting(auth_context, 'ip_disable_auto_approve', '0')
#set '0' to enable and '1' to disable auto-approve

Device-Yubikey Relation Command

Use this command to turn on or off the PIN usage on Security Key (Webauthn) devices.

DotNet CLI

Command: Not supported

DotNet SDK

Command:Not supported

PowerCommander

Command: Not supported

Python CLI

Command: this-device no-yubikey-pin

Flags: NA

Example:

My Vault> this-device no-yubikey-pin on
Successfully DISABLED Security Key PIN verification

Python SDK

Function: set_user_setting

keeper_auth.set_user_setting(auth_context, 'security_keys_no_user_verify', '1')