OnePAM 1.0.2

OnePAM PowerShell Module

PowerShell module for secure SSH, SCP, and Database access through OnePAM.

Requirements

• PowerShell 7.0 or later (cross-platform — Windows, macOS, Linux)
• No external module dependencies

Installation

Install-Module -Name OnePAM -Scope CurrentUser

To update to the latest version:

Update-Module -Name OnePAM

Add to Profile

# Automatically load on every PowerShell session
Add-Content $PROFILE 'Import-Module OnePAM'

Authentication

OnePAM uses OAuth2 Device Code flow — the same method as the CLI client. Config and tokens are stored in ~/.onepam/ and shared with the CLI.

# Log in (opens browser for authorization)
Connect-OnePAM

# Check auth status
Get-OnePAMAuthStatus

# Log out
Disconnect-OnePAM

Configuration

# View current config
Get-OnePAMConfig

# Point to a different OnePAM instance
Set-OnePAMConfig -Key api_base -Value "https://my-onepam.example.com"

# Set default organization
Set-OnePAMConfig -Key org_uuid -Value "12345678-1234-1234-1234-123456789abc"

SSH

# Interactive SSH session
Enter-OnePAMSSH -Resource "my-server"

# SSH as a specific user
Enter-OnePAMSSH -Resource "root@my-server"

# Execute a remote command
Enter-OnePAMSSH -Resource "my-server" -Command "uname -a"

SCP / File Transfer

# Upload a file
Copy-OnePAMFile -Source "myfile.txt" -Destination "my-server:/tmp/"

# Download a file
Copy-OnePAMFile -Source "my-server:/var/log/app.log" -Destination "./"

# Recursive directory copy
Copy-OnePAMFile -Source "./config/" -Destination "my-server:/etc/app/" -Recursive

Database

Supports PostgreSQL, MySQL, MSSQL, MongoDB, and Elasticsearch.

Interactive REPL

# Start interactive SQL session
Connect-OnePAMDatabase -Resource "prod-postgres"

# Inside the REPL:
#   \dt              List tables
#   \d <table>       Describe table
#   \databases       List databases
#   \h               Help
#   \q               Quit

Programmatic Queries

# Run a query and get PowerShell objects
$users = Invoke-OnePAMQuery -Resource "prod-db" -Query "SELECT * FROM users LIMIT 10"

# Pipeline-friendly output
Invoke-OnePAMQuery -Resource "prod-db" -Query "SELECT name, email FROM users" | Format-Table

# Export to CSV
Invoke-OnePAMQuery -Resource "analytics" -Query "SELECT * FROM events" | Export-Csv events.csv

Resource Management

# List all resources
Get-OnePAMResource

# Filter by type
Get-OnePAMResource -Type ssh
Get-OnePAMResource -Type database

# Get details for a specific resource
Get-OnePAMResource -Name "prod-db"

# Create a new resource
New-OnePAMResource -Name "staging-db" -Type database -TargetHost "db.staging" -Port 5432 -AgentId "agent-uuid"

# Update a resource
Set-OnePAMResource -Id "resource-uuid" -Name "new-name" -Port 5433

# Enable / Disable
Enable-OnePAMResource -Id "resource-uuid"
Disable-OnePAMResource -Id "resource-uuid"

# Delete a resource
Remove-OnePAMResource -Id "resource-uuid" -Force

Session Management

# List active sessions
Get-OnePAMSession -Status active

# List SSH sessions
Get-OnePAMSession -Type ssh

# Terminate a session
Stop-OnePAMSession -SessionId "session-uuid"

CLI Compatibility

This module shares the same configuration directory (~/.onepam/) and token format as the OnePAM CLI (onepam). If you're already authenticated with the CLI, the PowerShell module will use the same session automatically.

Support

Visit onepam.com for documentation and support.