Skip to main content

Documentation Index

Fetch the complete documentation index at: https://hypha-docs.plinqx.app/llms.txt

Use this file to discover all available pages before exploring further.

Principals represent identities in Plinqx - both human users and AI agents. Understanding principals is key to managing access and audit trails.

Principal Types

Plinqx supports four principal types:
TypeDescriptionUse Case
USERHuman users accessing the admin portalTeam members, administrators
SYSTEMSystem-level operationsBackground jobs, automated processes
INTEGRATIONExternal integrations and AI clientsAPI keys, automation tools
EXTERNAL_APPROVERExternal parties for approvalsExternal stakeholders who approve requests

Managing Principals

Creating Principals

1

Navigate to Principals

Click Principals in the sidebar (under Security or Administration).
2

Create Principal

Click Create Principal and select the type.
3

Configure

Provide:
  • Name/Email: For USER principals
  • Display Name: Human-readable identifier
  • Profile: RBAC profile assignment

Assigning Profiles

Principals are assigned RBAC profiles that determine their permissions:
  • Administrator: Full access to all features
  • Developer: Access to tools, collections, and testing
  • Viewer: Read-only access
  • Custom: Custom profiles with specific permissions
Profiles define what actions a principal can perform. See Profiles & Permissions for details.

Principal-Based Audit

All actions in Plinqx are attributed to principals:
  • Tool Executions: Tracked by principal
  • Configuration Changes: Who made the change
  • Approval Decisions: Who approved/denied
  • API Requests: Which integration made the request
Use principals to understand who or what performed actions in your audit logs.

Next Steps

Set Up Profiles

Configure RBAC profiles for principals

View Audit Logs

See principal activity in audit logs