API Key Management documentation (#339)

bitwarden · Jan 10, 2024 · e1c5cec · e1c5cec
1 parent 45677cb
commit e1c5cec
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 7 deletions.
diff --git a/src/AdminConsole/Pages/App/Settings/_ApiKeys.cshtml b/src/AdminConsole/Pages/App/Settings/_ApiKeys.cshtml
@@ -66,8 +66,8 @@
                                 {
                                     <form method="post" asp-page-handler="UnlockApiKey">
                                         @Html.Hidden(ApiKeysModel.SelectedApiKeyIdField, apiKey.Id)
-                                        <button class="btn-warning">
-                                            <component type="typeof(UnlockIcon)" render-mode="Static" param-Class="@("h-6 w-6")"/>
+                                        <button class="btn-warning flex items-center">
+                                            <component type="typeof(UnlockIcon)" render-mode="Static" param-Class="@("h-6 w-6")"/> Unlock
                                         </button>
                                     </form>
 
@@ -76,8 +76,8 @@
                                 {
                                     <form method="post" asp-page-handler="LockApiKey">
                                         @Html.Hidden(ApiKeysModel.SelectedApiKeyIdField, apiKey.Id)
-                                        <button class="btn-warning">
-                                            <component type="typeof(LockIcon)" render-mode="Static" param-Class="@("h-6 w-6")"/>
+                                        <button class="btn-warning flex items-center">
+                                            <component type="typeof(LockIcon)" render-mode="Static" param-Class="@("h-6 w-6")"/> Lock
                                         </button>
                                     </form>
                                 }
@@ -97,6 +97,7 @@
                 </tbody>
             </table>
         </div>
+        <info-alert-box message="@((MarkupString)"To learn more about API key management, read more <a class=\"link-blue underline\" href=\"https://docs.passwordless.dev/guide/admin-console/applications.html#api-key-management\">here</a>.")"></info-alert-box>
         <info-alert-box message="To delete an API key, first lock the API key."></info-alert-box>
     </div>
 </div>
diff --git a/src/AdminConsole/Pages/_ViewImports.cshtml b/src/AdminConsole/Pages/_ViewImports.cshtml
@@ -10,4 +10,6 @@
 @using Passwordless.AdminConsole.Components.Shared.Links
 
 // Razor Pages
-@using Passwordless.AdminConsole.TagHelpers
+@using Passwordless.AdminConsole.TagHelpers
+
+@using Microsoft.AspNetCore.Components
diff --git a/src/Service/SharedManagementService.cs b/src/Service/SharedManagementService.cs
@@ -150,7 +150,7 @@ public async Task<ValidateSecretKeyDto> ValidateSecretKey(string secretKey)
             if (existingKey.IsLocked)
             {
                 _eventLogger.LogDisabledApiKeyUsedEvent(_systemClock.UtcNow.UtcDateTime, appId, new ApplicationSecretKey(secretKey));
-                throw new ApiException("ApiKey has been disabled due to account deletion in process. Please see email to reverse.", 403);
+                throw new ApiException("api_key_locked", "ApiKey has been locked.", 403);
             }
 
             if (ApiKeyUtils.Validate(existingKey.ApiKey, secretKey))
@@ -178,7 +178,7 @@ public async Task<ValidatePublicKeyDto> ValidatePublicKey(string publicKey)
             }
 
             _eventLogger.LogDisabledPublicKeyUsedEvent(_systemClock.UtcNow.UtcDateTime, appId, new ApplicationPublicKey(publicKey));
-            throw new ApiException("ApiKey has been disabled due to account deletion in process. Please see email to reverse.", 403);
+            throw new ApiException("api_key_locked", "ApiKey has been locked.", 403);
         }
 
         _eventLogger.LogInvalidPublicKeyUsedEvent(_systemClock.UtcNow.UtcDateTime, appId, new ApplicationPublicKey(publicKey));