Jump to Content

Home Documentation API Reference

Home Documentation API Reference

These docs are for v17. Click to read the latest docs for v33.

Getting Started

Quick Start Guide
Quick Server Setup
Your First SSH Connection
Certificate Authentication for OpenSSH Connections
Importing Users from Active Directory
Configuring SSH Target Host to Accept PrivX Connections
Importing Hosts from AWS
Search Syntax

Deployment

Overview
Release Notes for This Release
Preparing for Deployment
Get PrivX software
PrivX components
Setting up PrivX Components
Deploying PrivX to Amazon Web Services
Deploying PrivX to Google Cloud Platform: architecture blueprint
Deploying PrivX to Azure: architecture blueprint
High-Availability Deployment
License Management
Example Nginx load balancer configuration
Native SSH and RDP clients

Users and Permissions

Adding PrivX Users
- Importing Users from AD/LDAP
Granting User Permissions
Managing Workflows
- Enabling Email Notifications
User Configuration
Additional Authentication Methods
Secrets Vault

Authenticating to Hosts

Supported Authentication Methods
SSH Certificate Authentication
RDP Certificate Authentication
Script-Based Certificate-Authentication Setup
Host external ID and deployment script
Certificate-Authentication Setup via Chef
Manual Certificate-Authentication Setup
Public-Key Authentication
Stored Passwords
Trusting Target-Host Identities

Connection Management

Setting up Hosts
Connecting via the PrivX GUI
SSH Connections with Native Clients
RDP Connections with Native Clients
Website Access via PrivX
AWS CLI Connection with Native Client
Monitoring and Managing Connections
Restricting Users' Access to Applications in RDP Connections
Automatic M2M SSH Connections

Auditing

Viewing Audit Data
SIEM Integration
Session-Recording Setup
External Logging
Matching Certificate-Based-Login Messages
Audit Events Reference
Splunk integration

Advanced Configuration

Best practices
SSL/TLS Security
PrivX Log Settings
Extender Configuration
Carrier and Web Proxy Configuration
API-Client Integration
Setting Custom Instance Names
Custom Disclaimers
Resetting the Superuser Password
Configuring ephemeral credential access for AWS API
Reset PrivX settings

Integrations

User Directories
Host Directories
- AWS EC2 as a Host Directory
- Google Cloud Platform as a Host Directory
HSM Providers

Troubleshooting

General Troubleshooting
Connections fail with error Too many Authentication Failures
Directory Users Are Not Listed
List Users View Does Not Display All Attributes
Resolving x509: Common Name certificate error
All microservices fail to start except Keyvault
Deploy script fails to trust AWS CA TLS certificate
Windows login failures
Windows revocation failures
OpenSSH 7.8 Client Not Supported
Error "smart card logon is not supported for your user account "
Hosts with "Directory" Account Enabled Not Visible in Connections
Login with Correct Username and Password Fails
All Microservices apart from Keyvault Down
AD That Has Previously Worked Fails
Error "Administratively prohibited" with Native Clients and Extenders
Error "Unable to connect to Extender/Carrier" during Web Connections
Error "Unable to connect to Web Proxy" during Web Connections
Error "The proxy server is refusing connections" during Web Connections
Error "Host Cannot be redeployed" when Deploying a New Cloned Host
Error "Bad configuration option: AuthorizedPrincipalsCommand" when running the deploy script
Microsoft Remote Desktop version 10 for Mac Does Not Display Text
Error "proxy server is refusing connections" during Web Connections on RHEL8
RDP native client times out
Error "USER-STORE [ERROR] Server error: listen tcp :8084: bind: address already in use" when running in Azure
AuthorizedPrincipalsCommand fails with signal 13
Error "proxy_redirect" directive is duplicate in /etc/nginx/privx/privx-proxy-headers.conf:3

Knowledge Base

PrivX microservices architecture
PrivX web access architecture
Websockets and the PrivX Carrier browser
Customizing the PrivX Carrier browser
PrivX RDP Admin Access Deployment in Multi-Domain Environment
Vault and M2M
Onboarding SSH target hosts to PrivX via Ansible
Onboarding SSH target hosts to PrivX via Chef
Onboarding AWS, Azure & Google Cloud SSH target hosts the simple way
Enabling TLS 1.3
Removing Hosts from Directories
Configuring GitLab access through PrivX SSH certificate authentication
Example Nginx Load-Balancer Configuration
PrivX Analytics
Role permissions
Connection method vs feature matrix
Setting up and upgrading PrivX with custom network ports
Supported SSH Algorithms
PrivX Settings
Granting Password-based root Access via Roles
Requesting and Granting Roles, Passwordless Access
Passwordless SSH and RDP Access
Manual PrivX-Server Backup and Restore
PrivX AWS High Availability Installation With Two ELBs
How to install PrivX
OSS Acknowledgements
End-user license agreement (EULA)
Documentation Conventions
PrivX settings examples
Previous Releases and Notes

FAQ

Licensing
Connectivity
Authentication
Data Encryption
PrivX Components
Miscellaneous
Buying and Trying
Support and Services
Product Info
Security
Product Features
Compliance
Session Recording and Playback
Auditing
Tips and Tricks

User Configuration

This section describes the configuration topics related to PrivX users.

Updated over 3 years ago