Enterprise Push Command

Populate enterprise user vaults with templated records. Records can be assigned directly to users or to all users in selected teams.

enterprise-push command

Populate user vaults with a set of template records.

DotNet CLI

Command: enterprise-push

Usage:

enterprise-push [options] [file_name]

Parameter:

• --syntax-help show example file format and template parameters

• --team <TEAM NAME OR UID> team to assign records to

• --email <USER EMAIL, DISPLAY NAME OR UID> user to assign records to

• --users <USER1,USER2> comma-separated users to assign records to

• --teams <TEAM1,TEAM2> comma-separated teams to assign records to

• --dry-run show planned record transfers without changing the vault

• --format <table|csv|json> dry-run output format

• --output <FILE NAME> output file for CSV or JSON dry-run results

Example:

enterprise-push --team "Chicago Office" office-codes.json
enterprise-push --email [e-mail] default.json
enterprise-push --syntax-help

DotNet SDK

Function: PushEnterpriseRecords

public async Task<EnterprisePushResult> PushEnterpriseRecords(VaultOnline vault,ImportRecord[] templateRecords,EnterprisePushOptions options = null)

Parameters:

• vault vault used to create and transfer the records.

• templateRecords template records to create.

• options target users, target teams, dry-run setting, and warning callback.

Options:

• Users target user email, display name, or enterprise user ID.

• Teams target team name or team UID.

• DryRun show planned transfers without changing the vault.

Example:

var result = await enterpriseData.PushEnterpriseRecords(
    vault,
    templateRecords,
    new EnterprisePushOptions
    {
        Users = new[] { "[e-mail]" },
        Teams = new[] { "Chicago Office" },
        DryRun = false
    });

PowerCommander

Command: Invoke-KeeperEnterprisePush

Alias: kep

Flags:

Parameters	Description
-FileName	JSON file containing template records. Required.
-Email	one target user email, display name, or enterprise user ID
-Users	additional target users.
-Teams	target team name or UID.
-DryRun	show planned transfers without changing the vault

Example:

# Send records to a user
PS> Invoke-KeeperEnterprisePush `
       -FileName default.json `
       -Email [e-mail]

# Send records to all users in a team
PS> kep `
       -FileName office-codes.json `
       -Team "Chicago Office"

# Send records to multiple users and teams
PS> kep `
       -FileName default.json `
       -Users [e-mail],[e-mail] `
       -Teams "Chicago Office,Support"

# Preview the transfers
PS> kep `
       -FileName default.json `
       -Team "Chicago Office" `
       -DryRun

File Format

The enterprise-push command uses Keeper JSON record import format.

The template file can be either:

• An array of records

• An object containing a records array

Example JSON file:

[
  {
    "title": "Google",
    "login": "${user_email}",
    "password": "${generate_password}",
    "login_url": "https://google.com",
    "notes": "",
    "custom_fields": {
      "Name 1": "Value 1",
      "Name 2": "Value 2"
    }
  },
  {
    "title": "Admin Tool",
    "login": "${user_email}",
    "password": "",
    "login_url": "https://192.168.1.1",
    "notes": "",
    "custom_fields": {}
  }
]

Supported template parameters:

${user_email}          Target user's email address
${user_name}           Target user's full name
${generate_password}   Generate a random password

To export JSON data for a template:

1. Create an empty folder for storing templates, such as Templates.

2. Add the required records to that folder.

3. Export the folder as JSON:

export --format=json --folder=Templates templates.json

The uid and folders properties are not used by enterprise-push because new records are generated and transferred for each target user.