Create Federation Rule
create-federation-ruleCreate a cluster federation rule that maps an external identity to a user or service account, enabling authentication and granting the configured access.
Instructions
Create a cluster rule mapping an external identity to your user or a service account. An enabled rule permits authentication and grants the configured access. Returns a rule object with its full configuration, id, organization_id, cluster_id, created_at and updated_at. Requires an organization admin using a user session or OAuth with full_access. API keys and workload tokens cannot manage federation configuration.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | ||
| cluster | Yes | ||
| enabled | Yes | Whether this rule permits workload token exchange. | |
| database | Yes | Default database for this rule; not inherited from the MCP connection. | |
| issuer_id | Yes | ||
| permission | No | ||
| description | No | ||
| organization | Yes | ||
| principal_id | Yes | Your own user ID or a service account ID in this organization. | |
| database_roles | No | ||
| principal_type | Yes | ||
| claim_conditions | Yes | ||
| allowed_audiences | Yes |