Skip to main content

Getting Started

Getting Started

Set up DuoKey for Salesforce BYOK integration

Preview

The Salesforce Shield integration is in preview and is not yet enabled on standard DuoKey Cockpit tenants. This guide describes how it works and how it is set up. Contact DuoKey to discuss access for your project.

Applies to:
Salesforce Developer Edition+System AdministratorDuoKey Admin

Overview​

Setting up DuoKey for Salesforce BYOK involves three main phases:

Setup Phases

1
Salesforce PrerequisitesConfigure your Salesforce environment
2
DuoKey ConfigurationSet up the application in DuoKey
3
Integration TestingVerify connection and key deployment

Requirements​

Salesforce

  • Developer Edition or higher
  • System Administrator permissions
  • Access to Setup and App Manager
  • Understanding of Connected Apps

DuoKey

  • Active DuoKey account
  • Admin access to platform
  • Encryption key created

Technical

  • Email access for OTP
  • SSL certificate management
  • REST API knowledge

Quick Start Checklist​

Prerequisites

  • Create Salesforce Developer Edition account
  • Configure permission sets in Salesforce
  • Create Connected App in Salesforce
  • Login to DuoKey platform
  • Create new Salesforce BYOK application
  • Configure the Named Credential with the connector secret DuoKey generates
  • Select encryption key
  • Verify Cache-Only Key Service

Step 1: Salesforce Account Setup​

1

Create Salesforce Developer Account

If you don't have a Salesforce Developer Edition account:

  1. Navigate to developer.salesforce.com/signup
  2. Fill in your details and submit
  3. Check your email for verification link
  4. Click verification link and set password
Tip

Keep your Salesforce credentials secure - you'll need them for the DuoKey integration.

2

Note Your Salesforce Domain

  1. Login to your Salesforce account
  2. Navigate to Setup Home → Company Settings → My Domain
  3. Copy your domain name (e.g., yourcompany.develop.lightning.force.com)
  4. Save this for later use

Step 2: Configure Salesforce Permissions​

1

Create Permission Set

  1. In Salesforce Setup, navigate to Users → Permission Sets → New
  2. Set Label: Key Manager
  3. Click Save
2

Configure System Permissions

  1. On the Key Manager permission set page, scroll to System section
  2. Click System Permissions
  3. Click Edit
  4. Enable: Customize Application and Manage Encryption Keys
  5. Click Save
3

Assign Permission Set to User

  1. From Setup, go to Users
  2. Select your user account
  3. Scroll to Permission Set Assignments
  4. Click Edit Assignments
  5. Add Key Manager to Enabled Permission Sets
  6. Click Save

Step 3: Configure a Named Credential​

DuoKey never logs into your Salesforce org and never needs your Salesforce username, password, or security token. Instead, Salesforce Shield calls DuoKey's Cache-Only Key Service (COKS) endpoint directly, authenticated with a bearer connector secret that DuoKey generates for you.

  1. In Salesforce Setup, create a Named Credential (and its External Credential) that will point to your DuoKey COKS endpoint
  2. You'll fill in the endpoint URL and the connector secret after DuoKey generates them in Step 6
  3. Save the configuration

Step 4: Login to DuoKey​

  1. Navigate to your DuoKey platform URL
  2. Enter your credentials and login
  3. You'll see the DuoKey Dashboard

Step 5: Navigate to Apps Section​

  1. From the DuoKey Dashboard, click on Apps in the navigation menu
  2. Click + Create new app button

Step 6: Select Salesforce BYOK Application​

  1. From the application container, locate DuoKey for Salesforce
  2. Click Install Now

Troubleshooting​

Next Steps​

Prerequisites

Detailed Salesforce configuration

Create App

Complete the DuoKey application setup

App Management

Manage your application

See Also