Skip to content
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

ug: faq: add troubleshooting for user permissions #716

Merged
merged 1 commit into from
Jun 19, 2024
Merged

ug: faq: add troubleshooting for user permissions #716

Show file tree
Hide file tree
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
3 changes: 3 additions & 0 deletions source/user-guide/account-management/team-based-access.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,3 +149,6 @@ With Fioctl® v0.35 and newer, if someone makes changes to TUF root, others will
This is to prevent accidental eraser of the TUF keys ownership information.


.. seealso::
:ref:`ref-troubleshooting_user-permissions`

41 changes: 41 additions & 0 deletions source/user-guide/troubleshooting/troubleshooting.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -634,6 +634,47 @@
/ # apk add curl
/ # curl

.. _ref-troubleshooting_user-permissions:

Debugging User Permissions
^^^^^^^^^^^^^^^^^^^^^^^^^^

If the Factory has :ref:`Teams <ref-team-based-access>` defined, user permissions are defined by the teams they are part of.

This shows steps to help troubleshooting unexpected permission problems.

* Get user ID:

.. prompt::

$ fioctl users

* Get user information:

.. prompt::

$ fioctl users <ID>
ID NAME ROLE
-- ---- ----
XXXXXXXXXXXXXXXXXXXXXXXX User Name User Role

TEAMS
-----

EFFECTIVE SCOPES
----------------

This returns the combination of scopes allowed to this particular user based on their teams.

If this does not have the expected scopes, the Factory Owner/Admin may need to add the user to a proper Team with the wanted scopes.

Check warning on line 669 in source/user-guide/troubleshooting/troubleshooting.rst

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Fio-docs.sentence-length] Aim for sentences no longer than 25 words

Raw Output:
{"message": "[Fio-docs.sentence-length] Aim for sentences no longer than 25 words", "location": {"path": "source/user-guide/troubleshooting/troubleshooting.rst", "range": {"start": {"line": 669, "column": 1}}}, "severity": "INFO"}

* If this returns the expected scopes, verify if the proper scopes are also set for the private token set at https://app.foundries.io/settings/credentials/.

.. tip::

It is possible to add scopes for an existing token.
After editing a token, refresh the fioctl access with ``fioctl login --refresh-access-token``.

Updates To etc
^^^^^^^^^^^^^^

Expand Down
Loading