Roles and Permissions
How Roles and Permissions works in Paycux, what it is for, and the smallest setup that gets it running.
Introduction
Roles and Permissions is part of the Paycux platform. This page explains what it does, when to reach for it, and the smallest working setup you can ship.
Everything below applies to both environments. Build and test in staging, then promote the same configuration to production without changing your code — only the API key and client ID differ.
Standalone roles
Roles are defined once per project and assigned per organization membership, so the same person can be an admin in one organization and a viewer in another.
Check permissions on the server, in the request path, using the permission slug rather than the role name. Role names change; slugs are stable.
Utilizing permissions with roles
Utilizing permissions with roles controls what the credential is allowed to do. Grant the narrowest set that lets the integration work, and widen it deliberately.
Scopes are evaluated at the API boundary, so an over-broad token is a real risk even if your own code never uses the extra capability.
Configure roles and permissions
Configure roles and permissions controls what the credential is allowed to do. Grant the narrowest set that lets the integration work, and widen it deliberately.
Scopes are evaluated at the API boundary, so an over-broad token is a real risk even if your own code never uses the extra capability.
Create permissions
Create permissions controls what the credential is allowed to do. Grant the narrowest set that lets the integration work, and widen it deliberately.
Scopes are evaluated at the API boundary, so an over-broad token is a real risk even if your own code never uses the extra capability.
Assign permissions to roles
Assign the users and groups who should have access. Anyone outside the assignment is rejected at the provider, before the request reaches Paycux.
Group names sync as-is. If you use groups to drive roles in your application, map them once in the dashboard under Authorization rather than branching on group names in code.
Default role
Default role applies specifically to Roles and Permissions. It behaves the same in both environments, and the values it depends on are visible in the dashboard for the environment you have selected.
If the behaviour you see does not match this description, check which environment your API key belongs to before anything else — a staging key against production data is the most common cause.
Assign roles
Assign roles applies specifically to Roles and Permissions. It behaves the same in both environments, and the values it depends on are visible in the dashboard for the environment you have selected.
If the behaviour you see does not match this description, check which environment your API key belongs to before anything else — a staging key against production data is the most common cause.