Skip to content

docs: clarify admin-only access for API tokens #295

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.

Sign up for GitHub

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

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify admin-only access for API tokens #295

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions security-and-compliance/role-based-access-control.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ Porter supports setting basic authorization permissions via for other members in
* **Developer:** read/write access to applications, jobs, environment groups, cluster data, and integrations.
* **Viewer:** read access to applications, jobs, environment groups, and cluster data.

## Managing API tokens

API tokens are restricted to **Admin** users. Only admins can create, list, view, or revoke API tokens for a project, both from the dashboard and through the Porter API. Developer and viewer roles cannot access any API token endpoints.

Note that the role assigned to a generated API token (for example, `Developer`) is independent from the role of the user creating it. The token's role controls what the token itself can do when used to call the Porter API.

## Adding Collaborators[](#adding-collaborators "Direct link to heading")

To add a new collaborator to a Porter project, you must be logged in with an **Admin** role. As an admin, you will see a **Settings** tab in the sidebar. Navigate to **Settings** and input the email of the user you would like to add. This will generate an invitation link for the user, which expires in 24 hours. The user will get an email to join the Porter project, but if the email is not delivered, you can copy the invite link and send it to them directly.
Expand Down