[ { "heading": "Get started" }, { "title": "What is Boundary?", "path": "what-is-boundary" }, { "title": "Why choose Boundary?", "routes": [ { "title": "Use cases", "path": "overview/use-cases" }, { "title": "Zero trust", "path": "overview/zero-trust" }, { "title": "Bastion hosts", "path": "overview/bastion-hosts" }, { "title": "VPNs", "path": "overview/vpn" }, { "title": "Privileged access management", "path": "overview/pam" }, { "title": "Software-defined perimeter", "path": "overview/sdp" }, { "title": "Secrets management tools", "path": "overview/secrets-management" }, { "title": "Frequently asked questions", "path": "overview/faq" } ] }, { "title": "Quickstart", "routes": [ { "title": "Get started", "path": "getting-started" }, { "title": "HCP Boundary quick start", "href": "https://developer.hashicorp.com/boundary/tutorials/hcp-getting-started/" }, { "title": "Self-managed Boundary quick start", "href": "https://developer.hashicorp.com/boundary/tutorials/oss-getting-started/" }, { "title": "Dev mode quick start", "routes": [ { "title": "Overview", "path": "getting-started/dev-mode" }, { "title": "Run and log in", "path": "getting-started/dev-mode/run-and-login" }, { "title": "Connect to a target", "path": "getting-started/dev-mode/connect-to-dev-target" } ] } ] }, { "title": "Key concepts", "routes": [ { "title": "Auditing", "path": "concepts/auditing" }, { "title": "Identity and access management", "path": "concepts/iam" }, { "title": "Credential management", "path": "concepts/credential-management" }, { "title": "Workers", "path": "concepts/workers" }, { "title": "Aliases", "path": "concepts/aliases" }, { "title": "Transparent sessions", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" }, "path": "concepts/transparent-sessions" } ] }, { "title": "Architecture", "routes": [ { "title": "System requirements", "path": "architecture/system-requirements" }, { "title": "Recommended architecture", "path": "architecture/recommended-architecture" }, { "title": "Fault tolerance", "path": "architecture/fault-tolerance" }, { "title": "High availability", "path": "architecture/high-availability" } ] }, { "divider": true }, { "heading": "Boundary operations" }, { "title": "Deploy Boundary", "routes": [ { "title": "In a self-managed environment", "routes": [ { "title": "Overview", "path": "deploy/self-managed" }, { "title": "Install Boundary", "path": "deploy/self-managed/install" }, { "title": "Configure controllers", "path": "deploy/self-managed/configure-controllers" }, { "title": "Deploy workers", "path": "deploy/self-managed/deploy-workers" }, { "title": "Initialize Boundary", "path": "deploy/self-managed/initialize" }, { "title": "Install Boundary clients", "path": "deploy/self-managed/install-clients" }, { "title": "Systemd install", "hidden": true, "path": "deploy/self-managed/systemd" } ] }, { "title": "On HashiCorp Cloud Platform (HCP)", "href": "hcp/get-started/deploy-and-login" }, { "title": "Using Terraform", "routes": [ { "title": "Overview", "path": "deploy/terraform-patterns" }, { "title": "Configure scopes", "path": "deploy/terraform-patterns/terraform-scopes" }, { "title": "Configure users and auth methods", "path": "deploy/terraform-patterns/terraform-users-and-auth-methods" }, { "title": "Configure groups and RBAC", "path": "deploy/terraform-patterns/terraform-groups-and-rbac" }, { "title": "Configure hosts and host management", "path": "deploy/terraform-patterns/terraform-hosts-and-host-management" }, { "title": "Configure credentials and credential stores", "path": "deploy/terraform-patterns/terraform-credentials-and-credential-stores" }, { "title": "Configure session recording", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" }, "path": "deploy/terraform-patterns/terraform-session-recording" }, { "title": "Configure targets", "path": "deploy/terraform-patterns/terraform-targets" } ] } ] }, { "title": "Secure Boundary", "routes": [ { "title": "Encrypt resources", "routes": [ { "title": "Data encryption", "path": "secure/encryption/data-encryption" }, { "title": "Connections/TLS", "path": "secure/encryption/connections-tls" } ] }, { "title": "Security model", "path": "secure/security-model" } ] }, { "title": "Monitor Boundary", "routes": [ { "title": "Overview", "path": "monitor" }, { "title": "Configure listener addresses and ports", "routes": [ { "title": "Listeners", "path": "monitor/listeners" }, { "title": "TCP listeners", "path": "monitor/listeners/tcp" }, { "title": "Unix listeners", "path": "monitor/listeners/unix" } ] }, { "title": "Monitor metrics", "path": "monitor/metrics" }, { "title": "Monitor health", "path": "monitor/health" }, { "title": "Monitor events", "routes": [ { "title": "Filter events", "path": "monitor/events/filter-events" }, { "title": "Events parameters", "path": "monitor/events/events" }, { "title": "Common sink parameters", "path": "monitor/events/common" }, { "title": "File sink", "path": "monitor/events/file" }, { "title": "Stderr sink", "path": "monitor/events/stderr" } ] } ] }, { "title": "Upgrade Boundary", "href": "https://developer.hashicorp.com/boundary/tutorials/self-managed-deployment/upgrade-version" }, { "title": "Release notes", "routes": [ { "title": "v0.20.0", "path": "release-notes/v0_20_0" }, { "title": "v0.19.0", "path": "release-notes/v0_19_0" }, { "title": "v0.18.0", "path": "release-notes/v0_18_0" }, { "title": "v0.17.0", "path": "release-notes/v0_17_0" }, { "title": "v0.16.0", "path": "release-notes/v0_16_0" }, { "title": "v0.15.0", "path": "release-notes/v0_15_0" }, { "title": "v0.14.0", "path": "release-notes/v0_14_0" }, { "title": "v0.13.0", "path": "release-notes/v0_13_0" }, { "title": "v0.12.0", "path": "release-notes/v0_12_0" }, { "title": "v0.11.0", "path": "release-notes/v0_11_0" }, { "title": "v0.10.0", "path": "release-notes/v0_10_0" }, { "title": "v0.9.0", "path": "release-notes/v0_9_0" }, { "title": "v0.8.0", "path": "release-notes/v0_8_0" }, { "title": "v0.7.0", "path": "release-notes/v0_7_0" }, { "title": "v0.6.0", "path": "release-notes/v0_6_0" }, { "title": "v0.5.0", "path": "release-notes/v0_5_0" }, { "title": "v0.4.0", "path": "release-notes/v0_4_0" }, { "title": "v0.3.0", "path": "release-notes/v0_3_0" }, { "title": "v0.2.0", "path": "release-notes/v0_2_0" }, { "title": "v0.1.0", "path": "release-notes/v0_1_0" } ] }, { "divider": true }, { "heading": "Secure access" }, { "title": "Configure workers", "routes": [ { "title": "Overview", "path": "workers" }, { "title": "Create the worker configuration", "path": "workers/create" }, { "title": "Register workers", "path": "workers/registration" }, { "title": "Configure multi-hop sessions", "routes": [ { "title": "Multi-hop sessions", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" }, "path": "workers/multi-hop" }, { "title": "On Boundary Enterprise", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" }, "path": "workers/multi-hop/enterprise" }, { "title": "On HashiCorp Cloud Platform (HCP)", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" }, "path": "workers/multi-hop/hcp" } ] }, { "title": "Route traffic through a worker", "path": "workers/worker-tags" }, { "title": "Configure a worker filter", "path": "workers/filters" } ] }, { "title": "Configure hosts", "routes": [ { "title": "Host discovery", "path": "hosts" }, { "title": "Sync AWS hosts", "path": "hosts/aws" }, { "title": "Sync Azure hosts", "path": "hosts/azure" }, { "title": "Sync GCP hosts", "path": "hosts/gcp" } ] }, { "title": "Configure targets", "routes": [ { "title": "Set up a target", "routes": [ { "title": "Aliases", "path": "targets/configuration" }, { "title": "Create a target alias", "path": "targets/configuration/create-target-alias" }, { "title": "Configure transparent sessions", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" }, "path": "targets/configuration/configure-transparent-sessions" } ] }, { "title": "Connect to a target", "routes": [ { "title": "Connection workflows", "path": "targets/connections" }, { "title": "Connect helpers", "path": "targets/connections/connect-helpers" }, { "title": "Exec flag", "path": "targets/connections/exec-flag" }, { "title": "SSH ProxyCommand", "path": "targets/connections/workflow-ssh-proxycommand" }, { "title": "Connect using a target alias", "path": "targets/connections/connect-target-alias" }, { "title": "Connect using transparent sessions", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" }, "path": "targets/connections/transparent-sessions" } ] } ] }, { "title": "Configure credentials", "routes": [ { "title": "Credentials in Boundary", "path": "credentials" }, { "title": "Create a static credential store", "path": "credentials/static-cred-boundary" }, { "title": "Create a Vault credential store", "path": "credentials/static-cred-vault" }, { "title": "Configure targets with credential brokering", "path": "credentials/configure-credential-brokering" }, { "title": "Configure targets with credential injection", "path": "credentials/configure-credential-injection", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" } }, { "title": "RDP credential injection compatibility", "path": "credentials/rdp-testing-and-compatibility-matrix", "badge": { "text": "HCP/ENT BETA", "type": "outlined", "color": "neutral" } } ] }, { "title": "Monitor access", "routes": [ { "title": "Session recording", "path": "session-recording", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" } }, { "title": "Record and play back session activity", "routes": [ { "title": "Configure workers for storage", "path": "session-recording/configuration/configure-worker-storage", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" } }, { "title": "Configure storage provider", "routes": [ { "title": "Amazon S3", "path": "session-recording/configuration/storage-providers/configure-s3", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" } }, { "title": "MinIO", "path": "session-recording/configuration/storage-providers/configure-minio", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" } }, { "title": "S3-compliant", "path": "session-recording/configuration/storage-providers/configure-s3-compliant", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" } } ] }, { "title": "Create storage buckets", "path": "session-recording/configuration/create-storage-bucket", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" } }, { "title": "Enable session recording", "path": "session-recording/configuration/enable-session-recording", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" } }, { "title": "Find and view recorded sessions", "path": "session-recording/configuration/manage-recorded-sessions", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" } }, { "title": "Troubleshoot recorded sessions", "path": "session-recording/configuration/troubleshoot-recorded-sessions", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" } } ] }, { "title": "Implement session recording compliance standards", "routes": [ { "title": "Configure storage policies", "path": "session-recording/compliance/configure-storage-policy", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" } }, { "title": "Update storage policies", "path": "session-recording/compliance/update-storage-policy", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" } }, { "title": "Validate recorded sessions", "path": "session-recording/compliance/validate-session-recordings", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" } }, { "title": "Validate external data store", "path": "session-recording/compliance/validate-data-store", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" } } ] }, { "title": "Work with BSR data files", "routes": [ { "title": "BSR file data structure", "path": "session-recording/data/bsr-file-structure", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" } }, { "title": "Read a BSR file", "path": "session-recording/data/read-bsr-file", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" } } ] } ] }, { "title": "Configure role-based access", "routes": [ { "title": "Permissions", "path": "rbac" }, { "title": "Assignable permissions", "path": "rbac/assignable-permissions" }, { "title": "Permission grant formats", "path": "rbac/permission-grant-formats" }, { "title": "Manage access with roles", "path": "rbac/manage-roles" }, { "title": "Resource tables", "path": "rbac/resource-table" }, { "title": "Manage access to resources dynamically", "routes": [ { "title": "Manage principals", "path": "rbac/users/manage-users-groups" }, { "title": "Filter managed groups", "path": "rbac/users/managed-groups" } ] } ] }, { "divider": true }, { "heading": "Integrations" }, { "title": "Vault", "path": "vault" }, { "divider": true }, { "heading": "Enterprise solutions" }, { "title": "HCP Boundary", "routes": [ { "title": "Overview", "path": "hcp", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" } }, { "title": "Get started", "routes": [ { "title": "Deploy and log in", "path": "hcp/get-started/deploy-and-login", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" } }, { "title": "Connect to a target", "path": "hcp/get-started/connect-to-target", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" } } ] }, { "title": "Documentation", "href": "https://cloud.hashicorp.com/docs/boundary", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" } } ] }, { "title": "Boundary Enterprise", "routes": [ { "title": "Overview", "path": "enterprise", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" } }, { "title": "Licensing", "path": "enterprise/licensing", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" } }, { "title": "Automated license reporting", "path": "enterprise/automated-license-reporting", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" } }, { "title": "Supported versions policy", "path": "enterprise/supported-versions", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" } }, { "title": "Deployment guide", "href": "https://developer.hashicorp.com/boundary/tutorials/enterprise/ent-deployment-guide", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" } }, { "title": "Reference architecture", "href": "https://developer.hashicorp.com/boundary/tutorials/enterprise/ent-reference-architecture", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" } } ] }, { "divider": true }, { "heading": "Clients" }, { "title": "Client Agent", "routes": [ { "title": "Overview", "path": "client-agent", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" } }, { "title": "Configure the Client Agent", "path": "client-agent/configuration", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" } }, { "title": "Manage the Client Agent", "path": "client-agent/manage", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" } }, { "title": "Troubleshoot issues", "path": "client-agent/troubleshoot", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" } }, { "title": "Conflicting software", "path": "client-agent/conflicting-software", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" } } ] }, { "title": "Client cache", "path": "client-cache" }, { "title": "Desktop", "href": "https://learn.hashicorp.com/tutorials/boundary/hcp-getting-started-desktop-app" }, { "title": "Go SDK", "path": "go-sdk" }, { "divider": true }, { "heading": "Reference documentation" }, { "title": "API", "routes": [ { "title": "Overview", "path": "api" }, { "title": "Rate limiting", "path": "api/rate-limiting" }, { "title": "List pagination", "path": "api/pagination" }, { "title": "API documentation", "href": "https://developer.hashicorp.com/boundary/api-docs" } ] }, { "title": "Commands (CLI)", "routes": [ { "title": "Overview", "path": "commands" }, { "title": "accounts", "routes": [ { "title": "Overview", "path": "commands/accounts" }, { "title": "change-password", "path": "commands/accounts/change-password" }, { "title": "create", "path": "commands/accounts/create" }, { "title": "delete", "path": "commands/accounts/delete" }, { "title": "list", "path": "commands/accounts/list" }, { "title": "read", "path": "commands/accounts/read" }, { "title": "set-password", "path": "commands/accounts/set-password" }, { "title": "update", "path": "commands/accounts/update" } ] }, { "title": "aliases", "routes": [ { "title": "Overview", "path": "commands/aliases" }, { "title": "create", "path": "commands/aliases/create" }, { "title": "delete", "path": "commands/aliases/delete" }, { "title": "list", "path": "commands/aliases/list" }, { "title": "read", "path": "commands/aliases/read" }, { "title": "update", "path": "commands/aliases/update" } ] }, { "title": "auth-methods", "routes": [ { "title": "Overview", "path": "commands/auth-methods" }, { "title": "change-state", "path": "commands/auth-methods/change-state" }, { "title": "create", "path": "commands/auth-methods/create" }, { "title": "delete", "path": "commands/auth-methods/delete" }, { "title": "list", "path": "commands/auth-methods/list" }, { "title": "read", "path": "commands/auth-methods/read" }, { "title": "update", "path": "commands/auth-methods/update" } ] }, { "title": "auth-tokens", "routes": [ { "title": "Overview", "path": "commands/auth-tokens" }, { "title": "delete", "path": "commands/auth-tokens/delete" }, { "title": "list", "path": "commands/auth-tokens/list" }, { "title": "read", "path": "commands/auth-tokens/read" } ] }, { "title": "authenticate", "routes": [ { "title": "Overview", "path": "commands/authenticate" }, { "title": "ldap", "path": "commands/authenticate/ldap" }, { "title": "oidc", "path": "commands/authenticate/oidc" }, { "title": "password", "path": "commands/authenticate/password" } ] }, { "title": "billing", "routes": [ { "title": "Overview", "path": "commands/billing" }, { "title": "monthly-active-users", "path": "commands/billing/monthly-active-users" } ] }, { "title": "cache", "routes": [ { "title": "Overview", "path": "commands/cache" }, { "title": "add-token", "path": "commands/cache/add-token" }, { "title": "start", "path": "commands/cache/start" }, { "title": "status", "path": "commands/cache/status" }, { "title": "stop", "path": "commands/cache/stop" } ] }, { "title": "client-agent", "routes": [ { "title": "Overview", "path": "commands/client-agent" }, { "title": "pause", "path": "commands/client-agent/pause" }, { "title": "resume", "path": "commands/client-agent/resume" }, { "title": "sessions", "path": "commands/client-agent/sessions" }, { "title": "status", "path": "commands/client-agent/status" } ] }, { "title": "config", "routes": [ { "title": "Overview", "path": "commands/config" }, { "title": "autocomplete", "path": "commands/config/autocomplete" }, { "title": "decrypt", "path": "commands/config/decrypt" }, { "title": "encrypt", "path": "commands/config/encrypt" }, { "title": "get-token", "path": "commands/config/get-token" } ] }, { "title": "connect", "routes": [ { "title": "Overview", "path": "commands/connect" }, { "title": "cassandra", "path": "commands/connect/cassandra" }, { "title": "http", "path": "commands/connect/http" }, { "title": "kube", "path": "commands/connect/kube" }, { "title": "mysql", "path": "commands/connect/mysql" }, { "title": "mongo", "path": "commands/connect/mongo" }, { "title": "postgres", "path": "commands/connect/postgres" }, { "title": "redis", "path": "commands/connect/redis" }, { "title": "rdp", "path": "commands/connect/rdp" }, { "title": "ssh", "path": "commands/connect/ssh" } ] }, { "title": "credential-libraries", "routes": [ { "title": "Overview", "path": "commands/credential-libraries" }, { "title": "create", "path": "commands/credential-libraries/create" }, { "title": "delete", "path": "commands/credential-libraries/delete" }, { "title": "list", "path": "commands/credential-libraries/list" }, { "title": "read", "path": "commands/credential-libraries/read" }, { "title": "update", "path": "commands/credential-libraries/update" } ] }, { "title": "credential-stores", "routes": [ { "title": "Overview", "path": "commands/credential-stores" }, { "title": "create", "path": "commands/credential-stores/create" }, { "title": "delete", "path": "commands/credential-stores/delete" }, { "title": "list", "path": "commands/credential-stores/list" }, { "title": "read", "path": "commands/credential-stores/read" }, { "title": "update", "path": "commands/credential-stores/update" } ] }, { "title": "credentials", "routes": [ { "title": "Overview", "path": "commands/credentials" }, { "title": "create", "path": "commands/credentials/create" }, { "title": "delete", "path": "commands/credentials/delete" }, { "title": "list", "path": "commands/credentials/list" }, { "title": "read", "path": "commands/credentials/read" }, { "title": "update", "path": "commands/credentials/update" } ] }, { "title": "database", "routes": [ { "title": "Overview", "path": "commands/database" }, { "title": "init", "path": "commands/database/init" }, { "title": "migrate", "path": "commands/database/migrate" } ] }, { "title": "delete", "path": "commands/delete" }, { "title": "dev", "path": "commands/dev" }, { "title": "groups", "routes": [ { "title": "Overview", "path": "commands/groups" }, { "title": "add-members", "path": "commands/groups/add-members" }, { "title": "create", "path": "commands/groups/create" }, { "title": "delete", "path": "commands/groups/delete" }, { "title": "list", "path": "commands/groups/list" }, { "title": "read", "path": "commands/groups/read" }, { "title": "remove-members", "path": "commands/groups/remove-members" }, { "title": "set-members", "path": "commands/groups/set-members" }, { "title": "update", "path": "commands/groups/update" } ] }, { "title": "host-catalogs", "routes": [ { "title": "Overview", "path": "commands/host-catalogs" }, { "title": "create", "path": "commands/host-catalogs/create" }, { "title": "delete", "path": "commands/host-catalogs/delete" }, { "title": "list", "path": "commands/host-catalogs/list" }, { "title": "read", "path": "commands/host-catalogs/read" }, { "title": "update", "path": "commands/host-catalogs/update" } ] }, { "title": "host-sets", "routes": [ { "title": "Overview", "path": "commands/host-sets" }, { "title": "add-hosts", "path": "commands/host-sets/add-hosts" }, { "title": "create", "path": "commands/host-sets/create" }, { "title": "delete", "path": "commands/host-sets/delete" }, { "title": "list", "path": "commands/host-sets/list" }, { "title": "read", "path": "commands/host-sets/read" }, { "title": "remove-hosts", "path": "commands/host-sets/remove-hosts" }, { "title": "set-hosts", "path": "commands/host-sets/set-hosts" }, { "title": "update", "path": "commands/host-sets/update" } ] }, { "title": "hosts", "routes": [ { "title": "Overview", "path": "commands/hosts" }, { "title": "create", "path": "commands/hosts/create" }, { "title": "delete", "path": "commands/hosts/delete" }, { "title": "list", "path": "commands/hosts/list" }, { "title": "read", "path": "commands/hosts/read" }, { "title": "update", "path": "commands/hosts/update" } ] }, { "title": "logout", "path": "commands/logout" }, { "title": "managed-groups", "routes": [ { "title": "Overview", "path": "commands/managed-groups" }, { "title": "create", "path": "commands/managed-groups/create" }, { "title": "delete", "path": "commands/managed-groups/delete" }, { "title": "list", "path": "commands/managed-groups/list" }, { "title": "read", "path": "commands/managed-groups/read" }, { "title": "update", "path": "commands/managed-groups/update" } ] }, { "title": "policies", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" }, "routes": [ { "title": "Overview", "path": "commands/policies" }, { "title": "create", "path": "commands/policies/create" }, { "title": "delete", "path": "commands/policies/delete" }, { "title": "list", "path": "commands/policies/list" }, { "title": "read", "path": "commands/policies/read" }, { "title": "update", "path": "commands/policies/update" } ] }, { "title": "read", "path": "commands/read" }, { "title": "roles", "routes": [ { "title": "Overview", "path": "commands/roles" }, { "title": "add-grant-scopes", "path": "commands/roles/add-grant-scopes" }, { "title": "add-grants", "path": "commands/roles/add-grants" }, { "title": "add-principals", "path": "commands/roles/add-principals" }, { "title": "create", "path": "commands/roles/create" }, { "title": "delete", "path": "commands/roles/delete" }, { "title": "list", "path": "commands/roles/list" }, { "title": "read", "path": "commands/roles/read" }, { "title": "remove-grant-scopes", "path": "commands/roles/remove-grant-scopes" }, { "title": "remove-grants", "path": "commands/roles/remove-grants" }, { "title": "remove-principals", "path": "commands/roles/remove-principals" }, { "title": "set-grant-scopes", "path": "commands/roles/set-grant-scopes" }, { "title": "set-grants", "path": "commands/roles/set-grants" }, { "title": "set-principals", "path": "commands/roles/set-principals" }, { "title": "update", "path": "commands/roles/update" } ] }, { "title": "scopes", "routes": [ { "title": "Overview", "path": "commands/scopes" }, { "title": "create", "path": "commands/scopes/create" }, { "title": "delete", "path": "commands/scopes/delete" }, { "title": "destroy-key-version", "path": "commands/scopes/destroy-key-version" }, { "title": "list", "path": "commands/scopes/list" }, { "title": "list-key-version-destruction-jobs", "path": "commands/scopes/list-key-version-destruction-jobs" }, { "title": "list-keys", "path": "commands/scopes/list-keys" }, { "title": "read", "path": "commands/scopes/read" }, { "title": "rotate-keys", "path": "commands/scopes/rotate-keys" }, { "title": "update", "path": "commands/scopes/update" } ] }, { "title": "search", "path": "commands/search" }, { "title": "server", "path": "commands/server" }, { "title": "session-recordings", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" }, "routes": [ { "title": "Overview", "path": "commands/session-recordings" }, { "title": "delete", "path": "commands/session-recordings/delete" }, { "title": "download", "path": "commands/session-recordings/download" }, { "title": "list", "path": "commands/session-recordings/list" }, { "title": "read", "path": "commands/session-recordings/read" }, { "title": "reapply-storage-policy", "path": "commands/session-recordings/reapply-storage-policy" } ] }, { "title": "sessions", "routes": [ { "title": "Overview", "path": "commands/sessions" }, { "title": "cancel", "path": "commands/sessions/cancel" }, { "title": "list", "path": "commands/sessions/list" }, { "title": "read", "path": "commands/sessions/read" } ] }, { "title": "storage-buckets", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" }, "routes": [ { "title": "Overview", "path": "commands/storage-buckets" }, { "title": "create", "path": "commands/storage-buckets/create" }, { "title": "delete", "path": "commands/storage-buckets/delete" }, { "title": "list", "path": "commands/storage-buckets/list" }, { "title": "read", "path": "commands/storage-buckets/read" }, { "title": "update", "path": "commands/storage-buckets/update" } ] }, { "title": "targets", "routes": [ { "title": "Overview", "path": "commands/targets" }, { "title": "add-credential-sources", "path": "commands/targets/add-credential-sources" }, { "title": "add-host-sources", "path": "commands/targets/add-host-sources" }, { "title": "authorize-session", "path": "commands/targets/authorize-session" }, { "title": "create", "path": "commands/targets/create" }, { "title": "delete", "path": "commands/targets/delete" }, { "title": "list", "path": "commands/targets/list" }, { "title": "read", "path": "commands/targets/read" }, { "title": "remove-credential-source", "path": "commands/targets/remove-credential-sources" }, { "title": "remove-host-sources", "path": "commands/targets/remove-host-sources" }, { "title": "set-credential-sources", "path": "commands/targets/set-credential-sources" }, { "title": "set-host-sources", "path": "commands/targets/set-host-sources" }, { "title": "update", "path": "commands/targets/update" } ] }, { "title": "update", "path": "commands/update" }, { "title": "users", "routes": [ { "title": "Overview", "path": "commands/users" }, { "title": "add-accounts", "path": "commands/users/add-accounts" }, { "title": "create", "path": "commands/users/create" }, { "title": "delete", "path": "commands/users/delete" }, { "title": "list", "path": "commands/users/list" }, { "title": "read", "path": "commands/users/read" }, { "title": "remove-accounts", "path": "commands/users/remove-accounts" }, { "title": "set-accounts", "path": "commands/users/set-accounts" }, { "title": "update", "path": "commands/users/update" } ] }, { "title": "workers", "routes": [ { "title": "Overview", "path": "commands/workers" }, { "title": "add-worker-tags", "path": "commands/workers/add-worker-tags" }, { "title": "certificate-authority", "path": "commands/workers/certificate-authority" }, { "title": "create", "path": "commands/workers/create" }, { "title": "delete", "path": "commands/workers/delete" }, { "title": "list", "path": "commands/workers/list" }, { "title": "read", "path": "commands/workers/read" }, { "title": "remove-worker-tags", "path": "commands/workers/remove-worker-tags" }, { "title": "set-worker-tags", "path": "commands/workers/set-worker-tags" }, { "title": "update", "path": "commands/workers/update" } ] } ] }, { "title": "Domain model", "routes": [ { "title": "Overview", "path": "domain-model" }, { "title": "Accounts", "path": "domain-model/accounts" }, { "title": "Aliases", "path": "domain-model/aliases" }, { "title": "Auth methods", "path": "domain-model/auth-methods" }, { "title": "Credentials", "path": "domain-model/credentials" }, { "title": "Credential libraries", "path": "domain-model/credential-libraries" }, { "title": "Credential stores", "path": "domain-model/credential-stores" }, { "title": "Groups", "path": "domain-model/groups" }, { "title": "Hosts", "path": "domain-model/hosts" }, { "title": "Host catalogs", "path": "domain-model/host-catalogs" }, { "title": "Host sets", "path": "domain-model/host-sets" }, { "title": "Managed groups", "path": "domain-model/managed-groups" }, { "title": "Roles", "path": "domain-model/roles" }, { "title": "Scopes", "path": "domain-model/scopes" }, { "title": "Sessions", "path": "domain-model/sessions" }, { "title": "Session connections", "path": "domain-model/session-connections" }, { "title": "Session recordings", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" }, "path": "domain-model/session-recordings" }, { "title": "Storage buckets", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" }, "path": "domain-model/storage-buckets" }, { "title": "Storage policies", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" }, "path": "domain-model/storage-policy" }, { "title": "Targets", "path": "domain-model/targets" }, { "title": "Users", "path": "domain-model/users" } ] }, { "title": "Configuration parameters", "routes": [ { "title": "Top-level parameters", "path": "configuration" }, { "title": "Controllers", "path": "configuration/controller" }, { "title": "Events", "routes": [ { "title": "Events", "path": "configuration/events" }, { "title": "Common sink parameters", "path": "configuration/events/common-sink-parameters" }, { "title": "File sink", "path": "configuration/events/file-sink" }, { "title": "Stderr sink", "path": "configuration/events/stderr-sink" } ] }, { "title": "KMS", "routes": [ { "title": "Overview", "path": "configuration/kms" }, { "title": "AEAD", "path": "configuration/kms/aead" }, { "title": "AliCloud KMS", "path": "configuration/kms/alicloudkms" }, { "title": "AWS KMS", "path": "configuration/kms/awskms" }, { "title": "Azure Key Vault", "path": "configuration/kms/azurekeyvault" }, { "title": "GCP Cloud KMS", "path": "configuration/kms/gcpckms" }, { "title": "OCI KMS", "path": "configuration/kms/ocikms" }, { "title": "Vault transit", "path": "configuration/kms/transit" } ] }, { "title": "Listeners", "routes": [ { "title": "Overview", "path": "configuration/listeners" }, { "title": "TCP", "path": "configuration/listeners/tcp-listeners" }, { "title": "Unix", "path": "configuration/listeners/unix-listeners" } ] }, { "title": "Plugins", "path": "configuration/plugins" }, { "title": "Workers", "path": "configuration/workers" } ] }, { "title": "Filtering and listing resources", "path": "filtering" }, { "title": "Common error messages", "path": "errors" }, { "title": "Transparent sessions interoperability matrix", "badge": { "text": "HCP/ENT", "type": "outlined", "color": "neutral" }, "path": "interoperability-matrix" }, { "title": "Common workflows", "hidden": true, "routes": [ { "title": "Overview", "path": "common-workflows" }, { "title": "Manage scopes", "path": "common-workflows/manage-scopes" }, { "title": "Manage sessions", "path": "common-workflows/manage-sessions" }, { "title": "Manage targets", "path": "common-workflows/manage-targets" } ] }, { "title": "API and clients", "hidden": true, "routes": [ { "title": "Overview", "hidden": true, "path": "api-clients" }, { "title": "Desktop", "hidden": true, "path": "api-clients/desktop" } ] }, { "title": "Develop Boundary", "hidden": true, "routes": [ { "title": "Overview", "path": "developing" }, { "title": "Build Boundary", "path": "developing/building" }, { "title": "Develop the UI", "path": "developing/ui" } ] }, { "title": "Boundary Community Edition", "hidden": true, "routes": [ { "title": "Overview", "path": "community" } ] } ]