Salesforce DX Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
How Salesforce Developer Experience (DX) Tooling Changes the Way You Work
Provide Developers Access to Salesforce DX Tools
Project Setup
Authorization
Metadata Coverage
Scratch Orgs
Sandboxes
Track Changes Between Your Project and Org
Work with Data
Development
Build and Release Your App
Unlocked Packages
What’s an Unlocked Package?
Package-Based Development Model
Before You Create Unlocked Packages
Know Your Orgs
Create Org-Dependent Unlocked Packages
Workflow for Unlocked Packages
Configure Unlocked Packages
Project Configuration File for Unlocked Packages
Unlocked Packaging Keywords
Package Installation Key
Extract Dependency Information from Unlocked Packages
Understanding Namespaces
Share Release Notes and Post-Install Instructions
Specify Unpackaged Metadata or Apex Access for Apex Tests (Unlocked Packages)
Best Practices for Unlocked Packages
Package IDs and Aliases for Unlocked Packages
Frequently Used Unlocked Packaging Operations
How We Handle Profile Settings in Unlocked Packages
Develop Unlocked Packages
Push a Package Upgrade for Unlocked Packages
Install an Unlocked Package
Migrate Deprecated Metadata from Unlocked Packages
Uninstall an Unlocked Package
Transfer an Unlocked Package to a Different Dev Hub
Continuous Integration
Troubleshoot Salesforce DX
Limitations for Salesforce DX
PDF

Package Installation Key

To ensure the security of the metadata in your package, you must specify an installation key when creating a package version. Package creators provide the key to authorized subscribers so they can install the package. Package installers provide the key during installation, whether installing the package from the CLI or from a browser. An installation key is the first step during installation. The key ensures that no package information, such as the name or components, is disclosed until the correct installation key is supplied.
To set the installation key, add the --installation-key parameter to the command when you create the package version. This command creates a package and protects it with the installation key.
sf package version create --package "Expense Manager" --installation-key "JSB7s8vXU93fI"

Supply the installation key when you install the package version in the target org.

sf package install --package "Expense Manager" --installation-key "JSB7s8vXU93fI”

Change the Installation Key for an Existing Package Version

You can change the installation key for an existing package version with the sf package version update command. 

sf package version update --package "Expense Manager@1.2.0-4" --installation-key “HIF83kS8kS7C”

Create a Package Version Without an Installation Key

If you don’t require security measures to protect your package metadata, you can create a package version without an installation key.

sf package version create --package "Expense Manager" --directory common \
--tag 'Release 1.0.0' --installation-key-bypass

Check Whether a Package Version Requires an Installation Key

To determine whether a package version requires an installation key, use either the sf package version list or sf package version report CLI command.