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

Jump to bottom

Remove ui only documentation #311

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Remove ui only documentation #311

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b8e9c24
Remove ui only documentation
kevinlinxc Jun 21, 2022
8e017e5
Past tense for ui_only removal
kevinlinxc Jun 21, 2022
2194ce1
Implemented wording suggestions
kevinlinxc Jul 5, 2022
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
4 changes: 2 additions & 2 deletions api-key-scopes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,9 @@ API key scopes
Enable MFA on specific API keys
-----------------------------

If your account has MFA enabled on the **UI only** or **UI and gem signin** [authentication level](https://guides.rubygems.org/setting-up-multifactor-authentication/#authentication-levels), you have the option to enable MFA on a specific API key. This will require an OTP code for `gem push`, `yank`, `owner --add/--remove` commands.
If your account has MFA enabled on the **UI and gem signin** [authentication level](https://guides.rubygems.org/setting-up-multifactor-authentication/#authentication-levels), you have the option to enable MFA on a specific API key. This will require an OTP code for `gem push`, `yank`, `owner --add/--remove` commands.

You can toggle this option when creating or editing an API key on the UI.
You can toggle this option when creating or editing an API key on the UI.
![New API key with MFA enabled](/images/new-mfa-api-key.png){:class="t-img"}

Migration from legacy-api key
Expand Down
5 changes: 3 additions & 2 deletions setting-up-multifactor-authentication.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,12 @@ MFA for both the UI and the API. If you go to the _edit settings_ page again, in
will see a dropdown menu with three options:

- **Disabled**: disables MFA. Please delete rubygems.org account from your authenticator app after disabling.
- **UI only**: sign in from browser, updating MFA levels and resetting password will require OTP code. These are referred to as UI operations.
- **UI and gem signin**: UI operations and `gem signin` will require OTP code.
- **UI and API**: UI operations, `gem signin`, `push`, `owner --add` and `owner --remove` will require OTP code.

Note: If you are on the **UI only** or **UI and gem signin** authentication level,
**UI only** was previously a valid MFA level. However, it has been removed, and only accounts that are currently at that level will still see it in the dropdown.

Note: If you are on the **UI and gem signin** authentication level,
you can selectively enable MFA on specific API keys (see [API key scopes](http://guides.rubygems.org/api-key-scopes/#/#enable-mfa-on-specific-api-keys)).
This is different from the **UI and API** level as MFA is enabled on all API keys by default and cannot be selectively enabled.

Expand Down