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.

Profiles define sets of permissions that can be assigned to Principals. Use profiles to implement Role-Based Access Control (RBAC) in Plinqx.

​
What are Profiles?

Profiles are collections of permissions that define what actions a Principal can perform. Instead of assigning permissions directly to each Principal, you:
  1. Create profiles with specific permission sets
  2. Assign profiles to Principals
  3. Principals inherit all permissions from their profile
Profiles make it easy to manage permissions at scale. Update a profile once, and all Principals with that profile get the update.

​
Default Profiles

Plinqx includes system profiles:

​
Administrator

  • Description: Full system access with all permissions
  • Permissions: All available permissions
  • Use Case: System administrators, tenant owners

​
Developer

  • Description: Access to tools, collections, and testing
  • Permissions: Tool management, collection management, playground access
  • Use Case: Developers building integrations

​
Viewer

  • Description: Read-only access
  • Permissions: View tools, collections, audit logs
  • Use Case: Stakeholders who need visibility
System profiles cannot be deleted or modified. You can create custom profiles for your specific needs.

​
Creating Custom Profiles

1

Navigate to Profiles

Click Profiles in the sidebar (under Administration).
2

Create Profile

Click Create Profile.
3

Configure Profile

Provide:
  • Name: Profile name (e.g., “Salesforce Admin”)
  • Description: What this profile is for
4

Assign Permissions

Select permissions to include in the profile.
5

Save

Click Save to create the profile.

​
Permission Categories

Permissions are organized by category:
  • Collections: View and manage collections
  • Tools: Manage custom tools, imported tools
  • Connections: Manage provider and MCP server connections
  • API Keys: Create and manage API keys
  • Vault: Manage credentials
  • Policies: Configure governance policies
  • Approvals: Manage approval requests
  • Audit: View audit logs
  • Team: Manage team members
  • Administration: System administration

​
Assigning Profiles to Principals

1

Open Principal

Navigate to the Principal you want to assign a profile to.
2

Assign Profile

Select a profile from the profile dropdown.
3

Save

The Principal now has all permissions from that profile.
A Principal can have one profile at a time. Changing a profile immediately updates the Principal’s permissions.

​
Editing Profiles

1

Open Profile

Click on a profile in the profiles list.
2

Edit Permissions

Add or remove permissions.
3

Save

Changes apply to all Principals with this profile.
Editing a profile affects all Principals using it. Review impact before making changes.

​
Permission Details

Each permission has:
  • Key: Internal identifier (e.g., collections:view)
  • Name: Human-readable name
  • Category: Permission category
  • Requires Admin: Whether only admins can have this permission

​
Best Practices

Principle of Least Privilege

Grant only the minimum permissions needed

Use Descriptive Names

Name profiles clearly (e.g., “Salesforce Admin”, “API Developer”)

Document Profiles

Use descriptions to explain profile purpose

Regular Reviews

Periodically review profile assignments and permissions

​
Next Steps

Manage Principals

Assign profiles to Principals

View Audit Logs

Monitor permission usage