-
Notifications
You must be signed in to change notification settings - Fork 43
docs: Add Roles and permissions page for team accounts (DOCS-481) #739
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,107 @@ | ||||||||||||||||||||||||||||||||||
| --- | ||||||||||||||||||||||||||||||||||
| title: "Roles and permissions" | ||||||||||||||||||||||||||||||||||
| sidebarTitle: "Roles and permissions" | ||||||||||||||||||||||||||||||||||
| description: "Understand Runpod's built-in team roles and use them to control what team members can do with Pods, Serverless endpoints, network volumes, and billing." | ||||||||||||||||||||||||||||||||||
| --- | ||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| Runpod team accounts use built-in roles to control what each member can access and do. Assigning roles lets an admin delegate work without granting full account control. This page is for admins who manage a team account. To create or convert a team and invite members, see [Manage accounts](/accounts-billing/manage-accounts). If you received an invitation and want to join, see [Join a team](/accounts-billing/manage-accounts#join-a-team). | ||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| ## Why use roles | ||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| Roles let you apply least privilege by granting each member the minimum role they need for their work. Use the Billing role to separate billing access from technical operations, so finance staff can manage payment methods and invoices without touching compute resources. Use the Dev role to let developers create and manage compute without exposing billing or account settings. Reserve the Admin role for trusted leads who need full control over members, settings, billing, and all compute. | ||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| ## Available roles | ||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| ### Basic role | ||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| The Basic role provides essential access for users who need to work with existing resources without management capabilities. It allows users to access the team account and connect to already-deployed resources such as [Pods](/pods/overview), [Serverless endpoints](/serverless/overview), and [Instant Clusters](/instant-clusters). Users with this role cannot view billing information, start or stop Pods, or create new resources. | ||||||||||||||||||||||||||||||||||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Basic role paragraph (can connect to existing Pods/Serverless/Instant Clusters; cannot view billing, start/stop Pods, or create resources) matches the Basic column of the base-branch permissions matrix. Source: docs/accounts-billing/manage-accounts.mdx Lines 61 to 68 in 7fc37cc
|
||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| ### Billing role | ||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| The Billing role focuses exclusively on financial management. Users with this role can access billing information, manage payment methods, and view invoices, but they cannot access compute resources. This makes the role ideal for finance staff who need billing access without operational permissions. | ||||||||||||||||||||||||||||||||||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Billing role paragraph (billing info, payment methods, invoices only, no compute access) matches the Billing column of the base-branch permissions matrix. Source: docs/accounts-billing/manage-accounts.mdx Lines 69 to 70 in 7fc37cc
|
||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| ### Dev role | ||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| The Dev role extends the Basic permissions with additional capabilities for active development work. It includes all Basic permissions plus the ability to create, start, and stop Pods and manage [network volumes](/storage/network-volumes). Instant Cluster management (creating, deleting, starting, and stopping Instant Clusters) is reserved for the Admin role. Users with this role remain restricted from billing information and account settings. | ||||||||||||||||||||||||||||||||||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Dev role paragraph (Basic + create/start/stop Pods + manage network volumes, Instant Cluster create/delete/start/stop reserved for Admin, no billing/settings) matches the Dev column of the base-branch matrix, including the Admin-only Instant Cluster row. Source: docs/accounts-billing/manage-accounts.mdx Lines 63 to 67 in 7fc37cc
|
||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| ### Admin role | ||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| The Admin role provides full control over the account. Administrators can manage team members, configure account settings, handle billing, and control all compute resources. Reserve this role for trusted leads who need full account access. | ||||||||||||||||||||||||||||||||||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Admin role paragraph (full control incl. members, settings, billing, all compute) matches the Admin column, which is checked for every row of the base-branch matrix. Source: docs/accounts-billing/manage-accounts.mdx Lines 61 to 74 in 7fc37cc
|
||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| ## Permissions matrix | ||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| The following matrix shows which permissions each role grants: | ||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| | Permission | Basic | Billing | Dev | Admin | | ||||||||||||||||||||||||||||||||||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Permissions matrix on new page is moved verbatim from the pre-existing base-branch manage-accounts.mdx matrix; verified cell-for-cell identical across all 14 permission rows and 4 roles. Source: docs/accounts-billing/manage-accounts.mdx Lines 59 to 74 in 7fc37cc
|
||||||||||||||||||||||||||||||||||
| |------------|-------|---------|-----|-------| | ||||||||||||||||||||||||||||||||||
| | Access team account | ✅ | ✅ | ✅ | ✅ | | ||||||||||||||||||||||||||||||||||
| | Connect to existing Pods | ✅ | ❌ | ✅ | ✅ | | ||||||||||||||||||||||||||||||||||
| | Create/delete/start/stop Pods | ❌ | ❌ | ✅ | ✅ | | ||||||||||||||||||||||||||||||||||
| | Create/delete Serverless endpoints | ❌ | ❌ | ✅ | ✅ | | ||||||||||||||||||||||||||||||||||
| | Send requests to Serverless endpoints | ✅ | ❌ | ✅ | ✅ | | ||||||||||||||||||||||||||||||||||
| | Connect to existing Instant Clusters | ✅ | ❌ | ✅ | ✅ | | ||||||||||||||||||||||||||||||||||
| | Create/delete/start/stop Instant Clusters | ❌ | ❌ | ❌ | ✅ | | ||||||||||||||||||||||||||||||||||
| | Create/update/delete network volumes | ❌ | ❌ | ✅ | ✅ | | ||||||||||||||||||||||||||||||||||
| | View billing information | ❌ | ✅ | ❌ | ✅ | | ||||||||||||||||||||||||||||||||||
| | Manage payment methods | ❌ | ✅ | ❌ | ✅ | | ||||||||||||||||||||||||||||||||||
| | Invite team members | ❌ | ❌ | ❌ | ✅ | | ||||||||||||||||||||||||||||||||||
| | Manage team permissions | ❌ | ❌ | ❌ | ✅ | | ||||||||||||||||||||||||||||||||||
| | Modify team account settings | ❌ | ❌ | ❌ | ✅ | | ||||||||||||||||||||||||||||||||||
| | Access audit logs | ❌ | ❌ | ❌ | ✅ | | ||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| If your assigned role does not grant access you need, contact your team's Admin to request a different role. | ||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| ## Assign a role to a team member | ||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| You assign a role when you invite a member to your team. The role you choose at invite time determines the member's permissions. | ||||||||||||||||||||||||||||||||||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Invite/assign-role Steps block (Team page > Members > Invite New Member > choose role > enter email > Create Invite > copy link from Pending Invites) matches the pre-existing documented invite flow verbatim. Source: docs/accounts-billing/manage-accounts.mdx Lines 38 to 42 in 7fc37cc
|
||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| <Steps> | ||||||||||||||||||||||||||||||||||
| <Step title="Open the Team page"> | ||||||||||||||||||||||||||||||||||
| Navigate to the [Team page](https://www.console.runpod.io/team) in the Runpod console. | ||||||||||||||||||||||||||||||||||
| </Step> | ||||||||||||||||||||||||||||||||||
| <Step title="Start a new invite"> | ||||||||||||||||||||||||||||||||||
| In the **Members** section, select **Invite New Member**. | ||||||||||||||||||||||||||||||||||
| </Step> | ||||||||||||||||||||||||||||||||||
| <Step title="Choose the role"> | ||||||||||||||||||||||||||||||||||
| Choose the appropriate role for the new member. This role determines what the member can access and do. | ||||||||||||||||||||||||||||||||||
| </Step> | ||||||||||||||||||||||||||||||||||
| <Step title="Enter the member's email"> | ||||||||||||||||||||||||||||||||||
| Enter the email address of the person you want to invite and select **Create Invite**. | ||||||||||||||||||||||||||||||||||
| </Step> | ||||||||||||||||||||||||||||||||||
| <Step title="Share the invitation link"> | ||||||||||||||||||||||||||||||||||
| Copy the generated invitation link from the **Pending Invites** section and share it with the person you want to invite. | ||||||||||||||||||||||||||||||||||
| </Step> | ||||||||||||||||||||||||||||||||||
| </Steps> | ||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "Invitation links remain active until used or manually revoked" is carried over verbatim from the pre-existing manage-accounts.mdx text. Source: docs/accounts-billing/manage-accounts.mdx Line 44 in 7fc37cc
|
||||||||||||||||||||||||||||||||||
| <Note> | ||||||||||||||||||||||||||||||||||
| Invitation links remain active until used or manually revoked. | ||||||||||||||||||||||||||||||||||
| </Note> | ||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| ## Remove access | ||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| You can revoke a pending invitation from the **Pending Invites** section before it is used. As part of general offboarding, review team membership regularly and revoke access that is no longer needed. | ||||||||||||||||||||||||||||||||||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "Dissolve an entire team and revert to a personal account" links to #convert-to-a-team-account, which documents the Delete Team button described in the pre-existing base Note. Source: docs/accounts-billing/manage-accounts.mdx Lines 24 to 28 in 7fc37cc
|
||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| To dissolve an entire team and revert to a personal account, see [Manage accounts](/accounts-billing/manage-accounts#convert-to-a-team-account). | ||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| ## Best practices | ||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| Assign roles based on each member's responsibilities, and apply the principle of least privilege by granting the minimum role necessary for each person's work. Isolate billing access from technical operations by using the Billing role for finance staff. | ||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| Review team membership regularly and remove access for members who no longer need it. Review audit logs periodically to ensure compliance with your organization's policies and to identify unusual activity early. | ||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| ## Next steps | ||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| <CardGroup cols={2}> | ||||||||||||||||||||||||||||||||||
| <Card title="Manage accounts" href="/accounts-billing/manage-accounts" icon="users" horizontal> | ||||||||||||||||||||||||||||||||||
| Create or convert a team and invite members. | ||||||||||||||||||||||||||||||||||
| </Card> | ||||||||||||||||||||||||||||||||||
| <Card title="Billing" href="/accounts-billing/billing" icon="credit-card" horizontal> | ||||||||||||||||||||||||||||||||||
| Set up billing and payment methods. | ||||||||||||||||||||||||||||||||||
| </Card> | ||||||||||||||||||||||||||||||||||
| <Card title="Monitor account activity" href="/accounts-billing/manage-accounts#monitor-account-activity" icon="list-check" horizontal> | ||||||||||||||||||||||||||||||||||
| Review audit logs to track actions across your team. | ||||||||||||||||||||||||||||||||||
| </Card> | ||||||||||||||||||||||||||||||||||
| <Card title="Cost centers" href="/accounts-billing/cost-centers" icon="chart-pie" horizontal> | ||||||||||||||||||||||||||||||||||
| Attribute team spend by project or team. | ||||||||||||||||||||||||||||||||||
| </Card> | ||||||||||||||||||||||||||||||||||
| </CardGroup> | ||||||||||||||||||||||||||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Trimmed "four built-in roles (Basic, Billing, Dev, Admin)" summary matches the pre-existing "four distinct roles" claim; no new role model introduced.
Source:
docs/accounts-billing/manage-accounts.mdx
Line 57 in 7fc37cc