diff --git a/.github/markdownlint/.markdownlint-cli2.yaml b/.github/markdownlint/.markdownlint-cli2.yaml index 2d3ef15f0..1a9790d3c 100644 --- a/.github/markdownlint/.markdownlint-cli2.yaml +++ b/.github/markdownlint/.markdownlint-cli2.yaml @@ -259,6 +259,7 @@ config: example_from: "After installing the Gateway, verify the container status." example_to: "After deploying the Gateway, verify the container status." + - term: "once installed, the Gateway" replacement: "once deployed, the Gateway" example_from: "Once installed, the Gateway can serve requests." @@ -595,6 +596,12 @@ config: example_from: "These vendors try to gyp customers." example_to: "These vendors try to cheat customers." + # Slash-separated compound verbs + - term: "copy/paste" + replacement: "copy and paste" + example_from: "copy/paste the token into the field" + example_to: "copy and paste the token into the field" + # AKY018: Require canonical Markdown table separator rows # # Purpose: diff --git a/.other/redirects-backup.txt b/.other/redirects-backup.txt index 2410879f6..749ba4745 100644 --- a/.other/redirects-backup.txt +++ b/.other/redirects-backup.txt @@ -1,6 +1,9 @@ /docs/kubernetes -> /docs/kubernetes-plugins -/docs/password-manager -> /docs/password-manager-overview -/docs/browser-extensions -> /docs/password-manager-web-extension +/docs/pwm-ext-add-password-to-favorites -> /docs/pwm-ext-managing-favorites +/docs/pwm-console-security-health -> /docs/pwm-security-health +/docs/pwm-ext-security-health -> /docs/pwm-security-health +/docs/password-manager -> /docs/pwm-overview +/docs/browser-extensions -> /docs/pwm-ext-overview /docs/using-environment-variables -> /docs/gateway-docker-advanced-configuration /v2/docs/using-environment-variables -> /docs/gateway-docker-advanced-configuration /docs/advance-gw-docker-configuration -> /docs/gateway-docker-advanced-configuration @@ -258,6 +261,8 @@ /v2/docs/upgrading-to-the-new-gateway-with-remote-access -> /docs/sra-setup-k8s /docs/cloud -> /docs/venafi-cloud /v2/docs/cloud -> /docs/venafi-cloud +/docs/pwm-mobile-setting-password-policy-on-password-level -> /docs/pwm-mobile-setting-password-policy-on-account-level +/v2/docs/pwm-mobile-setting-password-policy-on-password-level -> /docs/pwm-mobile-setting-password-policy-on-account-level /docs/globalsign-atlas-target-copy -> /docs/venafi-target /v2/docs/globalsign-atlas-target-copy -> /docs/venafi-target /docs/tpp -> /docs/venafi-tpp @@ -576,7 +581,7 @@ /reference/getsecretvalue-1 -> /reference/getsecretvalue /reference/gatewaydeleteallowedmanagementaccess -> /reference/deletegatewayallowedaccessid /recipes/python-aws_iam -> /docs/what-is-akeyless -/docs/hide-personal-folder -> /docs/password-manager-hide-personal-folder +/docs/hide-personal-folder -> /docs/pwm-console-hide-personal-folder /docs/opened -> /docs/auth-with-oidc /docs/ping-targets -> /docs/ping-target /docs/configuring-tls -> /docs/gateway-tls-settings @@ -593,7 +598,7 @@ /docs/web-access-on-k8s-advanced-configuration -> /docs/sra-web-access-on-k8s-adv-config /docs/remote-access-system-requirements -> /docs/sra-overview /docs/ansible-awx-plugin-secret-fetch-via-playbook-1 -> /docs/ansible-awx-plugin -/docs/configure-1 -> /docs/configure-ldap-gateway-url-1 +/docs/configure-1 -> /docs/pwm-ext-configure-ldap-gateway-url /docs/customer-journey-scenarios-real-world-use-case-flows -> /docs/customer-journeys /docs/customer-use-case-access-request-via-sn -> /docs/access-requests-with-sn /docs/email -> /docs/auth-with-email @@ -835,3 +840,185 @@ /v2/docs/remote-access-desktop-application-beta -> /docs/sra-desktop-application-beta /docs/copy-of-remote-access-on-k8s -> /docs/sra-setup-k8s /v2/docs/copy-of-remote-access-on-k8s -> /docs/sra-setup-k8s +/docs/adding-and-using-otp -> /docs/pwm-mobile-otp +/docs/adding-and-using-otp-1 -> /docs/pwm-ext-otp +/docs/adding-manual-otp -> /docs/pwm-ext-add-manual-otp +/docs/adding-manual-otp-1 -> /docs/pwm-mobile-add-manual-otp +/docs/adding-password-to-favorites-1 -> /docs/pwm-ext-add-password-to-favorites +/docs/advanced-options -> /docs/pwm-ext-advanced-options +/docs/choosing-password-locationfolder -> /docs/pwm-mobile-choose-password-location-folder +/docs/configure-customspecific-tenant -> /docs/pwm-ext-configure-custom-specific-tenant +/docs/configure-customspecific-tenant-1 -> /docs/pwm-mobile-configure-custom-specific-tenant +/docs/configure-ldap-gateway-url -> /docs/pwm-mobile-configure-ldap-gateway-url +/docs/configure-ldap-gateway-url-1 -> /docs/pwm-ext-configure-ldap-gateway-url +/docs/copypaste-functionality-for-passwords -> /docs/pwm-mobile-copy-and-paste-passwords +/docs/copypaste-functionality-for-passwords-1 -> /docs/pwm-ext-copy-and-paste-passwords +/docs/creating-new-password -> /docs/pwm-mobile-create-password +/docs/creating-new-password-1 -> /docs/pwm-ext-create-password +/docs/creating-new-secret -> /docs/pwm-ext-create-secret +/docs/creating-new-secret-1 -> /docs/pwm-mobile-create-static-secret +/docs/creating-new-secret-2 -> /docs/pwm-mobile-create-static-secret +/docs/creating-new-secret-value-type -> /docs/pwm-ext-create-secret-value-type +/docs/creating-new-secret-value-type-1 -> /docs/pwm-mobile-create-static-secret +/docs/creating-new-secret-value-type-2 -> /docs/pwm-mobile-create-static-secret +/docs/csv-password-importer -> /docs/pwm-ext-csv-password-importer +/docs/deleting-password -> /docs/pwm-mobile-deleting-password +/docs/deleting-password-1 -> /docs/pwm-ext-deleting-password +/docs/editing-password-details -> /docs/pwm-mobile-editing-password-details +/docs/editing-password-details-1 -> /docs/pwm-ext-editing-password-details +/docs/enterprise-distribution-preconfigured-authentication -> /docs/pwm-ext-enterprise-distribution-preconfigured-authentication +/docs/favorites-add-remove-and-view-items -> /docs/pwm-mobile-manage-favorites +/docs/folder-navigation-within-personal-corporate-areas-1 -> /docs/pwm-ext-folder-navigation-within-personal-corporate-areas +/docs/for-ios-devices -> /docs/pwm-mobile-autofill-and-password-injection +/docs/home-screen-frequently-used-items -> /docs/pwm-mobile-home-screen-frequently-used-items +/docs/installation-of-akeyless-mobile-application -> /docs/pwm-mobile-install-and-sign-in +/docs/installation-of-akeyless-web-extension -> /docs/pwm-ext-install-and-sign-in +/docs/passkey -> /docs/pwm-ext-passkey +/docs/password-list-switching-between-folders-flat-view -> /docs/pwm-mobile-switch-between-folder-and-flat-views +/docs/password-list-switching-between-folders-flat-view-1 -> /docs/pwm-ext-switch-between-folder-and-flat-views +/docs/password-manager-hide-personal-folder -> /docs/pwm-console-hide-personal-folder +/docs/password-manager-mobile-application -> /docs/pwm-mobile-overview +/docs/password-manager-overview -> /docs/pwm-overview +/docs/password-manager-usage-report-for-admins -> /docs/pwm-console-admin-usage-report +/docs/password-manager-web-console -> /docs/pwm-console-overview +/docs/password-manager-web-console-for-admin -> /docs/pwm-console-admin-overview +/docs/password-manager-web-console-for-employees -> /docs/pwm-console-non-admin-overview +/docs/password-manager-web-extension -> /docs/pwm-ext-overview +/docs/personal-corporate-favorites-areas-navigation -> /docs/pwm-ext-navigate-personal-corporate-favorites +/docs/security-health -> /docs/pwm-console-security-health +/docs/security-health-1 -> /docs/pwm-ext-security-health +/docs/set-autofill-for-android-devices -> /docs/pwm-mobile-autofill-and-password-injection +/docs/setting-password-policy-on-account-level -> /docs/pwm-mobile-setting-password-policy-on-account-level +/docs/setting-password-policy-on-account-level-1 -> /docs/pwm-ext-setting-password-policy-on-account-level +/docs/setting-password-policy-on-password-level -> /docs/pwm-mobile-setting-password-policy-on-account-level +/docs/setting-password-policy-on-password-level-1 -> /docs/pwm-ext-setting-password-policy-on-account-level +/docs/sharing-password -> /docs/pwm-mobile-sharing-password +/docs/sharing-password-1 -> /docs/pwm-ext-sharing-password +/docs/using-autofill-and-password-injection-functionality -> /docs/pwm-mobile-autofill-and-password-injection +/docs/using-autofillpassword-injection-functionality-1 -> /docs/pwm-ext-autofill-and-password-injection +/docs/using-filters-tags -> /docs/pwm-ext-use-filters-and-tags +/docs/using-search -> /docs/pwm-ext-search-passwords-and-secrets +/v2/docs/adding-and-using-otp -> /docs/pwm-mobile-otp +/v2/docs/adding-and-using-otp-1 -> /docs/pwm-ext-otp +/v2/docs/adding-manual-otp -> /docs/pwm-ext-add-manual-otp +/v2/docs/adding-manual-otp-1 -> /docs/pwm-mobile-add-manual-otp +/v2/docs/adding-password-to-favorites-1 -> /docs/pwm-ext-add-password-to-favorites +/v2/docs/advanced-options -> /docs/pwm-ext-advanced-options +/v2/docs/choosing-password-locationfolder -> /docs/pwm-mobile-choose-password-location-folder +/v2/docs/configure-customspecific-tenant -> /docs/pwm-ext-configure-custom-specific-tenant +/v2/docs/configure-customspecific-tenant-1 -> /docs/pwm-mobile-configure-custom-specific-tenant +/v2/docs/configure-ldap-gateway-url -> /docs/pwm-mobile-configure-ldap-gateway-url +/v2/docs/configure-ldap-gateway-url-1 -> /docs/pwm-ext-configure-ldap-gateway-url +/v2/docs/copypaste-functionality-for-passwords -> /docs/pwm-mobile-copy-and-paste-passwords +/v2/docs/copypaste-functionality-for-passwords-1 -> /docs/pwm-ext-copy-and-paste-passwords +/v2/docs/creating-new-password -> /docs/pwm-mobile-create-password +/v2/docs/creating-new-password-1 -> /docs/pwm-ext-create-password +/v2/docs/creating-new-secret -> /docs/pwm-ext-create-secret +/v2/docs/creating-new-secret-1 -> /docs/pwm-mobile-create-static-secret +/v2/docs/creating-new-secret-2 -> /docs/pwm-mobile-create-static-secret +/v2/docs/creating-new-secret-value-type -> /docs/pwm-ext-create-secret-value-type +/v2/docs/creating-new-secret-value-type-1 -> /docs/pwm-mobile-create-static-secret +/v2/docs/creating-new-secret-value-type-2 -> /docs/pwm-mobile-create-static-secret +/v2/docs/csv-password-importer -> /docs/pwm-ext-csv-password-importer +/v2/docs/deleting-password -> /docs/pwm-mobile-deleting-password +/v2/docs/deleting-password-1 -> /docs/pwm-ext-deleting-password +/v2/docs/editing-password-details -> /docs/pwm-mobile-editing-password-details +/v2/docs/editing-password-details-1 -> /docs/pwm-ext-editing-password-details +/v2/docs/enterprise-distribution-preconfigured-authentication -> /docs/pwm-ext-enterprise-distribution-preconfigured-authentication +/v2/docs/favorites-add-remove-and-view-items -> /docs/pwm-mobile-manage-favorites +/v2/docs/folder-navigation-within-personal-corporate-areas-1 -> /docs/pwm-ext-folder-navigation-within-personal-corporate-areas +/v2/docs/for-ios-devices -> /docs/pwm-mobile-autofill-and-password-injection +/v2/docs/home-screen-frequently-used-items -> /docs/pwm-mobile-home-screen-frequently-used-items +/v2/docs/installation-of-akeyless-mobile-application -> /docs/pwm-mobile-install-and-sign-in +/v2/docs/installation-of-akeyless-web-extension -> /docs/pwm-ext-install-and-sign-in +/v2/docs/passkey -> /docs/pwm-ext-passkey +/v2/docs/password-list-switching-between-folders-flat-view -> /docs/pwm-mobile-switch-between-folder-and-flat-views +/v2/docs/password-list-switching-between-folders-flat-view-1 -> /docs/pwm-ext-switch-between-folder-and-flat-views +/v2/docs/password-manager-hide-personal-folder -> /docs/pwm-console-hide-personal-folder +/v2/docs/password-manager-mobile-application -> /docs/pwm-mobile-overview +/v2/docs/password-manager-overview -> /docs/pwm-overview +/v2/docs/password-manager-usage-report-for-admins -> /docs/pwm-console-admin-usage-report +/v2/docs/password-manager-web-console -> /docs/pwm-console-overview +/v2/docs/password-manager-web-console-for-admin -> /docs/pwm-console-admin-overview +/v2/docs/password-manager-web-console-for-employees -> /docs/pwm-console-non-admin-overview +/v2/docs/password-manager-web-extension -> /docs/pwm-ext-overview +/v2/docs/personal-corporate-favorites-areas-navigation -> /docs/pwm-ext-navigate-personal-corporate-favorites +/v2/docs/security-health -> /docs/pwm-console-security-health +/v2/docs/security-health-1 -> /docs/pwm-ext-security-health +/v2/docs/set-autofill-for-android-devices -> /docs/pwm-mobile-autofill-and-password-injection +/v2/docs/setting-password-policy-on-account-level -> /docs/pwm-mobile-setting-password-policy-on-account-level +/v2/docs/setting-password-policy-on-account-level-1 -> /docs/pwm-ext-setting-password-policy-on-account-level +/v2/docs/setting-password-policy-on-password-level -> /docs/pwm-mobile-setting-password-policy-on-account-level +/v2/docs/setting-password-policy-on-password-level-1 -> /docs/pwm-ext-setting-password-policy-on-account-level +/v2/docs/sharing-password -> /docs/pwm-mobile-sharing-password +/v2/docs/sharing-password-1 -> /docs/pwm-ext-sharing-password +/v2/docs/using-autofill-and-password-injection-functionality -> /docs/pwm-mobile-autofill-and-password-injection +/v2/docs/using-autofillpassword-injection-functionality-1 -> /docs/pwm-ext-autofill-and-password-injection +/v2/docs/using-filters-tags -> /docs/pwm-ext-use-filters-and-tags +/v2/docs/using-search -> /docs/pwm-ext-search-passwords-and-secrets + +# PWM filename migration +/docs/adding-manual-otp -> /docs/pwm-mobile-add-manual-otp +/docs/adding-password-to-favorites -> /docs/pwm-ext-add-password-to-favorites +/docs/choosing-password-location-folder -> /docs/pwm-mobile-choose-password-location-folder +/docs/configure-custom-specific-tenant -> /docs/pwm-ext-configure-custom-specific-tenant +/docs/configure-custom-specific-tenant -> /docs/pwm-mobile-configure-custom-specific-tenant +/docs/configure-ldap-gateway-url -> /docs/pwm-ext-configure-ldap-gateway-url +/docs/copy-paste-functionality-for-passwords -> /docs/pwm-ext-copy-and-paste-passwords +/docs/copy-paste-functionality-for-passwords -> /docs/pwm-mobile-copy-and-paste-passwords +/docs/creating-new-password -> /docs/pwm-ext-create-password +/docs/creating-new-secret-value-type -> /docs/pwm-mobile-create-static-secret +/docs/creating-new-static-secret-value-type -> /docs/pwm-mobile-create-static-secret +/docs/deleting-password -> /docs/pwm-ext-deleting-password +/docs/editing-password-details -> /docs/pwm-ext-editing-password-details +/docs/folder-navigation-within-personal-corporate-areas -> /docs/pwm-ext-folder-navigation-within-personal-corporate-areas +/docs/index -> /docs/pwm-console-admin-overview +/docs/index -> /docs/pwm-console-overview +/docs/index -> /docs/pwm-ext-create-secret +/docs/index -> /docs/pwm-ext-otp +/docs/index -> /docs/pwm-ext-overview +/docs/index -> /docs/pwm-mobile-autofill-and-password-injection +/docs/index -> /docs/pwm-mobile-create-static-secret +/docs/index -> /docs/pwm-mobile-create-static-secret +/docs/index -> /docs/pwm-mobile-otp +/docs/index -> /docs/pwm-mobile-overview +/docs/password-list-switching-between-folders-flat-view -> /docs/pwm-ext-switch-between-folder-and-flat-views +/docs/security-health -> /docs/pwm-ext-security-health +/docs/setting-password-policy-on-account-level -> /docs/pwm-ext-setting-password-policy-on-account-level +/docs/setting-password-policy-on-password-level -> /docs/pwm-ext-setting-password-policy-on-account-level +/docs/sharing-password -> /docs/pwm-ext-sharing-password +/docs/using-autofill-and-password-injection-functionality -> /docs/pwm-ext-autofill-and-password-injection +/v2/docs/adding-manual-otp -> /docs/pwm-mobile-add-manual-otp +/v2/docs/adding-password-to-favorites -> /docs/pwm-ext-add-password-to-favorites +/v2/docs/choosing-password-location-folder -> /docs/pwm-mobile-choose-password-location-folder +/v2/docs/configure-custom-specific-tenant -> /docs/pwm-ext-configure-custom-specific-tenant +/v2/docs/configure-custom-specific-tenant -> /docs/pwm-mobile-configure-custom-specific-tenant +/v2/docs/configure-ldap-gateway-url -> /docs/pwm-ext-configure-ldap-gateway-url +/v2/docs/copy-paste-functionality-for-passwords -> /docs/pwm-ext-copy-and-paste-passwords +/v2/docs/copy-paste-functionality-for-passwords -> /docs/pwm-mobile-copy-and-paste-passwords +/v2/docs/creating-new-password -> /docs/pwm-ext-create-password +/v2/docs/creating-new-secret-value-type -> /docs/pwm-mobile-create-static-secret +/v2/docs/creating-new-static-secret-value-type -> /docs/pwm-mobile-create-static-secret +/v2/docs/deleting-password -> /docs/pwm-ext-deleting-password +/v2/docs/editing-password-details -> /docs/pwm-ext-editing-password-details +/v2/docs/folder-navigation-within-personal-corporate-areas -> /docs/pwm-ext-folder-navigation-within-personal-corporate-areas +/v2/docs/index -> /docs/pwm-console-admin-overview +/v2/docs/index -> /docs/pwm-console-overview +/v2/docs/index -> /docs/pwm-ext-create-secret +/v2/docs/index -> /docs/pwm-ext-otp +/v2/docs/index -> /docs/pwm-ext-overview +/v2/docs/index -> /docs/pwm-mobile-autofill-and-password-injection +/v2/docs/index -> /docs/pwm-mobile-create-static-secret +/v2/docs/index -> /docs/pwm-mobile-create-static-secret +/v2/docs/index -> /docs/pwm-mobile-otp +/v2/docs/index -> /docs/pwm-mobile-overview +/v2/docs/password-list-switching-between-folders-flat-view -> /docs/pwm-ext-switch-between-folder-and-flat-views +/v2/docs/security-health -> /docs/pwm-ext-security-health +/v2/docs/setting-password-policy-on-account-level -> /docs/pwm-ext-setting-password-policy-on-account-level +/v2/docs/setting-password-policy-on-password-level -> /docs/pwm-ext-setting-password-policy-on-account-level +/v2/docs/sharing-password -> /docs/pwm-ext-sharing-password +/v2/docs/using-autofill-and-password-injection-functionality -> /docs/pwm-ext-autofill-and-password-injection +/docs/pwm-ext-otp-overview -> /docs/pwm-ext-otp +/v2/docs/pwm-ext-otp-overview -> /docs/pwm-ext-otp +/docs/pwm-mobile-otp-overview -> /docs/pwm-mobile-otp +/v2/docs/pwm-mobile-otp-overview -> /docs/pwm-mobile-otp diff --git a/docs/Password Manager/_order.yaml b/docs/Password Manager/_order.yaml index ee2a3357e..73510d925 100644 --- a/docs/Password Manager/_order.yaml +++ b/docs/Password Manager/_order.yaml @@ -1,4 +1,5 @@ - password-manager-overview +- pwm-security-health - password-manager-mobile-application - password-manager-web-console - password-manager-web-extension diff --git a/docs/Password Manager/password-manager-mobile-application/_order.yaml b/docs/Password Manager/password-manager-mobile-application/_order.yaml index 75c7c1894..9450ed361 100644 --- a/docs/Password Manager/password-manager-mobile-application/_order.yaml +++ b/docs/Password Manager/password-manager-mobile-application/_order.yaml @@ -1,18 +1,17 @@ -- installation-of-akeyless-mobile-application -- creating-new-password -- choosing-password-locationfolder -- editing-password-details -- setting-password-policy-on-account-level -- setting-password-policy-on-password-level -- sharing-password -- deleting-password -- password-list-switching-between-folders-flat-view -- using-autofill-and-password-injection-functionality -- copypaste-functionality-for-passwords -- configure-ldap-gateway-url -- configure-customspecific-tenant-1 -- creating-new-secret-1 -- favorites-add-remove-and-view-items -- home-screen-frequently-used-items -- creating-new-secret-2 -- adding-and-using-otp +- pwm-mobile-overview +- pwm-mobile-install-and-sign-in +- pwm-mobile-configure-custom-specific-tenant +- pwm-mobile-configure-ldap-gateway-url +- pwm-mobile-setting-password-policy-on-account-level +- pwm-mobile-choose-password-location-folder +- pwm-mobile-switch-between-folder-and-flat-views +- pwm-mobile-manage-favorites +- pwm-mobile-home-screen-frequently-used-items +- pwm-mobile-create-password +- pwm-mobile-editing-password-details +- pwm-mobile-sharing-password +- pwm-mobile-deleting-password +- pwm-mobile-copy-and-paste-passwords +- pwm-mobile-create-static-secret +- pwm-mobile-autofill-and-password-injection +- pwm-mobile-otp diff --git a/docs/Password Manager/password-manager-mobile-application/adding-and-using-otp/_order.yaml b/docs/Password Manager/password-manager-mobile-application/adding-and-using-otp/_order.yaml deleted file mode 100644 index 943ac1857..000000000 --- a/docs/Password Manager/password-manager-mobile-application/adding-and-using-otp/_order.yaml +++ /dev/null @@ -1 +0,0 @@ -- adding-manual-otp-1 diff --git a/docs/Password Manager/password-manager-mobile-application/adding-and-using-otp/adding-manual-otp-1.md b/docs/Password Manager/password-manager-mobile-application/adding-and-using-otp/adding-manual-otp-1.md deleted file mode 100644 index be1ac24fe..000000000 --- a/docs/Password Manager/password-manager-mobile-application/adding-and-using-otp/adding-manual-otp-1.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Adding Manual OTP -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -Users often receive OTP Auth secrets as strings instead of complete QR codes or full OTP Auth links. This feature allows users to manually input these secrets into the Password Manager mobile app, where they will be decoded and integrated as functional OTP authentication methods. - -## Accessing the Feature - -Navigate to the Secrets Section: Open the Password Manager mobile app and navigate to the 'Secrets' section, where your passwords are stored. - -Open the Menu: Tap on the three-dot icon next to the desired account, such as GitLab, to open the options menu. - -Select "Manual OTP": From the menu, select the "Manual OTP" option to manually input an OTP secret. (Visible in the second screenshot.) - -## Entering OTPAuth Secret - -Password Edit Screen: After selecting "Manual OTP," you’ll be redirected to the password edit screen, as shown in the first screenshot. - -Custom Field Creation: Scroll down to the "Custom Field" section where a new custom field can be added. - -Field Name: The field name should be labeled `otpauth` for OTP-based secrets. - -Input Secret: Enter the OTPAuth secret string into the "Field Name Value" box (as shown in the first screenshot). Once entered, it will be stored and ready to use for authentication. - -![Illustration for: Input Secret: Enter the OTPAuth secret string into the "Field Name Value" box (as shown in the first screenshot). Once entered, it will be stored and ready to use for…](https://files.readme.io/31a69fb27196aa64ab36b2f9023c35cd3ed646c1c88e90f01b21c371a3274e49-Screenshot_2024-10-07_at_11.55.12.png) - -![Illustration for: Input Secret: Enter the OTPAuth secret string into the "Field Name Value" box (as shown in the first screenshot). Once entered, it will be stored and ready to use for…](https://files.readme.io/482c2db0fdfdf2a6dbed1c834403f289e5412806f56bcaf335ba380a8390c6b6-Screenshot_2024-10-07_at_11.55.12.png) - -![Illustration for: Input Secret: Enter the OTPAuth secret string into the "Field Name Value" box (as shown in the first screenshot). Once entered, it will be stored and ready to use for…](https://files.readme.io/668b604f63d6a4ef43ccc0effbffd40583bfc5268b50e2c6d96c2e4970f6eaef-Screenshot_2024-10-07_at_11.55.19.png) diff --git a/docs/Password Manager/password-manager-mobile-application/adding-and-using-otp/index.md b/docs/Password Manager/password-manager-mobile-application/adding-and-using-otp/index.md deleted file mode 100644 index 61c07739d..000000000 --- a/docs/Password Manager/password-manager-mobile-application/adding-and-using-otp/index.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Adding and Using OTP -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -Locate the Password: Navigate to the corporate or personal area where the desired password is stored. - -Open Options Menu: Tap the three dots button next to the password entry to open the options menu. - -![Illustration for: Locate the Password: Navigate to the corporate or personal area where the desired password is stored. Open Options Menu: Tap the three dots button next to the password entry to…](https://files.readme.io/6da4508-Screenshot_2024-06-16_at_11.17.19.png) - -Prepare OTP for Scanning: Ensure that the OTP (One-Time Password) code is visible on the screen in a scannable format. - -Scan the Code: Use the camera to scan the OTP code. - -Select Scan OTP: Choose the "Scan OTP" option from the menu. - -Verify Addition: The OTP code will be added as a custom field to the selected password entry. - -Access OTP Code: You can view the OTP code by tapping the eye icon next to the custom field. - -![Illustration for: Verify Addition: The OTP code will be added as a custom field to the selected password entry. Access OTP Code: You can view the OTP code by tapping the eye icon next to the…](https://files.readme.io/2d50b9c-Screenshot_2024-06-16_at_11.16.55.png) diff --git a/docs/Password Manager/password-manager-mobile-application/choosing-password-locationfolder.md b/docs/Password Manager/password-manager-mobile-application/choosing-password-locationfolder.md deleted file mode 100644 index f4353c0db..000000000 --- a/docs/Password Manager/password-manager-mobile-application/choosing-password-locationfolder.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: Choosing Password Location/Folder -excerpt: '' -deprecated: false -hidden: true -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -When engaging with the Akeyless Platform for password management, you are presented with a flexible and intuitive system to categorize and store your passwords. This system is structured around the concept of personal and corporate folders, each serving a distinct purpose and offering different levels of access and privacy. - -## Personal Folder - -The personal folder in Akeyless serves as a private repository exclusive to each user. It is particularly useful when you authenticate through email-based methods like SAML. This dedicated space is designed for storing personal passwords - those unrelated to your work or corporate responsibilities. The key attributes of this folder include: - -Privacy: This folder is entirely private and not linked to your corporate roles or access rights within the organization. It acts as a secure vault for your personal credentials. - -Flexibility: You can organize your personal passwords in a way that best suits your needs, whether by category, frequency of use, or any other personal preference. - -## Corporate Folder - -Contrastingly, the corporate folder is aligned with your professional role and is managed at the organizational level. Its features include: - -Role-Based Access: Passwords stored here are related to your work and are accessible to other team members who have the necessary permissions. - -Organization Managed: This folder's structure and access rights are typically managed by your organization's IT or security team, ensuring that sensitive corporate passwords are adequately protected and distributed. - -## Selecting Password Location - -When creating a new password in Akeyless, you can choose its location within the app's folder hierarchy. This choice is vital for maintaining an organized and efficient password management system. Here's how you can do it: - -1. While creating a new password, click on the location field in the location area. - - ![Illustration for: When creating a new password in Akeyless, you can choose its location within the app's folder hierarchy. This choice is vital for maintaining an organized and efficient…](https://files.readme.io/53eef20-Screenshot_2024-01-10_at_14.53.26.png) - -2. You will be redirected to a screen where you can choose between the personal and corporate areas (folders). -3. If you choose the personal folder, you will see your personal folder hierarchy and can select one of the existing folders to save the password in. - - ![Illustration for: 2. You will be redirected to a screen where you can choose between the personal and corporate areas (folders). 3. If you choose the personal folder, you will see your personal…](https://files.readme.io/7bd7af9-Screenshot_2024-01-10_at_14.54.06.png) - -4. If you want to create a new folder, click on the "Create New Folder" button. -5. In the pop-up window, provide a name for the new folder and click "Create." -6. The new folder will be created and selected as the desired location. -7. Click "Save" in the top right corner of the screen to save your selection. - -## Organizing Passwords - -Effectively organizing your passwords can enhance your overall password management experience. By utilizing the personal and corporate folders, you can compartmentalize your passwords based on their purpose and accessibility. - -1. **Personal Passwords**: Store passwords related to your personal accounts, such as social media, email, or banking, within your personal folder. -2. **Corporate Passwords**: Store passwords related to your work accounts, such as company email, project management tools, or customer relationship management (CRM) systems, within the corporate folder. -3. **Subdirectories**: Use subdirectories within the personal and corporate folders to further categorize your passwords based on specific projects, teams, or categories. - -By following these guidelines, you can maintain a well-organized and secure password management system within Akeyless. diff --git a/docs/Password Manager/password-manager-mobile-application/configure-customspecific-tenant-1.md b/docs/Password Manager/password-manager-mobile-application/configure-customspecific-tenant-1.md deleted file mode 100644 index d94977209..000000000 --- a/docs/Password Manager/password-manager-mobile-application/configure-customspecific-tenant-1.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Configure Custom/Specific Tenant -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -This innovative feature allows users of the Password Manager application to enhance their experience by setting up a custom or specific tenant URL. This functionality is crafted to customize access management, enabling users to connect more securely and efficiently to web services that meet their organizational or personal requirements. By configuring a unique tenant URL within the Password Manager, users can ensure a direct and secure connection to the desired services or databases, thus improving both the efficiency and security of their digital interactions. - -![Illustration for: This innovative feature allows users of the Password Manager application to enhance their experience by setting up a custom or specific tenant URL. This functionality is…](https://files.readme.io/e2cd65b-Screenshot_2024-03-20_at_11.16.36.png) - -## Detailed Instructions for Configuring Your Custom/Specific Tenant URL in the Password Manager Application - -Initiation of Configuration Process: Start the customization process by opening your Password Manager application. Navigate to its settings or configuration area, which you can usually find in the main menu or by tapping a settings icon. This part of the application is your hub for adjusting its behavior and settings to align with your specific access needs or preferences. - -## Entering the Custom/Specific Tenant URL - -Within the settings or configuration section, look for a field designated for entering the tenant URL. This is where you will input the URL that pertains to your particular tenant. The tenant URL is a vital connector between your Password Manager application and the web services it interacts with, directing how the application authenticates and establishes connections with these services. It is crucial to enter this URL accurately to ensure a direct and secure linkage. - -## Saving Your Configuration - -![Illustration for: Saving Your Configuration](https://files.readme.io/180af2d-Screenshot_2024-03-20_at_11.17.16.png) - -After accurately entering the tenant URL, complete the setup by clicking the "Save" button. This step confirms and applies your settings, incorporating the custom tenant URL into your Password Manager application. With this configuration active, the application will automatically use the specified tenant URL for relevant operations, thus providing a more tailored and secure access management experience. diff --git a/docs/Password Manager/password-manager-mobile-application/configure-ldap-gateway-url.md b/docs/Password Manager/password-manager-mobile-application/configure-ldap-gateway-url.md deleted file mode 100644 index eead80eec..000000000 --- a/docs/Password Manager/password-manager-mobile-application/configure-ldap-gateway-url.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Configure LDAP gateway URL -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -This functionality allows users to enhance their Password Manager application by integrating it with a specific LDAP gateway URL. This integration streamlines access management and boosts security protocols by leveraging centralized authentication services through the LDAP gateway. Users can enjoy a more seamless sign-in experience across various platforms, ensuring that their credentials are managed securely and efficiently. - -![Illustration for: This functionality allows users to enhance their Password Manager application by integrating it with a specific LDAP gateway URL. This integration streamlines access management…](https://files.readme.io/006da13-Screenshot_2024-03-20_at_10.53.34.png) - -## Step-by-Step Guide to Configuring Your LDAP Gateway URL in the Password Manager Application - -Initiate Configuration: Begin by opening your Password Manager application. Navigate to the settings or configuration section, which can typically be found in the main menu or under a settings icon. This area allows you to adjust the application settings and tailor the authentication process to your needs. - -## Enter the LDAP Gateway URL - -Within the settings or configuration section, look for the option to enter the LDAP gateway URL. This is the crucial step where you link your Password Manager application with the LDAP server that handles authentication and access management. Input the URL of your LDAP server in the designated field. The LDAP gateway serves as the conduit between your application and the LDAP server, facilitating a secure and centralized authentication process. Ensure that the URL is entered correctly to guarantee the integration's success. - -## Save Your Settings and Enter LDAP Credentials - -![Illustration for: Save Your Settings and Enter LDAP Credentials](https://files.readme.io/921c299-Screenshot_2024-03-20_at_10.57.16.png) - -After you have entered the LDAP gateway URL, save your changes by clicking the "Save" button. This step solidifies your configuration, establishing the connection between your Password Manager application and the LDAP server. Upon successful configuration, you will be redirected to a screen where you can enter your LDAP credentials. This is where you input your username and password associated with the LDAP server, enabling you to log in to the mobile app using LDAP authentication. By completing this step, you further enhance the security and efficiency of your sign-in process, leveraging the power of LDAP for superior access management. diff --git a/docs/Password Manager/password-manager-mobile-application/creating-new-secret-1/_order.yaml b/docs/Password Manager/password-manager-mobile-application/creating-new-secret-1/_order.yaml deleted file mode 100644 index cff97c387..000000000 --- a/docs/Password Manager/password-manager-mobile-application/creating-new-secret-1/_order.yaml +++ /dev/null @@ -1 +0,0 @@ -- creating-new-secret-value-type-1 diff --git a/docs/Password Manager/password-manager-mobile-application/creating-new-secret-1/creating-new-secret-value-type-1.md b/docs/Password Manager/password-manager-mobile-application/creating-new-secret-1/creating-new-secret-value-type-1.md deleted file mode 100644 index 50d565c47..000000000 --- a/docs/Password Manager/password-manager-mobile-application/creating-new-secret-1/creating-new-secret-value-type-1.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Creating New Secret Value Type -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -![Illustration for: next: description: '' ---](https://files.readme.io/964524c-IMG_0049.png) - -The Akeyless Mobile Password Manager Application is designed to accommodate a variety of secret types. One of the key features is the flexibility of the 'Value' field, which can store information not just in plain text but also in JSON format. This section will guide you on how to use the 'Value' field for both text and JSON data. - -## Text Data - -For straightforward text data, such as passwords, secure notes, or API keys, simply enter the information directly into the 'Value' field. The application will securely encrypt and store this text, making it accessible only to authorized users. - -## JSON Data - -The 'Value' field can also store structured data in JSON format. This is particularly useful for storing configuration settings or multiple pieces of related information in a structured and easily retrievable form. - -![Illustration for: The 'Value' field can also store structured data in JSON format. This is particularly useful for storing configuration settings or multiple pieces of related information in a…](https://files.readme.io/2cac494-IMG_0050.png) diff --git a/docs/Password Manager/password-manager-mobile-application/creating-new-secret-1/index.md b/docs/Password Manager/password-manager-mobile-application/creating-new-secret-1/index.md deleted file mode 100644 index 203e1efdf..000000000 --- a/docs/Password Manager/password-manager-mobile-application/creating-new-secret-1/index.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: Creating New Secret -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -## Step 1: Launch the Akeyless Mobile Secret Manager Application - -Locating the App: Begin by finding the Akeyless mobile Password Manager application on your mobile device. - -Opening the App: Tap on the Akeyless icon. This action initiates the application, and you may see a brief loading screen as the app prepares to open. - -![Illustration for: Locating the App: Begin by finding the Akeyless mobile Password Manager application on your mobile device. Opening the App: Tap on the Akeyless icon. This action initiates the…](https://files.readme.io/2c37aed-Screenshot_2024-03-21_at_13.35.46.png) - -## Step 2: Initiate the Secret Creation Process - -Accessing the Main Interface: Once the Akeyless application has fully loaded, you'll be presented with the main screen. - -Locating the Creation Button: At the bottom of the screen, you'll find a prominent blue plus button, designed to be easily identifiable. - -Beginning the Process: Tap on this blue plus button. This action signals the app to enter the secret creation mode. - -## Step 3: Define the Secret's Name and Location - -You will be redirected to a new screen dedicated to creating a new secret. - -In the first field labeled 'Secret Name,' enter a unique and easily recognizable name for the secret. - -Optionally, you can specify the 'Location' of the secret by using the drop-down button located on the right side of the 'Location' field. - -If the desired folder does not exist, you have the option to create a new folder within the secret location window; by using the inline option. - -## Step 4: Enhance Security and Add Context - -Providing Context: Use the 'Description' field to add any relevant information about the secret, such as its purpose or associated account details. This information helps with organization and serves as a reminder of the secret’s use. - -Activating Delete Protection: For added security, especially against accidental deletions, toggle the 'Delete Protection' option. This feature requires an extra layer of confirmation before any deletion can occur. - -## Step 5: Define the Secret Value - -You will enter the secret's value directly In the 'Value' field, input the information you wish to keep secret. - -This could be a secure note, an API Key, or any other sensitive information that requires secure storage. - -## Step 6: Save the Newly Created Secret - -Saving the Secret: After reviewing the details you’ve entered, select the 'Save' button once you're satisfied that everything is correct. This action securely stores the new secret within the Akeyless app. diff --git a/docs/Password Manager/password-manager-mobile-application/creating-new-secret-2/_order.yaml b/docs/Password Manager/password-manager-mobile-application/creating-new-secret-2/_order.yaml deleted file mode 100644 index 86463cc59..000000000 --- a/docs/Password Manager/password-manager-mobile-application/creating-new-secret-2/_order.yaml +++ /dev/null @@ -1 +0,0 @@ -- creating-new-secret-value-type-2 diff --git a/docs/Password Manager/password-manager-mobile-application/creating-new-secret-2/creating-new-secret-value-type-2.md b/docs/Password Manager/password-manager-mobile-application/creating-new-secret-2/creating-new-secret-value-type-2.md deleted file mode 100644 index b0c3ff2e7..000000000 --- a/docs/Password Manager/password-manager-mobile-application/creating-new-secret-2/creating-new-secret-value-type-2.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Creating New Secret Value Type -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -Akeyless Password Manager Mobile Application is designed to accommodate a variety of secret types. One of the key features is the flexibility of the 'Value' field, which can store information not just in plain text but also in JSON format. This section will guide you on how to use the 'Value' field for both text and JSON data. - -![Illustration for: Akeyless Password Manager Mobile Application is designed to accommodate a variety of secret types. One of the key features is the flexibility of the 'Value' field, which can…](https://files.readme.io/4bb02a9-IMG_0055.png) - -## Text Data - -For straightforward text data, such as passwords, secure notes, or API keys, simply enter the information directly into the 'Value' field. The application will securely encrypt and store this text, making it accessible only to authorized users. - -## JSON Data - -The 'Value' field can also store structured data in JSON format. This is particularly useful for storing configuration settings or multiple pieces of related information in a structured and easily retrievable form. diff --git a/docs/Password Manager/password-manager-mobile-application/creating-new-secret-2/index.md b/docs/Password Manager/password-manager-mobile-application/creating-new-secret-2/index.md deleted file mode 100644 index 1431a7fee..000000000 --- a/docs/Password Manager/password-manager-mobile-application/creating-new-secret-2/index.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Creating New Secret -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -## Step 1: Launch the Akeyless Password Manager Mobile App - -Once installed, tap on the Akeyless Password Manager app icon on your mobile device to open it. - -![Illustration for: Step 1: Launch the Akeyless Password Manager Mobile App Once installed, tap on the Akeyless Password Manager app icon on your mobile device to open it.](https://files.readme.io/eef7865-IMG_0054.png) - -## Step 2: Access the Password Creation Form - -1. Tap on the "New Item" button. This will open the Akeyless secrets bottom navigation menu. -2. Navigate to the Static Secret option by selecting it from the bottom navigation menu. -3. Enter a name for the password in the "Secret Name" field. -4. Optionally, enter a description for the secret in the "Description" field. - -## Step 3: Define Var and Location - -In the "Var" field, enter a unique combination of letters, symbols, and numbers. The value length should be 16 KB. - -Optionally, you can specify the "Password Location" using the drop-down menu to choose between "Corporate" and "Personal" areas to store the password. diff --git a/docs/Password Manager/password-manager-mobile-application/editing-password-details.md b/docs/Password Manager/password-manager-mobile-application/editing-password-details.md deleted file mode 100644 index dbac4f257..000000000 --- a/docs/Password Manager/password-manager-mobile-application/editing-password-details.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: Editing Password Details -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -## Locating the Password - -![Illustration for: Locating the Password](https://files.readme.io/4d0810c-Screenshot_2024-01-10_at_16.15.37.png) - -Navigate to Secrets Section: Start by accessing the 'Secrets' section of the Akeyless application. This area is specifically designed to store and organize your secrets and passwords. - -Viewing Saved Secrets: In this section, you will find a comprehensive list of all your saved items, including passwords, secret notes, and other sensitive data. - -Understanding the Layout: Familiarize yourself with the layout, noting how the secrets are categorized or arranged, which might be alphabetically, by date modified, or by type. - -## Access Quick Action Menu - -Identifying the Specific Password: Scroll through your list of secrets and locate the specific password you wish to edit. - -Revealing the Menu: Next to the identified password, you'll see a three dots icon (often represented as '⋮'). This icon signifies more options or actions related to the password. - -Accessing the Menu: Click on this icon to reveal a dropdown menu, commonly referred to as the 'quick action menu', which contains several options for managing the selected password. - -## Initiate Edit Mode - -Selecting Edit Option: In the quick action menu, look for and select the 'Edit' option. This choice will transition the interface into an editable mode for the selected password. - -Understanding Edit Mode: In edit mode, the fields that were previously static will now become interactive, allowing you to make changes. - -## Observe Edit Mode Transition - -Recognizing Interface Changes: Notice that the 'Edit' option, once selected, will be replaced with a 'Save' option. This is typically located at the top right part of the screen. - -Indicator of Readiness: The appearance of the 'Save' button is an indication that the application is now in edit mode and is ready to accept and apply your changes. - -## Make Desired Changes - -Editing Fields: You can now modify the password's information. This may include changing the password itself, updating the username, altering the description, or adjusting associated URLs. - -Utilizing Advanced Options: Depending on the nature of your password, you might also have advanced options like setting expiration dates, changing sharing settings, or updating security notes. - -## Apply Changes - -Reviewing Changes: Before saving, take a moment to review the changes you’ve made. Ensure that all modifications are accurate and as intended. - -Clicking Save: Once satisfied, click the 'Save' button. This action confirms and applies the changes you've made to the password. - -## Confirmation of Saved Changes - -Acknowledging the Update: The application will process your request and update the password with the new information. - -Visual Confirmation: Typically, you'll receive a visual cue or a message confirming that your changes have been successfully saved. - -Post-Edit Review: It’s good practice to revisit the edited password entry to ensure all updates are correctly reflected. diff --git a/docs/Password Manager/password-manager-mobile-application/favorites-add-remove-and-view-items.md b/docs/Password Manager/password-manager-mobile-application/favorites-add-remove-and-view-items.md deleted file mode 100644 index 197c70066..000000000 --- a/docs/Password Manager/password-manager-mobile-application/favorites-add-remove-and-view-items.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Favorites (add, remove and view items) -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -The Favorites Tab is crafted to offer you quick and easy access to select passwords and secrets that you deem most critical or use often. It acts as a personalized shortcut, streamlining your navigation and saving you time. - -![Illustration for: The Favorites Tab is crafted to offer you quick and easy access to select passwords and secrets that you deem most critical or use often. It acts as a personalized shortcut,…](https://files.readme.io/267b625-Screenshot_2024-04-11_at_15.25.13.png) - -## Adding Items to Favorites - -How to Add: You can add any password or secret to the Favorites Tab by tapping the 'Add to Favorites' option available on each individual item. - -How to Remove: You can easily remove any password or secret from the Favorites Tab. Simply locate the item you wish to remove and tap the 'Remove from Favorites' option found on the individual item's options menu. - -Accessibility: Once added, these items are easily accessible, allowing for quick retrieval without the need to sift through your entire library. - -## Layout and Display - -View Options: The Favorites Tab organizes your chosen items in a user-friendly list or grid layout, ensuring you can view and access your favorites efficiently. - -## Search and Filter Functionality - -Quick Search: The integrated search bar enables you to rapidly locate specific entries within your Favorites Tab, eliminating the need for manual scrolling. diff --git a/docs/Password Manager/password-manager-mobile-application/home-screen-frequently-used-items.md b/docs/Password Manager/password-manager-mobile-application/home-screen-frequently-used-items.md deleted file mode 100644 index 7094b802e..000000000 --- a/docs/Password Manager/password-manager-mobile-application/home-screen-frequently-used-items.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Home Screen (Frequently used items) -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -The revamped home screen brings a host of new features and improvements to ensure you have immediate access to the most relevant information and functionalities. Here's what you can expect: - -![Illustration for: The revamped home screen brings a host of new features and improvements to ensure you have immediate access to the most relevant information and functionalities. Here's what…](https://files.readme.io/f53004f-Screenshot_2024-04-11_at_15.21.31.png) - -## "What's New" Banner - -Location: Prominently displayed at the top of the screen. - -Functionality: This banner is your go-to source for the latest app features, updates, and resolutions to any pesky bugs we've squashed. - -Implementation Details: We've dedicated a specific view/layout to ensure this banner stands out from the rest of your content. It will introduce you to the latest additions such as: - -* Secure Password/Secret Sharing: Share your credentials securely with trusted contacts. -* OIDC Support: We've bolstered security with OpenID Connect integration for authentication. -* LDAP Integration: Seamlessly connect and authenticate with your network using LDAP. -* Autofill Password Feature: Enjoy quick and secure autofill capabilities across websites and apps. - - Personal and Corporate Navigation - -* Features: A streamlined header/navigator allows you to easily switch between your Personal and Corporate spaces, each tailored with specific options for an organized viewing experience. - -## Frequently Used Section - -This addition to the home screen is designed to put your most used passwords and secrets right at your fingertips, ensuring that your most critical credentials are always within easy reach. - -* Purpose: To provide quick access to the passwords and secrets you use most frequently, making your daily routines smoother and more efficient. -* Criteria for "Most Used": This section dynamically updates based on your actions, including: - * Injected Passwords: Passwords you've used to log in automatically to websites and apps. - * Copied Passwords: Credentials you've copied to the clipboard for use in different contexts. - * Shared Passwords: Passwords and secrets you've shared with trusted contacts for collaborative work or emergency access. diff --git a/docs/Password Manager/password-manager-mobile-application/index.md b/docs/Password Manager/password-manager-mobile-application/index.md deleted file mode 100644 index 1a5d931f4..000000000 --- a/docs/Password Manager/password-manager-mobile-application/index.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Password Manager Mobile Application -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -## Introduction - -### Empowering Seamless Password Management With Akeyless Mobile App - -In the rapidly evolving digital era, managing a diverse array of passwords and sensitive data presents a significant challenge. Enter the realm of effortless digital security with the Akeyless mobile app – a sophisticated solution designed to simplify password management and bolster your online security. This innovative app is more than just a tool; it's a gateway to a world where your digital credentials are managed with unparalleled precision and ease. By flawlessly integrating with your existing Akeyless account, it offers a streamlined experience for accessing, managing, and securely storing your passwords and sensitive information. - -### Unleash the Convenience of On-the-Go Access - -The Akeyless mobile app redefines convenience, ensuring that your essential passwords are always at your fingertips, irrespective of your location. Whether you're navigating the bustling streets of a city, relaxing at a café, or working remotely from a tranquil beach, this app keeps you connected to your most critical information. With just a few intuitive taps, you gain the ability to access, manage, and use select items from your Akeyless account. This feature empowers you with the freedom to remain productive and connected, seamlessly bridging the gap between your digital life and your on-the-go lifestyle. - -### Experience the Power of Akeyless Mobile App - -The Akeyless mobile app is a masterpiece of digital convenience, boasting an intuitive interface, user-friendly features, and a steadfast commitment to robust security. Its design caters to both tech-savvy users and those new to digital password management, ensuring a smooth and accessible experience for everyone. The app's advanced security protocols provide peace of mind, safeguarding your sensitive information against digital threats. By downloading the Akeyless mobile app, you embark on a transformative journey towards streamlined password management, enhanced security, and a more organized digital life. Embrace the future of password security and experience the unparalleled benefits of the Akeyless mobile app today. - -## Tutorial - -Check out our tutorial video on [Using the Akeyless Password Manager Mobile App](https://tutorials.akeyless.io/docs/akeyless-password-manager-mobile-app-for-users). diff --git a/docs/Password Manager/password-manager-mobile-application/installation-of-akeyless-mobile-application.md b/docs/Password Manager/password-manager-mobile-application/installation-of-akeyless-mobile-application.md deleted file mode 100644 index 64543f20d..000000000 --- a/docs/Password Manager/password-manager-mobile-application/installation-of-akeyless-mobile-application.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: Install and Sign In to the Akeyless mobile app -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -## Installation on Your Mobile Devices - -The Akeyless Password Manager mobile application offers a streamlined and user-friendly installation process, compatible with both Android and iOS platforms. Here's how you can effortlessly install and begin using Akeyless on your mobile device: - -## Akeyless Password Manager Android Installation - -Open Google Play Store: On your Android device, navigate to the Google Play Store. This app is typically found on your device's home screen or app drawer. Tap on its icon to open it. - -Search for Akeyless: Once inside the Play Store, locate the search bar at the top of the screen. Here, type in "Akeyless" and press the Enter key on your device's keyboard. This action initiates a search for the app within the Google Play Store. - -Locate Akeyless Mobile App: Browse through the search results until you find the official Akeyless Password Manager mobile application. Look for the app with the recognizable Akeyless logo. Once located, tap on the "Install" button adjacent to the app. - -Grant Permissions: A prompt will appear, detailing the permissions required by the Akeyless app to function optimally on your device. Carefully review these permissions. If they seem appropriate and necessary for the app’s functionality, tap on the "Accept" button to begin the installation process. - -![Illustration for: Grant Permissions: A prompt will appear, detailing the permissions required by the Akeyless app to function optimally on your device. Carefully review these permissions. If…](https://files.readme.io/528c51e-Screenshot_20240506_171826_Google_Play_Store2.jpg) - -## Akeyless Password Manager iOS Installation - -Open Apple App Store: On your iOS device, locate and launch the Apple App Store. This is typically found on your home screen. - -Search for Akeyless: At the top of the App Store interface, you'll find a search bar. Tap on it and enter "Akeyless." Proceed by tapping the "Search" button on the keyboard. - -Choose Akeyless Mobile App: The search results will display various apps. Navigate to the official Akeyless Password Manager mobile application, recognizable by its logo. Once you've found it, tap the "Get" button next to the app. - -Confirm Installation: iOS may prompt you to confirm the installation. This might include reviewing the permissions the app requires and possibly entering your Apple ID password or using Face ID/Touch ID for verification. Follow these steps to finalize the installation. - -![Illustration for: Confirm Installation: iOS may prompt you to confirm the installation. This might include reviewing the permissions the app requires and possibly entering your Apple ID password…](https://files.readme.io/9f41004-File_5.jpg) - -## Authentication Methods Support - -In the context of modern enterprise environments, where security is a top priority, the Akeyless Platform offers a highly secure login flow. This involves using a code ID provided by an IT admin combined with multi-factor authentication (MFA). This method is more secure than traditional master passwords or biometrics, as it introduces multiple verification layers and eliminates potential single points of failure. - -## VPN Requirement for Zero-Knowledge Keyless Mode - -Zero-knowledge keyless functionality is a security feature that allows users to access and manage their passwords or other sensitive information without revealing their credentials to the Service Provider. This is achieved through cryptographic techniques that ensure that only the user has knowledge of their credentials, while the Service Provider can only verify their identity without ever storing or seeing their passwords. - -A VPN establishes a secure tunnel between the user's mobile device and the VPN server, encrypting all network traffic and routing it through the VPN provider's secure infrastructure. This encrypted tunnel effectively shields the user's data from prying eyes, ensuring that their sensitive information, including their zero-knowledge keyless credentials, remains protected from interception and unauthorized access. - -Therefore, requiring users to have a VPN installed on their phones before using zero-knowledge keyless functionality is a necessary security measure to protect their sensitive information and maintain the integrity of the zero-knowledge authentication process. By routing all network traffic through a secure VPN tunnel, users can confidently use zero-knowledge keyless functionality without compromising their security. - -## Authentication Methods Support - -Once you've installed the Akeyless browser extension. Simply locate the Akeyless Password Manager mobile app. To securely access your Akeyless account, you can use one of the following authentication methods: - -* Access-ID and Access-Key: Use your unique Access-ID and Access-Key combination for secure login. -* SAML: Leverage your existing SAML (Security Assertion Markup Language) identity provider for streamlined authentication. -* OIDC: Employ your preferred OIDC (OpenID Connect) identity provider for a seamless login experience. -* LDAP: For environments configured with LDAP, you can authenticate using your LDAP credentials for secure access. - * Configure the [LDAP gateway URL](https://docs.akeyless.io/docs/configure-ldap-gateway-url) by way of advanced settings then login with Email option as a login type. -* Account Alias: Support for using an account alias to simplify identification and enhance user experience. - -For more details about Akeyless Authentication Methods please visit this [link](https://docs.akeyless.io/docs/access-and-authentication-methods) diff --git a/docs/Password Manager/password-manager-mobile-application/pwm-mobile-autofill-and-password-injection.md b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-autofill-and-password-injection.md new file mode 100644 index 000000000..0a2b09f09 --- /dev/null +++ b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-autofill-and-password-injection.md @@ -0,0 +1,67 @@ +--- +title: Using Autofill and Password Injection Functionality + +slug: pwm-mobile-autofill-and-password-injection +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +Enable autofill in the Password Manager app to fill saved credentials in supported websites and apps. + +## When Users Are Prompted to Enable Autofill + +Users can be prompted to enable autofill in two common situations: + +* During installation, immediately after a successful sign-in. +* Later, from the app after installation is complete. + +## Use Autofill in an App or Website + +1. Open the target app or website. +2. Tap the username or password field. +3. Select the suggested credential from Akeyless Password Manager. +4. Complete any required biometric or device-authentication prompt. + +## Enable Autofill + +### On iOS + +1. Open **Settings** on the iOS device. +2. Open **Passwords** or **Passwords & Accounts**, depending on the iOS version. +3. Open **Autofill Passwords**. +4. Turn on the autofill option. +5. Under **Allow Filling From**, select **Akeyless Password Manager**. + +When you open a login screen in Safari or an app, iOS can offer saved credentials from Akeyless Password Manager above the keyboard or inside the sign-in field. + +![Autofill settings enabled in the Akeyless mobile app](https://files.readme.io/c309879-File_3.jpg) + +### On Android + +1. Open **Settings** on the Android device. +2. Open **System** and then **Languages & Input**. On some devices, these labels can vary. +3. Open **Autofill service**. +4. Select **Akeyless Password Manager** as the autofill service. +5. If needed, open the Akeyless Password Manager app and enable autofill from its settings flow. + +When autofill is enabled, supported apps and browsers can prompt for saved credentials when users tap a sign-in field. + +![Akeyless autofill popup suggesting credentials on a login screen](https://files.readme.io/229e403-Screenshot_20240221-112137_Firefox.jpg) + +## Browser Support Notes + +The following Android browsers are documented as providing strong autofill support: + +* Firefox +* Firefox Focus +* Microsoft Edge +* DuckDuckGo +* Brave + +Chrome supports Android autofill, but prompt behavior can differ by page. In Chrome, users might need to tap the credential suggestion above the keyboard or reopen the focused field to trigger the Akeyless suggestion. diff --git a/docs/Password Manager/password-manager-mobile-application/pwm-mobile-choose-password-location-folder.md b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-choose-password-location-folder.md new file mode 100644 index 000000000..ff37fd37a --- /dev/null +++ b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-choose-password-location-folder.md @@ -0,0 +1,66 @@ +--- +title: Choosing Password Location and Folder + +slug: pwm-mobile-choose-password-location-folder +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +Choose where a password is stored and manage the Personal or Corporate view in the mobile app. + +## Personal Folder + +Use the Personal folder for credentials that are private to your user account. + +Example: save your personal work persona credentials, such as your individual Jira account, personal Slack workspace account, or personal GitHub account used for work, in Personal. + +## Corporate Folder + +Use the Corporate folder for credentials managed by organizational access policy. + +Example: save shared SaaS admin access, team service accounts, or environment credentials (for example, staging dashboards) in Corporate. + +## Selecting Password Location + +When creating a password, choose the save location with these steps: + +1. While creating a new password, tap the location field. + + ![Password location selector showing the folder hierarchy in the mobile app](https://files.readme.io/53eef20-Screenshot_2024-01-10_at_14.53.26.png) + +2. Select Personal or Corporate area. +3. Select an existing folder in the selected area. + + ![Area selection screen showing Personal and Corporate folders in the mobile app](https://files.readme.io/7bd7af9-Screenshot_2024-01-10_at_14.54.06.png) + +4. To create a folder, tap **Create New Folder**. +5. Enter folder name and tap **Create**. +6. Confirm the selected location. +7. Tap **Save**. + +## Personal Area Display Controls + +In addition to selecting a save location during password creation, the mobile app supports Personal or Corporate display toggles in list-oriented views. + +Use the Personal or Corporate toggle to switch which area is displayed in: + +* The secrets list view. +* The Home view. + +The selected mode is persisted and reused on subsequent app sessions. + +## Change Displayed Area in Lists and Home + +Use these steps to switch between Personal and Corporate display modes: + +1. Open the secrets list or Home view. +2. Use the Personal or Corporate toggle. +3. Confirm that the selected area content is loaded. + +The selected area is stored and reused in subsequent app sessions. diff --git a/docs/Password Manager/password-manager-mobile-application/pwm-mobile-configure-custom-specific-tenant.md b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-configure-custom-specific-tenant.md new file mode 100644 index 000000000..013d77dc7 --- /dev/null +++ b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-configure-custom-specific-tenant.md @@ -0,0 +1,37 @@ +--- +title: Configure Custom and Specific Tenant + +slug: pwm-mobile-configure-custom-specific-tenant +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +Use these steps to configure a custom tenant URL for mobile sign-in. + +![Custom tenant URL field in the mobile app settings](https://files.readme.io/e2cd65b-Screenshot_2024-03-20_at_11.16.36.png) + +## Detailed Instructions for Configuring Your Custom and Specific Tenant URL in the Password Manager Application + +1. Open the mobile app. +2. Open settings. +3. Open tenant URL configuration. + +## Entering the Custom and Specific Tenant URL + +Enter the tenant URL provided by your administrator. + +For administrator-managed tenant URL setup guidance, see [Configure Custom and Specific Tenant (Web Extension)](https://docs.akeyless.io/docs/pwm-ext-configure-custom-specific-tenant). + +## Saving Your Configuration + +![Save button for custom tenant URL configuration in the mobile app](https://files.readme.io/180af2d-Screenshot_2024-03-20_at_11.17.16.png) + +1. Tap **Save**. +2. Continue to sign-in. +3. Confirm that the app uses the configured tenant URL. diff --git a/docs/Password Manager/password-manager-mobile-application/pwm-mobile-configure-ldap-gateway-url.md b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-configure-ldap-gateway-url.md new file mode 100644 index 000000000..4087e7c60 --- /dev/null +++ b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-configure-ldap-gateway-url.md @@ -0,0 +1,38 @@ +--- +title: Configure LDAP Gateway URL + +slug: pwm-mobile-configure-ldap-gateway-url +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +Use these steps to configure the LDAP gateway URL for mobile sign-in. + +![LDAP Gateway URL field in the mobile app settings](https://files.readme.io/006da13-Screenshot_2024-03-20_at_10.53.34.png) + +## Step-by-Step Guide to Configuring Your LDAP Gateway URL in the Password Manager Application + +1. Open the mobile app. +2. Open settings. +3. Open the LDAP gateway URL configuration field. + +## Enter the LDAP Gateway URL + +Enter the LDAP gateway URL provided by your administrator. + +For administrator configuration guidance, see [LDAP Authentication Method configuration](https://docs.akeyless.io/docs/auth-with-ldap). + +## Save Your Settings and Enter LDAP Credentials + +![LDAP credentials entry screen in the mobile app](https://files.readme.io/921c299-Screenshot_2024-03-20_at_10.57.16.png) + +1. Tap **Save**. +2. Continue to sign-in. +3. Enter LDAP credentials. +4. Confirm successful login. diff --git a/docs/Password Manager/password-manager-mobile-application/copypaste-functionality-for-passwords.md b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-copy-and-paste-passwords.md similarity index 69% rename from docs/Password Manager/password-manager-mobile-application/copypaste-functionality-for-passwords.md rename to docs/Password Manager/password-manager-mobile-application/pwm-mobile-copy-and-paste-passwords.md index 6750d1fe4..773f1b639 100644 --- a/docs/Password Manager/password-manager-mobile-application/copypaste-functionality-for-passwords.md +++ b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-copy-and-paste-passwords.md @@ -1,5 +1,7 @@ --- -title: Copy/Paste Functionality for Passwords +title: Copy and Paste Functionality for Passwords + +slug: pwm-mobile-copy-and-paste-passwords excerpt: '' deprecated: false hidden: false @@ -10,7 +12,7 @@ metadata: next: description: '' --- -Our Password Manager app includes a convenient copy/paste feature, allowing you to securely transfer passwords from the app to web forms. +Our Password Manager app includes a convenient copy and paste feature, allowing you to securely transfer passwords from the app to web forms. ## Copying the Password diff --git a/docs/Password Manager/password-manager-mobile-application/creating-new-password.md b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-create-password.md similarity index 50% rename from docs/Password Manager/password-manager-mobile-application/creating-new-password.md rename to docs/Password Manager/password-manager-mobile-application/pwm-mobile-create-password.md index b245f4749..9632ff155 100644 --- a/docs/Password Manager/password-manager-mobile-application/creating-new-password.md +++ b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-create-password.md @@ -1,5 +1,7 @@ --- -title: Creating New Password +title: Creating a New Password + +slug: pwm-mobile-create-password excerpt: '' deprecated: false hidden: false @@ -10,9 +12,15 @@ metadata: next: description: '' --- +Use the following steps to create a new password in the Akeyless mobile app, either from the main interface or directly from the autofill window. + +> 📘 **Password items and secret items** +> +> **Password items** store structured credentials — a URL, username, and password — and integrate with autofill and OTP. **Secret items** store arbitrary text values such as API keys, tokens, or notes, and support custom key-value fields. To create a secret item instead, see [Creating a New Secret](https://docs.akeyless.io/docs/pwm-mobile-create-static-secret). + ## Creating a New Password from Akeyless Mobile Application -![Illustration for: Creating a New Password from Akeyless Mobile Application](https://files.readme.io/66309dd-Screenshot_2024-01-10_at_14.52.27.png) +![New password form in the Akeyless mobile app](https://files.readme.io/66309dd-Screenshot_2024-01-10_at_14.52.27.png) ### Step 1: Launch the Akeyless Mobile Password Manager Application @@ -26,23 +34,21 @@ Accessing the Main Interface: Once the Akeyless application has fully loaded, yo Locating the Creation Button: At the bottom of the screen, you'll find a prominent orange plus button, typically designed to stand out for easy identification. -Beginning the Process: Tap on this orange plus button. This action signals the app to enter the password creation mode. +Beginning the Process: Tap on this orange plus button. An action sheet appears with two options. Select **Password** to open the password creation form. ### Step 3: Define the Password's Name and Location You will be redirected to a new screen dedicated to creating a new password. -In the first field labeled 'Password Name,' enter a unique and easily recognizable name for the password. - -Optionally, you can specify the 'Location' of the password by utilizing the drop-down button located on the right area of the 'Location' field. +In the first field labeled **Name**, enter a unique and easily recognizable name for the password. -If the desired folder does not exist, you can create a new folder within the password location window. Select the "Create New Folder" button. +Optionally, enter the **Location** path to store the password in a specific folder. ### Step 4: Enhance Security and Add Context -Providing Context: Use the 'Description' field to add any relevant information about the password, like its purpose or associated account details. This information is not just for organization but can also serve as a reminder of the password’s use. +Providing Context: Use the **Description** field to add any relevant information about the password, like its purpose or associated account details. -Activating Delete Protection: For added security, especially against accidental deletions, toggle the 'Delete Protection' option. This adds an extra layer of confirmation before any deletion can occur. +Activating Delete Protection: For added security, especially against accidental deletions, toggle the **Delete Protection** option. This adds an extra layer of confirmation before any deletion can occur. ### Step 5: Define Credentials @@ -51,9 +57,9 @@ In the 'Username' field, enter the username or login ID associated with the pass In the 'Password' field, you have two options: 1. Manually type in the desired password. -2. Use the password generation feature by tapping on the icon located at the end of the 'Password' field. - 1. You can also adjust the password parameters, such as length and character types, using the provided options with the password generation settings provided below the password field. - 2. Once satisfied, tap on the icon again to generate a strong and secure password according to your specifications. +2. Use the password generation feature by tapping on the icon at the end of the 'Password' field. + * Adjust password parameters (length, character types) using the options below the password field. + * Tap the icon again to generate a strong, secure password according to your specifications. ### Step 6: Save the Newly Created Password @@ -61,12 +67,12 @@ Saving the Password: Review the details you’ve entered. Once you're satisfied Confirmation: The app will confirm that your password has been saved. It's now securely stored and accessible within the app, ready for use whenever you need it. -![Illustration for: Confirmation: The app will confirm that your password has been saved. It's now securely stored and accessible within the app, ready for use whenever you need it.](https://files.readme.io/7569fe6-Screenshot_2023-11-05_at_14.07.50.png) +![Password saved confirmation screen in the Akeyless mobile app](https://files.readme.io/7569fe6-Screenshot_2023-11-05_at_14.07.50.png) -## Creating a New Password from Akeyless Injection / Autofill Window +## Creating a New Password from Akeyless Injection and Autofill Window -![Illustration for: Creating a New Password from Akeyless Injection / Autofill Window](https://files.readme.io/e26ea04-Screenshot_2023-11-05_at_14.55.06.png) +![New password form in the Akeyless autofill window](https://files.readme.io/e26ea04-Screenshot_2023-11-05_at_14.55.06.png) 1. Access the Autofill or Suggestion Field: When you tap on a password field on a website or app, your mobile device will present you with autofill or suggestion options for previously saved passwords. 2. Initiate New Password Creation: Look for an option within the autofill or suggestion field to create a new password by clicking the "Open Akeyless" button. -3. Follow the steps mentioned previously in the section "Creating a new password from Akeyless Mobile Application" +3. Follow the steps mentioned previously in the section [Creating a New Password from Akeyless Mobile Application](https://docs.akeyless.io/docs/pwm-mobile-create-password#creating-a-new-password-from-akeyless-mobile-application). diff --git a/docs/Password Manager/password-manager-mobile-application/pwm-mobile-create-static-secret.md b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-create-static-secret.md new file mode 100644 index 000000000..c536cb13f --- /dev/null +++ b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-create-static-secret.md @@ -0,0 +1,46 @@ +--- +title: Creating a New Secret + +slug: pwm-mobile-create-static-secret +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +Static secrets let you securely store arbitrary text values, such as API keys, tokens, or notes, alongside your passwords in the Akeyless mobile app. Use the steps below to create one. + +> 📘 **Secret items and password items** +> +> **Secret items** store arbitrary text values such as API keys, tokens, or notes, and support custom key-value fields. **Password items** store structured credentials — a URL, username, and password — and integrate with autofill and OTP. To create a password item instead, see [Creating a New Password](https://docs.akeyless.io/docs/pwm-mobile-create-password). + +## Step 1: Launch the Akeyless Password Manager Mobile App + +Once installed, tap on the Akeyless Password Manager app icon on your mobile device to open it. + +![Akeyless Password Manager app icon on a mobile device home screen](https://files.readme.io/eef7865-IMG_0054.png) + +## Step 2: Start Creating a Static Secret + +1. Tap the orange **+** button. This opens an action sheet with item type options. +2. Select **Static Secret** from the action sheet. +3. Enter a unique and recognizable name in the **Secret Name** field. +4. Optionally, enter a description for the secret. + +## Step 3: Define the Secret Details + +In the **Value** field, enter the sensitive data that you want to store. The field accepts both plain-text and JSON values: use plain text for straightforward data such as a token, note, or API key; use JSON when the secret should store structured key-value data in a single item. + +![Value field in the static secret creation form showing plain-text and JSON options](https://files.readme.io/4bb02a9-IMG_0055.png) + +Optionally, specify the location for the secret by using the drop-down menu to choose the target folder or area. If the required folder does not exist yet, create it inline from the location picker. + +You can also add a description and enable delete protection to reduce the risk of accidental deletion. + +## Step 4: Save the Secret + +Review the secret details and then tap **Save** to create the static secret in Akeyless Password Manager. diff --git a/docs/Password Manager/password-manager-mobile-application/deleting-password.md b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-deleting-password.md similarity index 54% rename from docs/Password Manager/password-manager-mobile-application/deleting-password.md rename to docs/Password Manager/password-manager-mobile-application/pwm-mobile-deleting-password.md index 3d5b19bde..7fc1a52ad 100644 --- a/docs/Password Manager/password-manager-mobile-application/deleting-password.md +++ b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-deleting-password.md @@ -1,5 +1,7 @@ --- -title: Deleting Password +title: Deleting a Password + +slug: pwm-mobile-deleting-password excerpt: '' deprecated: false hidden: false @@ -10,6 +12,8 @@ metadata: next: description: '' --- +Use the following steps to permanently delete a password from the Akeyless mobile app. + ## To Delete a Password from Akeyless Password Manager 1. Open the Akeyless Password Manager application. @@ -17,7 +21,7 @@ next: 3. Click on the three dots next to the password and select Delete. 4. Confirm the deletion in the pop-up window\*. -![Illustration for: To Delete a Password from Akeyless Password Manager](https://files.readme.io/59645e5-Screenshot_2024-01-10_at_16.25.29.png) +![Delete option in the mobile app password actions menu](https://files.readme.io/59645e5-Screenshot_2024-01-10_at_16.25.29.png) ## Alternatively, You Can Delete a Password from the Password Details Screen @@ -27,4 +31,13 @@ next: 4. Click on the Delete button at the bottom of the screen. 5. Confirm the deletion in the pop-up window\*. -![Illustration for: Alternatively, You Can Delete a Password from the Password Details Screen](https://files.readme.io/04ceb63-Screenshot_2024-01-10_at_16.23.13.png) +![Delete button on the password details screen in the mobile app](https://files.readme.io/04ceb63-Screenshot_2024-01-10_at_16.23.13.png) + +## Delete Protection + +If Delete Protection is enabled on a password, you must disable it before you can delete it. + +1. Open the password details. +2. Toggle off **Delete Protection**. +3. Save the password. +4. Follow the deletion steps above. diff --git a/docs/Password Manager/password-manager-mobile-application/pwm-mobile-editing-password-details.md b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-editing-password-details.md new file mode 100644 index 000000000..aee881832 --- /dev/null +++ b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-editing-password-details.md @@ -0,0 +1,54 @@ +--- +title: Editing Password Details + +slug: pwm-mobile-editing-password-details +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +Use the following steps to locate a password and edit its details in the Akeyless mobile app. + +## Locating the Password + +![Password list in the Akeyless mobile app](https://files.readme.io/4d0810c-Screenshot_2024-01-10_at_16.15.37.png) + +1. Open the **Secrets** section. +2. Locate the password item to edit. + +## Access Quick Action Menu + +1. Tap the three-dot menu next to the item. +2. Select **Edit**. + +## Initiate Edit Mode + +Edit mode opens the item fields for update. + +## Observe Edit Mode Transition + +Confirm that **Save** is available before changing data. + +## Make Desired Changes + +Update only the fields required for the change, for example: + +* Password value. +* Username. +* Description. +* Website URL fields. + +## Apply Changes + +1. Review updated values. +2. Tap **Save**. + +## Confirmation of Saved Changes + +1. Confirm the success indication in the app. +2. Reopen the item and verify the updated values. diff --git a/docs/Password Manager/password-manager-mobile-application/pwm-mobile-home-screen-frequently-used-items.md b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-home-screen-frequently-used-items.md new file mode 100644 index 000000000..8119885dd --- /dev/null +++ b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-home-screen-frequently-used-items.md @@ -0,0 +1,45 @@ +--- +title: Home Screen (Frequently Used Items) + +slug: pwm-mobile-home-screen-frequently-used-items +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +Use the Home screen to review high-priority updates and quickly access frequently used items. + +![Akeyless mobile app home screen showing frequently used items](https://files.readme.io/f53004f-Screenshot_2024-04-11_at_15.21.31.png) + +## Feature Cards + +At the top of the Home screen, a swipeable set of feature cards provides quick links to documentation for key Password Manager capabilities: + +* Autofill and password injection +* LDAP authentication +* OIDC authentication +* Password sharing + +Tap a card to open the relevant documentation page within the app. + +## Personal and Corporate Navigation + +Use the Personal or Corporate toggle on the Home screen to switch the displayed area. + +After switching, Home refreshes content for the selected area. + +## Frequently Used Section + +The Frequently Used section shows up to 7 items, ranked by how often they have been accessed. The list updates based on user actions such as: + +* Opening an item's details. +* Using items during injection/autofill flows. +* Copying credential values. +* Sharing items where sharing is supported. + +Tap the collapse icon at the right of the section header to expand or collapse the list. diff --git a/docs/Password Manager/password-manager-mobile-application/pwm-mobile-install-and-sign-in.md b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-install-and-sign-in.md new file mode 100644 index 000000000..a7b7bb42c --- /dev/null +++ b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-install-and-sign-in.md @@ -0,0 +1,63 @@ +--- +title: Install and Sign In to the Akeyless Mobile App + +slug: pwm-mobile-install-and-sign-in +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +The Akeyless Password Manager mobile app is available for Android and iOS. + +## Installation on Your Mobile Devices + +Use the following steps to install and sign in to the mobile app on Android or iOS. + +## Akeyless Password Manager Android Installation + +1. Open [Akeyless Password Manager on Google Play](https://play.google.com/store/apps/details?id=com.akeylessmobile). +2. Tap **Install**. +3. Accept required Android prompts. + +![Akeyless app permissions prompt on Android](https://files.readme.io/528c51e-Screenshot_20240506_171826_Google_Play_Store2.jpg) + +## Akeyless Password Manager iOS Installation + +1. Open [Akeyless Password Manager on the App Store](https://apps.apple.com/us/app/akeyless-password-manager/id6455634292). +2. Tap **Get**. +3. Complete iOS confirmation with Apple ID, Face ID, or Touch ID if prompted. + +![Akeyless app installation confirmation prompt on iOS](https://files.readme.io/9f41004-File_5.jpg) + +## Authentication Methods Support + +Use an authentication method allowed by account policy. + +## VPN Requirement for Zero-Knowledge Keyless Mode + +For environments that require zero-knowledge keyless mode, follow organizational policy for VPN prerequisites before sign-in. + +## Authentication Methods Support + +After installation, open the mobile app and complete sign-in with one of the supported methods: + +* Access-ID and Access-Key: Use your unique Access-ID and Access-Key combination for secure login. +* SAML: Sign in with your configured SAML identity provider. +* OIDC: Sign in with your configured OIDC identity provider. +* LDAP: For environments configured with LDAP, you can authenticate using your LDAP credentials for secure access. + * Configure the [LDAP gateway URL](https://docs.akeyless.io/docs/configure-ldap-gateway-url) by way of advanced settings then login with Email option as a login type. +* Account Alias: Sign in with account alias when enabled by account policy. + +## Post Sign-In Checklist + +1. Open the app Home or Secrets view. +2. Confirm Personal or Corporate area selection. +3. Configure autofill on device if required. +4. Validate access to expected folders and items. + +For more details about Akeyless Authentication Methods please visit this [link](https://docs.akeyless.io/docs/access-and-authentication-methods) diff --git a/docs/Password Manager/password-manager-mobile-application/pwm-mobile-manage-favorites.md b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-manage-favorites.md new file mode 100644 index 000000000..358ee4b5f --- /dev/null +++ b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-manage-favorites.md @@ -0,0 +1,42 @@ +--- +title: Favorites (Add, Remove, and View Items) + +slug: pwm-mobile-manage-favorites +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +Use Favorites to pin frequently used passwords and secrets for faster access. + +![Favorites tab in the Akeyless mobile app](https://files.readme.io/267b625-Screenshot_2024-04-11_at_15.25.13.png) + +## Adding Items to Favorites + +1. Open the item in Personal or Corporate area. +2. Open item actions. +3. Select **Add to Favorites**. + +## Removing Items From Favorites + +1. Open the Favorites tab. +2. Locate the item. +3. Open item actions. +4. Select **Remove from Favorites**. + +## Viewing Favorites + +1. Open the Favorites tab. +2. Review the pinned list. +3. Select an item to open details or actions. + +## Search and Filter Functionality + +1. Open Favorites. +2. Enter a search term in the search bar. +3. Review filtered results. diff --git a/docs/Password Manager/password-manager-mobile-application/pwm-mobile-otp.md b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-otp.md new file mode 100644 index 000000000..515e8cc19 --- /dev/null +++ b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-otp.md @@ -0,0 +1,44 @@ +--- +title: Adding and Using OTP + +slug: pwm-mobile-otp +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +The mobile app supports OTP for saved passwords. You can add OTP values by scanning a QR code or entering the secret manually. + +## Add an OTP by Scanning a QR Code + +1. Navigate to the corporate or personal area where the password is stored. +2. Tap the three-dot menu next to the password entry. +3. Make sure the OTP QR code is visible on the screen in a scannable format. +4. Select **Scan OTP** from the menu. +5. Use the camera to scan the QR code. + +![Three-dot options menu next to a password entry in the mobile app](https://files.readme.io/6da4508-Screenshot_2024-06-16_at_11.17.19.png) + +The OTP value is added as a custom field to the selected password entry. Tap the eye icon next to the custom field to view the current code. + +## Add an OTP Manually + +Use manual entry when the OTP secret is provided as a setup key or `otpauth://`-compatible value instead of a QR code. + +1. Open the Password Manager mobile app and navigate to the saved password. +2. Tap the three-dot menu for the target item. +3. Select **Manual OTP**. +4. Open the password edit screen. +5. Scroll to the **Custom Field** section. +6. Set the field name to `otpauth`. +7. Enter the OTPAuth secret string in the field value. +8. Save the item. + +After saving, the OTP value becomes available for supported OTP-related operations. + +![OTP code added as a custom field to a password entry in the mobile app](https://files.readme.io/2d50b9c-Screenshot_2024-06-16_at_11.16.55.png) diff --git a/docs/Password Manager/password-manager-mobile-application/pwm-mobile-overview.md b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-overview.md new file mode 100644 index 000000000..b49294bde --- /dev/null +++ b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-overview.md @@ -0,0 +1,41 @@ +--- +title: Password Manager Mobile Application + +slug: pwm-mobile-overview +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +The Akeyless Password Manager mobile app is the primary mobile surface for password and static-secret tasks, including autofill and OTP usage. + +## Core Tasks + +Use the mobile section pages to complete these tasks: + +* [Install and sign in](https://docs.akeyless.io/docs/pwm-mobile-install-and-sign-in). +* [Create and edit passwords](https://docs.akeyless.io/docs/pwm-mobile-create-password) and [edit password details](https://docs.akeyless.io/docs/pwm-mobile-editing-password-details). +* [Choose password location and folder hierarchy](https://docs.akeyless.io/docs/pwm-mobile-choose-password-location-folder). +* [Switch Personal and Corporate display modes in list and home views](https://docs.akeyless.io/docs/pwm-mobile-switch-between-folder-and-flat-views) and [use home-screen frequently used items](https://docs.akeyless.io/docs/pwm-mobile-home-screen-frequently-used-items). +* [Configure password-policy behavior](https://docs.akeyless.io/docs/pwm-mobile-setting-password-policy-on-account-level). +* [Use autofill and OTP features](https://docs.akeyless.io/docs/pwm-mobile-autofill-and-password-injection) and [manage OTP](https://docs.akeyless.io/docs/pwm-mobile-otp). +* [Manage favorites and frequently used items](https://docs.akeyless.io/docs/pwm-mobile-manage-favorites) and [review home-screen frequently used items](https://docs.akeyless.io/docs/pwm-mobile-home-screen-frequently-used-items). + +## Cross-Platform Features + +When users switch between mobile and extension experiences, use matching pages: + +* [Mobile create a password](https://docs.akeyless.io/docs/pwm-mobile-create-password) and [Web Extension create a password](https://docs.akeyless.io/docs/pwm-ext-create-password) +* [Mobile create a static secret](https://docs.akeyless.io/docs/pwm-mobile-create-static-secret) and [Web Extension create a static secret](https://docs.akeyless.io/docs/pwm-ext-create-secret) +* [Mobile autofill and injection](https://docs.akeyless.io/docs/pwm-mobile-autofill-and-password-injection) and [Web Extension autofill and injection](https://docs.akeyless.io/docs/pwm-ext-autofill-and-password-injection) +* [Mobile OTP setup](https://docs.akeyless.io/docs/pwm-mobile-otp) and [Web Extension OTP setup](https://docs.akeyless.io/docs/pwm-ext-otp) +* [Mobile password policy settings](https://docs.akeyless.io/docs/pwm-mobile-setting-password-policy-on-account-level) and [Web Extension password policy settings](https://docs.akeyless.io/docs/pwm-ext-setting-password-policy-on-account-level) + +## Tutorial + +Check out our tutorial video on [Using the Akeyless Password Manager Mobile App](https://tutorials.akeyless.io/docs/akeyless-password-manager-mobile-app-for-users). diff --git a/docs/Password Manager/password-manager-mobile-application/pwm-mobile-setting-password-policy-on-account-level.md b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-setting-password-policy-on-account-level.md new file mode 100644 index 000000000..49eed0b50 --- /dev/null +++ b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-setting-password-policy-on-account-level.md @@ -0,0 +1,68 @@ +--- +title: Setting Password Policy + +slug: pwm-mobile-setting-password-policy-on-account-level +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +Use the following steps to view and configure the password generation policy for your account in the Akeyless mobile app. + +## Accessing Password Generator Policy + +![Password Generator Policy button in the mobile app settings](https://files.readme.io/fc0783d-Screenshot_2024-01-10_at_16.21.04.png) + +* Open the Akeyless Password Manager application. +* Navigate to the **More** tab on the bottom navigation menu. + +> 📘 **Note:** +> +> The **Password Generator Policy** option is only visible to admin users. + +* Tap **Password Generator Policy** to open the policy configuration screen. + +## Set the Account-Level Default Policy + +**Character Length:** Set the desired default length for passwords created within your account. + +**Include Uppercase Letters (A-Z):** Check this box to require at least one uppercase letter in the password. If solely selected, the password will consist exclusively of uppercase letters. + +**Include Lowercase Letters (a-z):** Check this box to ensure at least one lowercase letter is included in the password. If solely selected, the password will consist exclusively of lowercase letters. + +**Include Numbers (0-9):** Check this box to mandate at least one numeric character in the password. If solely selected, the password will consist exclusively of numeric characters. + +**Include Special Characters (!@#):** Check this box to ensure at least one special character is included in the password. If solely selected, the password will consist exclusively of special characters. + +By configuring these settings, you establish a standardized default for password generation in your organization's account. Users can still modify parameters during password creation, but the defaults will adhere to the rules you've set. + +## Set the Policy for a Specific Password + +You can also define password rules for an individual password while creating it or editing it later. + +![Password policy settings for an individual password in the mobile app](https://files.readme.io/8b6ade4-Screenshot_2024-01-10_at_16.16.47.png) + +### During Password Creation or Editing + +Use the same password policy controls shown under the password field: + +**Character Length:** Set the required length for the specific password. + +**Include Uppercase Letters (A-Z):** Require at least one uppercase letter. If this is the only enabled option, the password contains only uppercase letters. + +**Include Lowercase Letters (a-z):** Require at least one lowercase letter. If this is the only enabled option, the password contains only lowercase letters. + +**Include Numbers (0-9):** Require at least one number. If this is the only enabled option, the password contains only numbers. + +**Include Special Characters (!@#):** Require at least one special character. If this is the only enabled option, the password contains only special characters. + +### How It Works + +When creating a new password, adjust these settings under the password field before saving. + +When editing an existing password, open the password editing screen and update the same settings to match the new requirements. diff --git a/docs/Password Manager/password-manager-mobile-application/sharing-password.md b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-sharing-password.md similarity index 67% rename from docs/Password Manager/password-manager-mobile-application/sharing-password.md rename to docs/Password Manager/password-manager-mobile-application/pwm-mobile-sharing-password.md index 00501c827..badcea847 100644 --- a/docs/Password Manager/password-manager-mobile-application/sharing-password.md +++ b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-sharing-password.md @@ -1,5 +1,7 @@ --- -title: Sharing Password +title: Sharing a Password + +slug: pwm-mobile-sharing-password excerpt: '' deprecated: false hidden: false @@ -12,7 +14,7 @@ next: --- Akeyless Password Manager allows you to securely share passwords with others. This is useful for granting access to shared accounts or for providing temporary access to a specific password. -![Illustration for: Akeyless Password Manager allows you to securely share passwords with others. This is useful for granting access to shared accounts or for providing temporary access to a…](https://files.readme.io/5308eb5-Screenshot_2024-03-20_at_10.47.42.png) +![Share option in the mobile app password options menu](https://files.readme.io/5308eb5-Screenshot_2024-03-20_at_10.47.42.png) ## To Share a Password @@ -30,7 +32,7 @@ From the displayed pop-up, select Copy Link. This will copy the link to the domain for which you want to share the password. You can then send the link to the user with whom you want to share the password. -![Illustration for: From the displayed pop-up, select Copy Link. This will copy the link to the domain for which you want to share the password. You can then send the link to the user with whom…](https://files.readme.io/62c5b57-Screenshot_2024-03-20_at_10.48.52.png) +![Copy Link option in the sharing pop-up](https://files.readme.io/62c5b57-Screenshot_2024-03-20_at_10.48.52.png) Sharing passwords is simple. Look for the "Share" option within the password details screen, typically found at the bottom of the screen. Selecting this option will initiate the password-sharing process. diff --git a/docs/Password Manager/password-manager-mobile-application/password-list-switching-between-folders-flat-view.md b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-switch-between-folder-and-flat-views.md similarity index 82% rename from docs/Password Manager/password-manager-mobile-application/password-list-switching-between-folders-flat-view.md rename to docs/Password Manager/password-manager-mobile-application/pwm-mobile-switch-between-folder-and-flat-views.md index 30eba19a4..457a0deda 100644 --- a/docs/Password Manager/password-manager-mobile-application/password-list-switching-between-folders-flat-view.md +++ b/docs/Password Manager/password-manager-mobile-application/pwm-mobile-switch-between-folder-and-flat-views.md @@ -1,19 +1,20 @@ ---- -title: Password List Switching Between Folders & Flat View -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -Akeyless supports both folder and flat views for secrets and keys. - -By default, Akeyless is in folder view. - -The folder view organizes secrets and keys into folders and subdirectories. This can be useful for organizing large numbers of secrets and keys, or for grouping secrets and keys by project or team. - -Flat view lists all secrets and keys in a single list, without any folders. This can be useful for quickly finding a specific secret or key, or for viewing all secrets and keys in a single place. +--- +title: Password List Switching Between Folders & Flat View +slug: pwm-mobile-switch-between-folder-and-flat-views +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +Akeyless supports both folder and flat views for secrets and keys. + +By default, Akeyless is in folder view. + +The folder view organizes secrets and keys into folders and subdirectories. This can be useful for organizing large numbers of secrets and keys, or for grouping secrets and keys by project or team. + +Flat view lists all secrets and keys in a single list, without any folders. This can be useful for quickly finding a specific secret or key, or for viewing all secrets and keys in a single place. diff --git a/docs/Password Manager/password-manager-mobile-application/setting-password-policy-on-account-level.md b/docs/Password Manager/password-manager-mobile-application/setting-password-policy-on-account-level.md deleted file mode 100644 index a675921cf..000000000 --- a/docs/Password Manager/password-manager-mobile-application/setting-password-policy-on-account-level.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Setting Password Policy On Account Level -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -## Accessing Password Generation Policy - -![Illustration for: Accessing Password Generation Policy](https://files.readme.io/fc0783d-Screenshot_2024-01-10_at_16.21.04.png) - -Open the Akeyless Password Manager application. - -Navigate to the "More" tab on the bottom navigation menu. - -Press the "More" button to reveal additional options. - -Locate and click on "Password Generation Policy" in the displayed "More" screen. - -A bottom action menu will appear, providing options to configure the password generation policy. - -## Define the Following Parameters - -**Character Length:** Set the desired default length for passwords created within your account. - -**Include Uppercase Letters (A-Z):** Check this box to require at least one uppercase letter in the password. If solely selected, the password will consist exclusively of uppercase letters. - -**Include Lowercase Letters (a-z):** Check this box to ensure at least one lowercase letter is included in the password. If solely selected, the password will consist exclusively of lowercase letters. - -**Include Numbers (0-9):** Check this box to mandate at least one numeric character in the password. If solely selected, the password will consist exclusively of numeric characters. - -**Include Special Characters (!@#):** Check this box to ensure at least one special character is included in the password. If solely selected, the password will consist exclusively of special characters. - -By configuring these settings, you establish a standardized default for password generation in your organization's account. Users can still modify parameters during password creation, but the defaults will adhere to the rules you've set. diff --git a/docs/Password Manager/password-manager-mobile-application/setting-password-policy-on-password-level.md b/docs/Password Manager/password-manager-mobile-application/setting-password-policy-on-password-level.md deleted file mode 100644 index 1ac19f9b8..000000000 --- a/docs/Password Manager/password-manager-mobile-application/setting-password-policy-on-password-level.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Setting Password Policy On Password Level -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -In our Password Manager application, you have the flexibility to define specific password policies for individual passwords during creation or editing. This ensures that your security requirements align with the uniqueness of each password. - -![Illustration for: In our Password Manager application, you have the flexibility to define specific password policies for individual passwords during creation or editing. This ensures that your…](https://files.readme.io/8b6ade4-Screenshot_2024-01-10_at_16.16.47.png) - -## During Password Creation or Editing - -**Character Length: Get the desired length for the specific password. This defines the number of characters it should contain. -**Include Uppercase Letters (A-Z):** Check this box if you want the password to include at least one uppercase letter. If solely selected, the password will exclusively consist of uppercase letters. -**Include Lowercase Letters (a-z):** Check this box to ensure the inclusion of at least one lowercase letter in the password. If solely selected, the password will exclusively consist of lowercase letters. -**Include Numbers (0-9):** Check this box to mandate at least one numeric character in the password. If solely selected, the password will exclusively consist of numeric characters. -**Include Special Characters (!@#):** Check this box to ensure at least one special character is part of the password. If solely selected, the password will exclusively consist of special characters. - -## How It Works - -### Creating a New Password - -When creating a new password, find these options under the password field. Adjust the settings based on your specific requirements, and the password will be generated accordingly. - -### Editing an Existing Password - -If you need to update the password policy for an existing password, navigate to the password editing screen. Here, you'll find the same options under the password field to tailor the policy as needed. diff --git a/docs/Password Manager/password-manager-mobile-application/using-autofill-and-password-injection-functionality/_order.yaml b/docs/Password Manager/password-manager-mobile-application/using-autofill-and-password-injection-functionality/_order.yaml deleted file mode 100644 index 19a2ce395..000000000 --- a/docs/Password Manager/password-manager-mobile-application/using-autofill-and-password-injection-functionality/_order.yaml +++ /dev/null @@ -1,2 +0,0 @@ -- set-autofill-for-android-devices -- for-ios-devices diff --git a/docs/Password Manager/password-manager-mobile-application/using-autofill-and-password-injection-functionality/for-ios-devices.md b/docs/Password Manager/password-manager-mobile-application/using-autofill-and-password-injection-functionality/for-ios-devices.md deleted file mode 100644 index 0d72ed69f..000000000 --- a/docs/Password Manager/password-manager-mobile-application/using-autofill-and-password-injection-functionality/for-ios-devices.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Enabling Autofill in iOS Settings -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' - pages: - - type: basic - slug: set-autofill-for-android-devices - title: Enabling Autofill Functionality on Android ---- -## Configuring Autofill With Akeyless Password Manager - -Before using Akeyless Password Manager for autofill, you must grant it permission in your device's settings. Here's a more detailed step-by-step process: - -![Illustration for: Configuring Autofill With Akeyless Password Manager Before using Akeyless Password Manager for autofill, you must grant it permission in your device's settings. Here's a more…](https://files.readme.io/c9de03a-File_2.jpg) - -1. Locate and open the "Settings" app on your iOS device. - -2. Depending on your iOS version: - - * For iOS 13 or earlier, scroll down and tap on **Passwords & Accounts**. - - * For iOS 14 and later, scroll down and select **Passwords**. This might also appear as **Passwords & Accounts** in some versions. - -3. Find the **Autofill Passwords** option and tap it. This is where you can manage which apps have permission to use autofill for passwords. - -4. You'll see a toggle switch at the top of the **Autofill Passwords** screen. Switch it to the `ON` position (green) to enable the autofill feature. - -5. Under the **Allow Filling From** section, you will see a list of applications that can autofill passwords. Ensure that Akeyless Password Manager is checked. If you have multiple password managers installed, you can select more than one, but for optimal performance, it's recommended to have just one selected for autofill to avoid conflicts. - -## Using Autofill With Akeyless Password Manager - -With autofill enabled, Akeyless Password Manager can seamlessly fill in your passwords, making logging into websites and apps faster and more secure. Here's how to use it: - -![Illustration for: With autofill enabled, Akeyless Password Manager can seamlessly fill in your passwords, making logging into websites and apps faster and more secure.](https://files.readme.io/c309879-File_3.jpg) - -1. When you navigate to a login page on Safari or within any application, your device will automatically prompt you to fill in your credentials. This prompt might appear above the keyboard or within login fields, indicating that autofill is available. - -2. Tap on the prompt or the key icon to view your saved credentials. If you have multiple entries for the same website or app, they'll be listed here for you to choose from. - -3. Depending on your device settings, you might be required to authenticate using Face ID, to access your saved passwords. This extra layer of security ensures that only you can access your credentials. - -4. After authentication, select the appropriate login credential. Akeyless Password Manager will autofill your username and password. Simply proceed to log in. diff --git a/docs/Password Manager/password-manager-mobile-application/using-autofill-and-password-injection-functionality/index.md b/docs/Password Manager/password-manager-mobile-application/using-autofill-and-password-injection-functionality/index.md deleted file mode 100644 index 6d54fc651..000000000 --- a/docs/Password Manager/password-manager-mobile-application/using-autofill-and-password-injection-functionality/index.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: Using Autofill and Password Injection Functionality -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' - pages: - - type: basic - slug: for-ios-devices - title: Set Autofill For iOS Devices ---- -Enable the autofill feature in the Password Manager app. This will allow the app to autofill your login credentials in websites and apps. - -There are two ways to enable it: - -During the installation process, the user will be prompted to enable the autofill functionality immediately after a successful login. - -Once the Password Manager app is installed, users will be prompted to enable the autofill functionality to automatically fill in their login credentials in websites and apps. - -To autofill your login credentials in a website or app, tap on the username and password fields. The Password Manager app will automatically suggest your saved login credentials. - -Select your saved login credentials from the suggestions. The Password Manager app will autofill your login credentials in the username and password fields diff --git a/docs/Password Manager/password-manager-mobile-application/using-autofill-and-password-injection-functionality/set-autofill-for-android-devices.md b/docs/Password Manager/password-manager-mobile-application/using-autofill-and-password-injection-functionality/set-autofill-for-android-devices.md deleted file mode 100644 index ec60ea580..000000000 --- a/docs/Password Manager/password-manager-mobile-application/using-autofill-and-password-injection-functionality/set-autofill-for-android-devices.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: Enabling Autofill Functionality on Android -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -## Enabling Akeyless Password Manager for Autofill - -1. Open Settings on Your Android Device: Navigate to your device's main Settings menu. You can find the Settings app in your app drawer or by pulling down the notification shade and tapping the gear icon. - -2. In the Settings menu, scroll down and select **System**. This may vary slightly depending on your Android version; for some devices, you may need to look for **General Management** or simply **Languages & Input**. - -3. Within the **System** menu, find and select **Languages & Input**. On some devices, this might be directly under the main settings menu. - -4. Tap on **Autofill service** under the **Languages & Input** settings. This option might also be listed as **Autofill** in some Android versions. - -5. A list of available autofill services will appear. Select **Akeyless Password Manager** from the list to set it as your default autofill service. If Akeyless Password Manager is not listed, ensure you have installed the app from the Google Play Store. - -## Launch Akeyless Password Manager - -1. Open the Akeyless Password Manager app on your device. - - ![Illustration for: Launch Akeyless Password Manager 1. Open the Akeyless Password Manager app on your device.](https://files.readme.io/00ee37b-Screenshot_20240221_185956_Settings.jpg) - -2. Once inside the app, locate the settings or preferences section. This is usually accessed by way of a menu in the top right corner or by selecting your profile icon. - -3. In the settings menu, look for an option related to autofill, such as "Autofill Service" or "Enable Autofill." Follow the prompts to enable autofill functionality with Akeyless Password Manager. - -## Using Autofill With Akeyless Password Manager - -1. When logging into an app or website, tap on the login field. The Akeyless Password Manager autofill popup should appear, suggesting login credentials for that site. If you do not see the popup, tap the key icon in your navigation bar or above the keyboard. - - ![Illustration for: 1. When logging into an app or website, tap on the login field. The Akeyless Password Manager autofill popup should appear, suggesting login credentials for that site. If you…](https://files.readme.io/229e403-Screenshot_20240221-112137_Firefox.jpg) - -2. Choose the appropriate account or login details from the Akeyless Password Manager suggestions. Your username and password will be automatically filled into the login fields. - -3. If autofill suggestions do not appear automatically, you can manually trigger autofill by tapping and holding the login field, then selecting "Autofill" from the menu. Choose Akeyless Password Manager from the list of autofill services if prompted. - -4. After your credentials are automatically filled, proceed with any additional login steps required by the app or website. - -## Top Mobile Browsers Featuring Comprehensive Autofill Capabilities - -* Firefox: [Install from Google Play](https://play.google.com/store/apps/details?id=org.mozilla.firefox) -* Firefox Focus: [Install from Google Play](https://play.google.com/store/apps/details?id=org.mozilla.focus) -* Microsoft Edge: [Install from Google Play](https://play.google.com/store/apps/details?id=com.microsoft.emmx) -* DuckDuckGo: [Install from Google Play](https://play.google.com/store/apps/details?id=com.duckduckgo.mobile.android) -* Brave: [Install from Google Play](https://play.google.com/store/apps/details?id=com.brave.browser) - -### Browsers Offering Partial Autofill Support - -* Chrome: [Install from Google Play](https://play.google.com/store/apps/details?id=com.android.chrome) - -> ℹ️ **Note:** -> -> The Google Chrome browser is equipped with Autofill capabilities; however, users may occasionally encounter inconsistencies in its performance. In certain instances, it may be necessary to close and subsequently reopen the Chrome browser to achieve the desired Autofill functionality. To ensure an optimal user experience, we advise considering the use of one of the mobile browsers highlighted previously. These alternatives have been identified for their robust and reliable Autofill support, catering to the needs of users seeking seamless digital interactions. diff --git a/docs/Password Manager/password-manager-overview.md b/docs/Password Manager/password-manager-overview.md index e6c7742b2..2f9edcef5 100644 --- a/docs/Password Manager/password-manager-overview.md +++ b/docs/Password Manager/password-manager-overview.md @@ -1,5 +1,7 @@ --- title: Password Manager Overview + +slug: pwm-overview excerpt: '' deprecated: false hidden: false @@ -10,30 +12,35 @@ metadata: next: description: '' --- -## Introduction - -Akeyless transcends conventional password management by offering a comprehensive platform that securely stores, manages, generates, and shares passwords. Users will have unparalleled flexibility, choosing to save passwords within their personal folders for exclusive use or opting for shared spaces within the account to facilitate seamless collaboration among team members. - -![Akeyless Screenshot](https://files.readme.io/f851fd0-Screenshot_2024-02-18_at_10.27.50.png) - -In the realm of collaborative password management, Akeyless stands out by empowering users to effortlessly share access to specific passwords within the team, thereby enhancing overall productivity. This shared environment ensures that crucial credentials are readily available to authorized team members, eliminating bottlenecks associated with traditional password-sharing methods. +Akeyless Password Manager provides a unified way to store, manage, and use passwords and related credentials across browser extension, mobile app, and web console experiences. -For users on the move, Akeyless provides the added convenience of a mobile Password Manager application, extending its capabilities beyond the desktop environment. The **mobile app** allows users to access and manage their passwords anytime, anywhere, ensuring that critical information is at their fingertips. This not only enhances flexibility but also reinforces the security of sensitive data by providing a secure and portable solution. +![Akeyless Password Manager web console overview](https://files.readme.io/f851fd0-Screenshot_2024-02-18_at_10.27.50.png) -The Akeyless **browser extension** remains a powerful tool, streamlining the process of injecting stored passwords directly into corresponding websites. This not only saves time but also bolsters security by minimizing the need for manual entry. The extension seamlessly integrates into the user's workflow, offering an efficient solution for managing passwords on the go. +Password Manager can: -![Akeyless Browser Extension Screenshot](https://files.readme.io/2c80505-Screenshot_2024-05-06_at_17.24.19.png) +* Install and sign in to the web extension and mobile app. +* Create and manage passwords and static secrets. +* Use autofill, OTP, and passkey workflows. +* Configure account and client-side password settings. +* Review Security Health insights and related admin flows. -Furthermore, the Akeyless browser extension extends its utility beyond mere password injection. It acts as a dynamic tool for capturing and saving passwords in real time, ensuring that no password is left unsecured. This feature is particularly useful in scenarios where users need to rapidly save newly generated or updated passwords without disrupting their workflow. +![Akeyless Password Manager browser extension](https://files.readme.io/2c80505-Screenshot_2024-05-06_at_17.24.19.png) -In essence, Akeyless is not just a password management system; it's a robust solution that adapts to the diverse needs of individuals and teams. Whether safeguarding personal passwords or collaborating within a team, Akeyless provides the tools and features needed to navigate the complex landscape of digital security with ease and confidence, including the added convenience of a mobile Password Manager application for users on the move. +## Choose a Platform -Akeyless revolutionizes your password management experience by establishing seamless and bidirectional integration between the console, mobile app, and extension. This innovative synergy ensures that any password meticulously created within the console becomes instantly and effortlessly accessible from the extension, and conversely, passwords generated in the extension seamlessly synchronize with the console. +Explore these pages based on where users need passwords: -The Akeyless extension, a powerful and intuitive companion to the console, introduces a transformative dimension to your on-the-go password management practices. Picture effortlessly saving passwords as you traverse the digital landscape and then seamlessly injecting them into websites with unparalleled ease. The extension emerges as your indispensable tool for real-time password handling, catering to the needs of users constantly in motion. +* [Web Extension](https://docs.akeyless.io/docs/pwm-ext-overview) +* [Mobile Application](https://docs.akeyless.io/docs/pwm-mobile-overview) +* [Web Console](https://docs.akeyless.io/docs/pwm-console-overview) -Contrastingly, the console serves as the centralized hub, providing a comprehensive and panoramic view of your password landscape. Beyond mere storage, it empowers you to delve into the intricacies of your password ecosystem, offering a suite of features that enable you to not only view but also systematically sort and manage your credentials with a level of clarity and precision that redefines the standards of password management. +## Common Workflows -The console's robust capabilities extend far beyond basic storage functions, cultivating a sophisticated environment where you can conduct insightful analyses, categorize passwords, and optimize your overall password strategy. Its intuitively designed interface facilitates seamless navigation through your digital key repository, providing valuable insights into your password habits and enabling proactive measures for an elevated level of security. +For common tasks, start here: -In essence, Akeyless transcends conventional password management solutions, presenting a harmonious and integrated ecosystem where the console and extension work in tandem to meet the multifaceted needs of users. Whether you're dynamically saving passwords on the move with the extension or engaging in a meticulous fine-tuning of your password strategy within the console, Akeyless ensures a unified, comprehensive, and sophisticated approach to password management, redefining the landscape of digital security. +* [Web Extension installation and sign-in](https://docs.akeyless.io/docs/pwm-ext-install-and-sign-in) and [Mobile installation and sign-in](https://docs.akeyless.io/docs/pwm-mobile-install-and-sign-in) +* [Web Extension create a password](https://docs.akeyless.io/docs/pwm-ext-create-password) and [Mobile create a password](https://docs.akeyless.io/docs/pwm-mobile-create-password) +* [Web Extension create a static secret](https://docs.akeyless.io/docs/pwm-ext-create-secret) and [Mobile create a static secret](https://docs.akeyless.io/docs/pwm-mobile-create-static-secret) +* [Web Extension autofill and injection](https://docs.akeyless.io/docs/pwm-ext-autofill-and-password-injection) and [Mobile autofill and injection](https://docs.akeyless.io/docs/pwm-mobile-autofill-and-password-injection) +* [Web Extension OTP workflows](https://docs.akeyless.io/docs/pwm-ext-otp) and [Mobile OTP workflows](https://docs.akeyless.io/docs/pwm-mobile-otp) +* [Web Extension Security Health](https://docs.akeyless.io/docs/pwm-ext-security-health) and [Web Console Security Health](https://docs.akeyless.io/docs/pwm-console-security-health) diff --git a/docs/Password Manager/password-manager-web-console/_order.yaml b/docs/Password Manager/password-manager-web-console/_order.yaml index cd1bc78dc..92b411ec4 100644 --- a/docs/Password Manager/password-manager-web-console/_order.yaml +++ b/docs/Password Manager/password-manager-web-console/_order.yaml @@ -1,4 +1,3 @@ -- password-manager-web-console-for-admin -- password-manager-web-console-for-employees -- security-health -- password-manager-hide-personal-folder +- pwm-console-overview +- pwm-console-admin-usage-report +- pwm-console-hide-personal-folder diff --git a/docs/Password Manager/password-manager-web-console/index.md b/docs/Password Manager/password-manager-web-console/index.md deleted file mode 100644 index 3db4186f0..000000000 --- a/docs/Password Manager/password-manager-web-console/index.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Password Manager Web Console -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -## As an Admin - -The Akeyless Password Manager Console provides a comprehensive overview of all user accounts, roles, and permissions within the organization. This centralized hub enables you to efficiently manage user access privileges, define granular permissions, and enforce security policies. - -The console also offers powerful tools for auditing and monitoring user activity, ensuring that your organization's password management practices adhere to compliance requirements. Additionally, the console's intuitive interface facilitates seamless integration with third-party systems, such as CI/CD pipelines and IT service management (ITSM) platforms. - -Here are some of the key features of the Akeyless Password Manager Console for admins: - -* Centralized user management: Create, manage, and delete user accounts, assign roles and permissions, and enforce security policies. -* Audit and monitoring: Track user activity, identify anomalies, and generate reports for compliance purposes. -* Third-party integrations: Seamlessly integrate with CI/CD pipelines and ITSM platforms to automate password management workflows. -* Role-Based Access Control (RBAC): Define granular permissions and assign roles to users based on their specific needs. -* Security policies: Implement and enforce security policies, such as password rotation and multi-factor authentication (MFA). - -## As a User - -The Akeyless Password Manager Console provides a convenient and secure way to store, manage, and access your passwords. The console's intuitive interface makes it easy to create, edit, and delete passwords, as well as organize them into folders and categories. - -The console also offers a variety of features to help you strengthen your password security, such as password generation, password rotation, and password sharing. Additionally, the console integrates with the Akeyless browser extension, allowing you to automatically inject saved passwords into websites with ease. - -Here are some of the key features of the Akeyless Password Manager Console for regular users: - -* Secure password storage: Encrypt and store your passwords in a secure vault. -* Easy password management: Create, edit, and delete passwords with ease. -* Password organization: Organize passwords into folders and categories. -* Strong password generation: Generate strong, unique passwords for all your accounts. -* Password sharing: Share passwords securely with authorized team members. -* Browser extension integration: Automatically inject saved passwords into websites with the Akeyless browser extension. diff --git a/docs/Password Manager/password-manager-web-console/password-manager-web-console-for-admin/_order.yaml b/docs/Password Manager/password-manager-web-console/password-manager-web-console-for-admin/_order.yaml deleted file mode 100644 index c8f3a0c9e..000000000 --- a/docs/Password Manager/password-manager-web-console/password-manager-web-console-for-admin/_order.yaml +++ /dev/null @@ -1 +0,0 @@ -- password-manager-usage-report-for-admins diff --git a/docs/Password Manager/password-manager-web-console/password-manager-web-console-for-admin/index.md b/docs/Password Manager/password-manager-web-console/password-manager-web-console-for-admin/index.md deleted file mode 100644 index 65cc80ea9..000000000 --- a/docs/Password Manager/password-manager-web-console/password-manager-web-console-for-admin/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: Password Manager Web Console For Admins -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -## Effortless Password Management for Enterprises With Akeyless - -As an admin user of the Akeyless Password Manager web console, you understand the importance of secure and efficient password management for your organization. Akeyless's enterprise-grade password management solution caters to the needs of businesses of all sizes, providing a powerful yet easy-to-use platform that doesn't require an IT department for implementation and management. - -## Robust Security for Your Business-Critical Data - -Akeyless prioritizes security, ensuring that your business-critical passwords and secrets are protected with industry-leading encryption and access control mechanisms. The platform's patented Distributed Fragments Cryptography™ technology fragments and distributes sensitive data across multiple geographically dispersed servers, rendering it inaccessible even in the event of a breach. - -## Effortless Administration and User Onboarding - -Akeyless simplifies administration, empowering you to manage passwords and access permissions with ease. The intuitive web console provides a centralized interface for creating and managing users, defining Access Roles, and auditing password activities. User onboarding is a breeze, with self-service password resets and multi-factor authentication options ensuring a secure and seamless user experience. - -## Scalability to Meet Your Growing Needs - -Akeyless is designed to scale alongside your business, seamlessly adapting to your growing password management needs. The platform's elastic architecture can accommodate any volume of passwords and secrets, ensuring that you're always prepared for future growth. - -## Comprehensive Password Management for Enterprise Success - -Akeyless offers a comprehensive suite of password management features, including: - -* Centralized Password Storage: Store and manage all passwords in a single, secure location. -* [Role-Based Access Control (RBAC)](https://docs.akeyless.io/docs/rbac): Define granular access permissions to control who can access specific passwords and secrets. -* [Dynamic Secrets](https://docs.akeyless.io/docs/how-to-create-dynamic-secret): Automatically rotate and update passwords for privileged accounts, eliminating the need for manual intervention. -* Password Injection: Seamlessly inject passwords into websites and applications using the Akeyless browser extension. -* [Audit Logging](https://docs.akeyless.io/docs/audit-logs): Track all password activities and user access for comprehensive auditing and compliance purposes. - -## Empower Your Team With Secure and Efficient Password Management - -With Akeyless, you can empower your team to manage passwords securely and efficiently, without sacrificing productivity. The platform's intuitive interface and user-friendly features make it easy for everyone to adopt Akeyless, streamlining password management across the organization. - -## Effortless Administration for Busy Admins - -Akeyless takes the burden off IT admins, providing effortless administration tools that make password management a breeze. The centralized web console, self-service password resets, and automated password rotation capabilities save valuable time and resources, allowing admins to focus on more strategic initiatives. - -## Akeyless: The Enterprise-Grade Password Management Solution - -Akeyless is an enterprise-grade password management solution that empowers businesses to secure their sensitive data, streamline password management, and enhance productivity. With its robust security features, effortless administration, and comprehensive password management capabilities, Akeyless is the ideal choice for businesses of all sizes. - -## Establish Your Akeyless Team - -Embark on your Akeyless journey by creating your [Akeyless account](https://docs.akeyless.io/docs/account-settings). Upon account creation, you'll be designated as the account owner/administrator, wielding full administrative privileges. - -## Fortify Your Akeyless Ecosystem With Enforced Security Policies - -Safeguard your organization's sensitive data by enforcing robust security policies within Akeyless. Dictate password strength requirements, manage two-factor [authentication](https://docs.akeyless.io/docs/auth-overview) protocols, define [access restrictions](https://docs.akeyless.io/docs/rbac), [monitor usage](https://docs.akeyless.io/docs/audit-logs), and mandate regular updates across all devices. - -## Granular Control Over Akeyless Access - -Exert granular control over your team's access to Akeyless by leveraging comprehensive policy management capabilities. Define [access permissions](https://docs.akeyless.io/docs/rbac) based on roles and responsibilities, ensuring that users only have access to the information they need. - -## Unified Akeyless Experience Across Devices - -Maintain a consistent and secure experience for your team by enforcing regular updates to the Akeyless [browser extension](https://docs.akeyless.io/docs/password-manager-web-extension) and [mobile application](https://docs.akeyless.io/docs/password-manager-mobile-application) across all devices. This ensures that your team always has access to the latest security features and protection. - -## Securely Share Secrets With Anyone, Anytime - -Akeyless empowers you to securely [share Static Secrets](https://docs.akeyless.io/docs/sharing-static-secrets) with anyone, even if they're not Akeyless users or part of your organization. Define a well-defined time-to-live (TTL) for each shared secret, ensuring that access expires after the specified period. - -## Add a Sub-administrator - -Akeyless's robust RBAC (Role-Based Access Control) model empowers you to [delegate some of your account owner's permissions](https://docs.akeyless.io/docs/sub-admins) to other trusted users. This flexible approach enables you to distribute administrative tasks and responsibilities effectively, ensuring that the right people have the right access to manage your Akeyless environment. - -## Tutorial - -Check out our tutorial video on [Configuring the Akeyless Password Manager as an Admin](https://tutorials.akeyless.io/docs/akeyless-password-manager-admins). diff --git a/docs/Password Manager/password-manager-web-console/password-manager-web-console-for-admin/password-manager-usage-report-for-admins.md b/docs/Password Manager/password-manager-web-console/password-manager-web-console-for-admin/password-manager-usage-report-for-admins.md deleted file mode 100644 index 9179caf74..000000000 --- a/docs/Password Manager/password-manager-web-console/password-manager-web-console-for-admin/password-manager-usage-report-for-admins.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Password Manager Usage Report for Admins -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -This report provides administrators with a comprehensive overview of user interaction with the password management system. It is designed to help admins monitor usage patterns, assess security protocols, and ensure efficient management of user credentials. - -## Overview of the Report - -The Password Manager Usage Report delivers critical metrics that help in understanding how the organization's password management system is being used. Below are the key components of the report: - -1. **Overall User Base** - This metric provides a quick snapshot of the total number of users or clients who are actively using the password management system. - -2. **Total Number of Passwords** - Displays the total count of passwords stored within the system. This number reflects the cumulative security entries managed by the Password Manager. - -3. **Total Users by Authentication Method** - 1. Metric Description: This section counts and categorizes the total number of users based on their chosen authentication method. - 2. Authentication Methods Covered: - 1. SAML (Security Assertion Markup Language): For users authenticated through SAML-based identity providers. - 2. OIDC (OpenID Connect): Reflects users leveraging this modern authentication protocol built on top of OAuth 2.0. - 3. LDAP (Lightweight Directory Access Protocol): For users authenticated by way of traditional directory services. - 4. EMAIL: Users who use email-based authentication. - Access ID: A unique identifier used for authentication within the system. - -![Illustration for: 3. LDAP (Lightweight Directory Access Protocol): For users authenticated by way of traditional directory services. 4. EMAIL: Users who use email-based authentication. Access ID:…](https://files.readme.io/217ef18-Screenshot_2024-05-13_at_10.30.17.png) diff --git a/docs/Password Manager/password-manager-web-console/password-manager-web-console-for-employees.md b/docs/Password Manager/password-manager-web-console/password-manager-web-console-for-employees.md deleted file mode 100644 index 53c32fefa..000000000 --- a/docs/Password Manager/password-manager-web-console/password-manager-web-console-for-employees.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Password Manager Web Console For Users (Non Admin) -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -## Initiate the Setup on Your Preferred Web Browser - -To start on your Akeyless journey, follow these steps to initiate the setup process using your preferred web browser: - -* Launch Your Web Browser: Open your preferred web browser, such as Google Chrome, Mozilla Firefox, or Microsoft Edge. -* Navigate to Akeyless Sign-In Page: Access the Akeyless sign-in page by entering the provided URL in your web browser's address bar. -* Enter Your Credentials: Enter your Akeyless account credentials, including your username and password. Ensure that the credentials are accurate and correspond to your Akeyless account. -* Initiate Setup Process: Upon entering your credentials, click the "Sign In" button to initiate the setup process. Akeyless will guide you through the setup steps, providing clear instructions and prompts. -* Complete Setup: Follow the on-screen instructions to complete the setup process. This may involve configuring your preferred Akeyless settings, enabling two-factor authentication, and installing the [Akeyless browser extension](https://docs.akeyless.io/docs/password-manager-web-extension). - -Get to know your [Personal and Corporate folders](https://docs.akeyless.io/docs/personal-corporate-favorites-areas-navigation) - -* Your Personal Folder: A Secure Haven for Personal Passwords - * Store work-related passwords that you don't need to share with your team, like your work email password, in your Personal Folder. This Personal Folder keeps your sensitive information secure and protected. -* Corporate Folder: A Collaborative Hub for Team Access - * The Corporate Folder serves as a central repository for passwords that your entire team needs to access. Store items like GitHub passwords in the Corporate Folder, ensuring everyone has the necessary credentials. - -## Start the Process on Your iOS or Android Device - -To start on your Akeyless journey using your iOS/Android device, follow these steps to initiate the setup process: - -* Install Akeyless App: Download and install the Akeyless app from the [Apple App Store or Google Play Store](https://docs.akeyless.io/docs/installation-of-akeyless-mobile-application). Search for "Akeyless" and tap the "Get" button to install the app on your iOS device. -* Launch Akeyless App: Once the installation is complete, launch the Akeyless app by tapping on its icon on your iOS/Android device's home screen. -* Initiate Setup Process: Upon opening the Akeyless app, you will be prompted to initiate the setup process. -* Enter Your Credentials: Enter your Akeyless account credentials, which will include the Access ID you've received from your administrator. -* Authenticate and Complete Setup: Follow the on-screen instructions to authenticate your identity and complete the setup process, which will include allowing the Akeyless app to be the autofill service. - -## Tutorial - -Check out our tutorial video on [Using the Akeyless Password Manager Web Extension](https://tutorials.akeyless.io/docs/akeyless-password-manager-web-extension). diff --git a/docs/Password Manager/password-manager-web-console/pwm-console-admin-usage-report.md b/docs/Password Manager/password-manager-web-console/pwm-console-admin-usage-report.md new file mode 100644 index 000000000..6f4d57a13 --- /dev/null +++ b/docs/Password Manager/password-manager-web-console/pwm-console-admin-usage-report.md @@ -0,0 +1,82 @@ +--- +title: Password Manager Usage Report for Admins + +slug: pwm-console-admin-usage-report +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +Use the Password Manager Usage Report to review adoption and authentication usage trends. + +## Overview of the Report + +The report includes these core metrics: + +1. **Overall user base** + Total active users. + +2. **Total number of passwords** + Total stored password items. + +3. **Users by authentication method** + Counts users by sign-in type, including SAML, OIDC, LDAP, and Email or Access ID based login. + +## How to Interpret the Metrics + +Use these patterns during review: + +* Growing user base with flat password totals can indicate low vault adoption. +* High reliance on one sign-in method can indicate limited SSO diversification. +* Unexpected sign-in distribution changes can indicate policy or rollout changes. + +## Recommended Admin Actions + +1. Compare usage report values across review periods. +2. Identify low-adoption teams. +3. Validate configured authentication methods against policy. +4. Coordinate onboarding or policy updates where needed. + +## Exporting Report Data + +The report data can be exported and consumed programmatically in two ways. + +### JSON Export + +The report header includes an **Export as JSON** option. Selecting it downloads a file named `PasswordManagerReport.json`. + +The exported file contains the following top-level fields: + +| Field | Description | +| --- | --- | +| `time` | Unix timestamp (milliseconds) of the export | +| `clientsByMonth` | Monthly user counts, keyed by month label | +| `clientsByAuthMethods` | Per auth-method breakdown with `actual` (active) and `total` (including exceeded) counts | +| `secretsByMonth` | Monthly password and secret item counts, keyed by month label | +| `secretByTypes` | Breakdown of item counts by secret type | + +Use this export to feed the data into external dashboards, reporting pipelines, or spreadsheet tooling. + +### Usage Event Notifications + +Admins can configure an automated threshold alert that fires when the Password Manager client count reaches a set value. + +To configure it: + +1. Open the Usage Report in the Password Manager console. +2. From the options menu in the report header, select **Set Usage Event**. +3. Enter a **Clients Limit** value (the threshold at which the alert fires). +4. Save the setting. + +When the account's active client count reaches the configured threshold, Akeyless emits a `usage-report` event through the Event Center. The event message reads: + +> Your account has reached _N_ clients in Password Manager. + +Route this event to any configured notification target (email, Slack, webhook, and so on) using the Event Center forwarder settings. + +![Password Manager usage report showing authentication method breakdown](https://files.readme.io/217ef18-Screenshot_2024-05-13_at_10.30.17.png) diff --git a/docs/Password Manager/password-manager-web-console/password-manager-hide-personal-folder.md b/docs/Password Manager/password-manager-web-console/pwm-console-hide-personal-folder.md similarity index 89% rename from docs/Password Manager/password-manager-web-console/password-manager-hide-personal-folder.md rename to docs/Password Manager/password-manager-web-console/pwm-console-hide-personal-folder.md index c2d00ad39..6c83f494a 100644 --- a/docs/Password Manager/password-manager-web-console/password-manager-hide-personal-folder.md +++ b/docs/Password Manager/password-manager-web-console/pwm-console-hide-personal-folder.md @@ -1,5 +1,7 @@ --- title: Hide Personal Folder + +slug: pwm-console-hide-personal-folder excerpt: '' deprecated: false hidden: false @@ -10,11 +12,9 @@ metadata: next: description: '' --- -## Overview - The Hide Personal Folder feature provides administrators with the ability to control the visibility of the Personal Folder for end users. This setting is accessible through a simple toggle in the Akeyless Password Manager console, and is also configurable by way of the [CLI](https://docs.akeyless.io/docs/cli-reference#update-account-settings). -This feature is designed to simplify the user interface and restrict access to components that may not be relevant for certain users. +Use this control to enforce organization-wide folder visibility policy. ## Behavior diff --git a/docs/Password Manager/password-manager-web-console/pwm-console-overview.md b/docs/Password Manager/password-manager-web-console/pwm-console-overview.md new file mode 100644 index 000000000..c9d6e3b6c --- /dev/null +++ b/docs/Password Manager/password-manager-web-console/pwm-console-overview.md @@ -0,0 +1,83 @@ +--- +title: Password Manager Web Console + +slug: pwm-console-overview +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +The Password Manager web console provides administration and security reporting tools for managing Password Manager at the account level. + +## As a User + +For day-to-day password creation, autofill, OTP, and passkey tasks, the primary user surfaces are the web extension and mobile app. + +Use these pages as the primary user entry points: + +* [Web Extension overview](https://docs.akeyless.io/docs/pwm-ext-overview) +* [Mobile Application overview](https://docs.akeyless.io/docs/pwm-mobile-overview) + +### Browser Setup + +1. Open your browser. +2. Sign in to your Akeyless tenant. +3. Open the Password Manager extension. +4. Complete prompts shown for your account policy. + +For next steps, see: + +* [Extension install and sign-in](https://docs.akeyless.io/docs/pwm-ext-install-and-sign-in) +* [Personal and corporate navigation](https://docs.akeyless.io/docs/pwm-ext-navigate-personal-corporate-favorites) +* [Folder navigation](https://docs.akeyless.io/docs/pwm-ext-folder-navigation-within-personal-corporate-areas) + +### Mobile Setup + +1. Install the mobile app from the platform app store. +2. Open the app and sign in. +3. Allow required permissions for autofill and secure access. +4. Select Personal or Corporate area based on your task. + +Use these mobile pages next: + +* [Mobile install and sign-in](https://docs.akeyless.io/docs/pwm-mobile-install-and-sign-in) +* [Choose password location](https://docs.akeyless.io/docs/pwm-mobile-choose-password-location-folder) +* [Mobile autofill](https://docs.akeyless.io/docs/pwm-mobile-autofill-and-password-injection) + +### Personal and Corporate Areas + +Use Personal when credentials are private to your user account. Use Corporate when credentials must be shared according to organizational policy. + +### Tutorial + +Check out our tutorial video on [Using the Akeyless Password Manager Web Extension](https://tutorials.akeyless.io/docs/akeyless-password-manager-web-extension). + +## As an Admin + +The Password Manager web console provides password-focused visibility for admins, with emphasis on Security Health and usage-oriented monitoring tasks. + +Use the admin pages in this section for: + +* [Security Health review and risk follow-up](https://docs.akeyless.io/docs/pwm-console-security-health) +* [Usage-report access for password-management activity](https://docs.akeyless.io/docs/pwm-console-admin-usage-report) +* [Personal-folder visibility control where applicable](https://docs.akeyless.io/docs/pwm-console-hide-personal-folder) + +For broader account administration topics such as global RBAC and non-Password-Manager settings, use the administration sections outside this Password Manager area. + +### Related Administration Topics + +Use these pages when configuration extends beyond Password Manager-specific views: + +* [RBAC policy model](https://docs.akeyless.io/docs/rbac) +* [Account settings](https://docs.akeyless.io/docs/account-settings) +* [Audit logs](https://docs.akeyless.io/docs/audit-logs) +* [Sub-admin delegation](https://docs.akeyless.io/docs/sub-admins) + +### Admin Tutorial + +Check out our tutorial video on [Configuring the Akeyless Password Manager as an Admin](https://tutorials.akeyless.io/docs/akeyless-password-manager-admins). diff --git a/docs/Password Manager/password-manager-web-console/security-health.md b/docs/Password Manager/password-manager-web-console/security-health.md deleted file mode 100644 index 9b895aca8..000000000 --- a/docs/Password Manager/password-manager-web-console/security-health.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: Security Health -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -## Overview - -The Security Health Dashboard provides users with an overview of the strength and security of their stored passwords, offering real-time insights, improvement suggestions, and critical metrics that help maintain strong password hygiene. This document outlines the layout, functionality, scoring metrics, and API integrations to ensure a comprehensive understanding of the security health features. - -![Illustration for: The Security Health Dashboard provides users with an overview of the strength and security of their stored passwords, offering real-time insights, improvement suggestions, and…](https://files.readme.io/c51dd3e02752d51b5d79e21377a2cc21270b2bb98962f694dacc5674b4347a87-Screenshot_2024-09-21_at_7.32.19.png) - -## Dashboard Layout - -1. **Upper Section: Gauges** - This section contains visual gauges that display the overall health of passwords: - - * Security Score Gauge: Represents an overall security score for all stored passwords. This score is a composite of various factors such as length, complexity, and rotation policy. The gauge's colors range from red (low score) to green (high score). - * Weak Passwords Gauge: Displays the number of weak passwords as a fraction of the total passwords. Weak passwords are identified based on their lack of complexity and length. - * Breached Passwords Gauge: Shows the number of passwords that have been compromised in known breaches. This gauge helps users identify vulnerable passwords that should be updated or replaced immediately. - -2. **Lower Section: Password List** - Below the gauges is a detailed table listing all passwords, providing users with key information and actionable suggestions: - - * Password Location: The service or app where the password is used. - * Name of the Password: The name or identifier for the password. - * Score: A graphical representation of the password's strength (For example, weak, medium, strong). - * Suggestion: Provides recommendations for improving password strength. - * Last Updated: The date when the password was last changed. - -## Enhanced Filtering Options - -Users can apply filters to view specific types of passwords: - -* Filter by Weak Passwords: Filters the list to show only weak passwords. -* Filter by Breached Passwords: Filters the list to show passwords that have appeared in known breaches. -* Filter by Update Required Passwords: Filters passwords that need to be updated based on their age or vulnerability. - -## Toggle for Password Score Feature - -A toggle button has been added to allow users to enable or disable the password score feature in their account settings: - -* **Toggle Button:** Located under "Password Management," the button controls whether the password score is displayed. -* **Default Setting:** The feature is disabled by default. -* **Functionality:** When enabled, password scores are calculated and displayed; when disabled, scores are hidden. - -## Compromised Password Check - -As part of our Password Manager’s Security Health evaluation, we incorporate checks against external databases of known compromised credentials. Specifically, we leverage the “Have I Been Pwned” database, which aggregates publicly disclosed password breaches. - -This integration allows us to: - -* Verify password exposure: Determine whether a given password has appeared in any known data breach, including those circulating on the dark web. -* Measure reuse risk: Identify how many times the same password has been exposed across different breaches, highlighting patterns of weak or reused credentials. -* Enhance scoring accuracy: Incorporate the exposure and reuse metrics into the overall Password Manager Security Health score, providing a more accurate and risk-aware assessment of each user’s password hygiene. diff --git a/docs/Password Manager/password-manager-web-extension/_order.yaml b/docs/Password Manager/password-manager-web-extension/_order.yaml index 964853839..e1618aeac 100644 --- a/docs/Password Manager/password-manager-web-extension/_order.yaml +++ b/docs/Password Manager/password-manager-web-extension/_order.yaml @@ -1,21 +1,23 @@ -- installation-of-akeyless-web-extension -- creating-new-password-1 -- creating-new-secret -- editing-password-details-1 -- setting-password-policy-on-account-level-1 -- setting-password-policy-on-password-level-1 -- sharing-password-1 -- deleting-password-1 -- personal-corporate-favorites-areas-navigation -- folder-navigation-within-personal-corporate-areas-1 -- password-list-switching-between-folders-flat-view-1 -- using-filters-tags -- using-search -- using-autofillpassword-injection-functionality-1 -- configure-customspecific-tenant -- copypaste-functionality-for-passwords-1 -- configure-ldap-gateway-url-1 -- adding-password-to-favorites-1 -- csv-password-importer -- adding-and-using-otp-1 -- passkey +- pwm-ext-overview +- pwm-ext-install-and-sign-in +- pwm-ext-advanced-options +- pwm-ext-configure-custom-specific-tenant +- pwm-ext-configure-ldap-gateway-url +- pwm-ext-enterprise-distribution-preconfigured-authentication +- pwm-ext-setting-password-policy-on-account-level +- pwm-ext-navigate-personal-corporate-favorites +- pwm-ext-folder-navigation-within-personal-corporate-areas +- pwm-ext-switch-between-folder-and-flat-views +- pwm-ext-managing-favorites +- pwm-ext-search-passwords-and-secrets +- pwm-ext-use-filters-and-tags +- pwm-ext-create-password +- pwm-ext-editing-password-details +- pwm-ext-copy-and-paste-passwords +- pwm-ext-sharing-password +- pwm-ext-deleting-password +- pwm-ext-create-secret +- pwm-ext-csv-password-importer +- pwm-ext-autofill-and-password-injection +- pwm-ext-otp +- pwm-ext-passkey diff --git a/docs/Password Manager/password-manager-web-extension/adding-and-using-otp-1/_order.yaml b/docs/Password Manager/password-manager-web-extension/adding-and-using-otp-1/_order.yaml deleted file mode 100644 index 8a3fcbd79..000000000 --- a/docs/Password Manager/password-manager-web-extension/adding-and-using-otp-1/_order.yaml +++ /dev/null @@ -1 +0,0 @@ -- adding-manual-otp diff --git a/docs/Password Manager/password-manager-web-extension/adding-and-using-otp-1/adding-manual-otp.md b/docs/Password Manager/password-manager-web-extension/adding-and-using-otp-1/adding-manual-otp.md deleted file mode 100644 index 3c3e3ab63..000000000 --- a/docs/Password Manager/password-manager-web-extension/adding-and-using-otp-1/adding-manual-otp.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Adding Manual OTP -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -Users often receive OTP Auth secrets as strings instead of complete QR codes or full OTP Auth links. This feature allows users to manually input these secrets into the Password Manager extension, where they will be decoded and integrated as functional OTP authentication methods. - -## Accessing the Feature - -* Navigate to the Password Manager Extension: Open the Password Manager extension in your browser. -* Open the Menu: Click on the three dots menu within the extension. -* Select "Manual OTP": From the dropdown menu, choose the "Manual OTP" option. - -## Entering OTPAuth Secret - -* Password Edit Screen: After selecting "Manual OTP," you will be redirected to a password edit screen. -* Custom Field Pop-up: A pop-up for creating a custom field will appear above the password edit screen. -* Field Name: The pop-up includes a field labeled `otpauth`. -* Setup Key Option: There is an option to enter the setup key associated with the OTPAuth secret. -* Input Secret: Enter the OTPAuth secret into the designated field. - -![Illustration for: Setup Key Option: There is an option to enter the setup key associated with the OTPAuth secret. Input Secret: Enter the OTPAuth secret into the designated field.](https://files.readme.io/8ad8ef4-Screenshot_2024-08-19_at_16.25.10.png) - -![Illustration for: Setup Key Option: There is an option to enter the setup key associated with the OTPAuth secret. Input Secret: Enter the OTPAuth secret into the designated field.](https://files.readme.io/2a2137f-Screenshot_2024-08-19_at_14.43.54.png) diff --git a/docs/Password Manager/password-manager-web-extension/adding-and-using-otp-1/index.md b/docs/Password Manager/password-manager-web-extension/adding-and-using-otp-1/index.md deleted file mode 100644 index 09336b8fc..000000000 --- a/docs/Password Manager/password-manager-web-extension/adding-and-using-otp-1/index.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: Adding and Using One-Time Passwords -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -Locate the Password: Navigate to the corporate or personal area where the desired password is stored. - -Open Options Menu: Click the three dots button next to the password entry to open the options menu. - -![Illustration for: Locate the Password: Navigate to the corporate or personal area where the desired password is stored. Open Options Menu: Click the three dots button next to the password entry…](https://files.readme.io/ba937b7-Screenshot_2024-06-16_at_11.01.45.png) - -Prepare OTP for Scanning: Ensure that the OTP (One-Time Password) code is visible on the screen in a scannable format. - -Scan OTP: Select the "Scan OTP" option from the menu. - -Verify Addition: The OTP code will be added as a custom field to the selected password entry. - -Access OTP Code: You can view the OTP code by clicking the eye icon next to the custom field. - -![Illustration for: Verify Addition: The OTP code will be added as a custom field to the selected password entry. Access OTP Code: You can view the OTP code by clicking the eye icon next to the…](https://files.readme.io/f962648-Screenshot_2024-06-16_at_11.08.08.png) diff --git a/docs/Password Manager/password-manager-web-extension/adding-password-to-favorites-1.md b/docs/Password Manager/password-manager-web-extension/adding-password-to-favorites-1.md deleted file mode 100644 index c46d91fe7..000000000 --- a/docs/Password Manager/password-manager-web-extension/adding-password-to-favorites-1.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Adding Password To Favorites -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -The Akeyless Web Extension offers a convenient feature allowing users to mark their frequently used secrets or passwords as favorites. This functionality enables quick access to your most important items. The following guide will walk you through the process of adding secrets or passwords to your favorites and managing them within the web extension. - -![Illustration for: The Akeyless Web Extension offers a convenient feature allowing users to mark their frequently used secrets or passwords as favorites. This functionality enables quick access…](https://files.readme.io/313aa73-Screenshot_2024-03-21_at_14.07.31.png) - -## Step 1: Locate the Secret or Password - -* Open the Akeyless Web Extension by clicking on its icon in your browser's toolbar. This action will display your stored secrets and passwords. -* Navigate through your list or use the search function to find the specific secret or password you want to add to your favorites. - -## Step 2: Add to Favorites - -* Once you have located the item you wish to favorite, hover over the secret or password entry in the list. A star icon will appear next to the item name. -* Click on the star icon. This action marks the item as a favorite. You will notice that the star becomes filled, indicating that the item is now in your favorites list. - -## Step 3: Access Favorites - -* To view your favorites, navigate to the Favorites tab within the Akeyless Web Extension. This tab consolidates all your favorite secrets and passwords in one place, allowing for quicker access. -* In the Favorites tab, you can easily find and manage your most important items without sifting through the entire list of stored secrets and passwords. - -## Step 4: Remove from Favorites - -![Illustration for: Step 4: Remove from Favorites](https://files.readme.io/daa2c75-Screenshot_2024-03-21_at_14.08.18.png) - -* If you decide to remove an item from your favorites, go to the Favorites tab and locate the item you wish to remove. -* Hover over the item, and you will see the star icon appear again next to the item name. The star will be filled, indicating that it is currently a favorite. -* Click on the filled star icon. This action removes the item from your favorites list. The star will become unfilled, confirming that the item is no longer marked as a favorite. - -## Managing Favorites - -The favorites feature in the Akeyless Web Extension is designed to make your digital life more manageable and secure. By marking items as favorites, you ensure quick access to your most used secrets and passwords, enhancing your workflow and productivity. Remember, you can add or remove items from your favorites at any time, tailoring the list to meet your current needs and preferences. diff --git a/docs/Password Manager/password-manager-web-extension/configure-customspecific-tenant.md b/docs/Password Manager/password-manager-web-extension/configure-customspecific-tenant.md deleted file mode 100644 index 44914709e..000000000 --- a/docs/Password Manager/password-manager-web-extension/configure-customspecific-tenant.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Configure Custom/Specific Tenant -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -This innovative feature enables users to personalize their web browser extension by configuring a custom or specific tenant URL. This customization is designed to tailor the user's browsing experience, allowing for a more streamlined and secure access to web services that are specific to their organizational or personal needs. By setting up a unique tenant URL, users can ensure that their extension directly connects to the desired services or databases, enhancing both efficiency and security. - -![Illustration for: This innovative feature enables users to personalize their web browser extension by configuring a custom or specific tenant URL. This customization is designed to tailor the…](https://files.readme.io/72e4da3-Screenshot_2024-03-20_at_11.10.38.png) - -## Detailed Instructions for Configuring Your Custom/Specific Tenant URL - -Initiation of Configuration Process: Begin the customization by navigating to the sign-in screen of your web browser extension. Look for the three-dot menu icon, which is conveniently located in the top right corner of the extension's interface. This menu is the gateway to adjusting the extension's settings to better suit your individual requirements or preferences. - -## Entering the Custom/Specific Tenant URL - -After accessing the settings through the menu, you will find a dedicated text field for entering the tenant URL. This is where you should input the URL that corresponds to your specific tenant. The tenant URL is a crucial link between your browser extension and the web services it interacts with, dictating how the extension authenticates and connects to these services. It's important to input this URL carefully to ensure a seamless and secure connection. - -## Saving Your Configuration - -Once you have entered the correct tenant URL, finalize the setup by clicking the "Save" button. This action solidifies your settings, applying the custom tenant URL to your browser extension. With this configuration in place, your extension will now automatically use the specified tenant URL for all relevant operations, offering a more customized and secure browsing experience. - -Click "Save". diff --git a/docs/Password Manager/password-manager-web-extension/configure-ldap-gateway-url-1.md b/docs/Password Manager/password-manager-web-extension/configure-ldap-gateway-url-1.md deleted file mode 100644 index c0b843f65..000000000 --- a/docs/Password Manager/password-manager-web-extension/configure-ldap-gateway-url-1.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Configure LDAP gateway URL -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -This functionality empowers users to customize their web browser extension with a specific LDAP gateway URL, streamlining access management and enhancing security protocols. By integrating an LDAP gateway, users can leverage centralized authentication services, facilitating a seamless sign-in experience across multiple platforms. - -## Step-by-Step Guide to Configuring Your LDAP Gateway URL - -![Illustration for: Step-by-Step Guide to Configuring Your LDAP Gateway URL](https://files.readme.io/51e6e76-Screenshot_2024-02-25_at_14.48.30.png) - -Initiate Configuration: Begin by navigating to the sign-in screen of your web browser extension. Look for the three-dot menu icon situated in the upper right corner of the interface. This menu is your gateway to modifying extension settings and personalizing your browsing experience. - -## Enter the LDAP Gateway URL - -Upon accessing the settings menu, locate the text field designated for the LDAP gateway URL. This field is where you will input the URL of your LDAP server. The LDAP gateway acts as a bridge, connecting your browser extension to the LDAP server, which manages user credentials and access rights. Carefully enter the URL, ensuring accuracy, as this will dictate the success of the integration. - -## Save Your Settings - -![Illustration for: Save Your Settings](https://files.readme.io/2914cb3-Screenshot_2024-02-25_at_14.47.48.png) - -After entering the LDAP gateway URL, finalize your configuration by clicking the "Save" button. This action commits your settings to the browser extension, activating the LDAP gateway connection. Upon successful configuration, your extension will communicate with the LDAP server for authentication purposes, streamlining the sign-in process and bolstering security measures. diff --git a/docs/Password Manager/password-manager-web-extension/copypaste-functionality-for-passwords-1.md b/docs/Password Manager/password-manager-web-extension/copypaste-functionality-for-passwords-1.md deleted file mode 100644 index 6750d1fe4..000000000 --- a/docs/Password Manager/password-manager-web-extension/copypaste-functionality-for-passwords-1.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: Copy/Paste Functionality for Passwords -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -Our Password Manager app includes a convenient copy/paste feature, allowing you to securely transfer passwords from the app to web forms. - -## Copying the Password - -1. Tap on the password field next to the desired password. -2. Look for a 'Copy' icon or button. -3. Tap this icon. -4. The password will be copied to your device's clipboard. - -## Pasting the Password into a Web Form - -1. Switch to the web browser or app where you need to enter the password. -2. Tap on the password entry field. -3. Select 'Paste' to insert the password from the clipboard. diff --git a/docs/Password Manager/password-manager-web-extension/creating-new-password-1.md b/docs/Password Manager/password-manager-web-extension/creating-new-password-1.md deleted file mode 100644 index 29f692843..000000000 --- a/docs/Password Manager/password-manager-web-extension/creating-new-password-1.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: Creating New Password -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -## Step 1: Launch the Akeyless Web Extension - -1. Once installed, the Akeyless Web Extension icon will appear in your browser's toolbar. -2. Click on the Akeyless Web Extension icon to launch the extension. - -![Illustration for: Step 1: Launch the Akeyless Web Extension 1. Once installed, the Akeyless Web Extension icon will appear in your browser's toolbar. 2. Click on the Akeyless Web Extension icon…](https://files.readme.io/33368d1-Screenshot_2023-11-14_at_19.10.15.png) - -## Step 2: Access the Password Creation Form - -![Illustration for: Step 2: Access the Password Creation Form](https://files.readme.io/9d80c86-Screenshot_2024-02-22_at_14.22.38.png) - -Click on the "New Item" button. This will open the Akeyless Password Creation form. - -Enter a name for the password in the "Password Name" field. - -Optionally, enter a description for the password in the "Description" field. - -Optionally, Click on the "Generate Password" button. This will generate a strong and secure password or you can enter the password manually. - -## Step 3: Define Password Name and Location - -In the "Password Name" field, enter a unique and easily recognizable name for the password. - -Optionally, you can specify the "Password Location" using the drop-down menu. to choose between "Corporate" and "Personal" areas to store the password. - -If you want to store the password in a folder, you can create a new folder by providing the name in the location field. - -![Illustration for: Optionally, you can specify the "Password Location" using the drop-down menu. to choose between "Corporate" and "Personal" areas to store the password. If you want to store the…](https://files.readme.io/d75a38d-Screenshot_2024-02-22_at_14.22.54.png) - -## Step 4: Enhance Security and Add Context - -In the "Description" field, you can optionally provide additional details about the password, such as the associated website, service, or application. - -To safeguard the password from accidental or unauthorized deletion, select the "Delete Protection" checkbox. - -## Step 5: Generate and Save the Password - -Click on the "Generate Password" button. - -The Akeyless Web Extension will generate a strong and secure password according to your predefined preferences. - -Once satisfied, click on the "Save" button. - -The Akeyless Web Extension will securely store the password and automatically fill it into the password field. - -## Step 6: Access Saved Passwords - -To access saved passwords, click on the Akeyless Web Extension icon in your browser's toolbar. - -The Akeyless Web Extension Password Manager will open, displaying a list of your saved passwords. - -Click on the desired password to view its details or copy it to your clipboard. - -## Password Strength Policy - -The "Password Strength Policy" feature is like the guardian at the gate, ensuring that users' passwords meet the organization's security standards. - -![Illustration for: Password Strength Policy The "Password Strength Policy" feature is like the guardian at the gate, ensuring that users' passwords meet the organization's security standards.](https://files.readme.io/91fa4a2-Screenshot_2024-04-11_at_14.21.32.png) - -Users can customize their password strength policies, but, they can't go below the minimum standards set by the organization. - -Password Strength Policy indicator will ensure that while allowing users to set their password strength, they will only be able to set a password that is stronger than the policy set by the company. - -Password Strength Evaluation Criteria: - -### Green: Strong Password - -Password length is at the minimum or more of the length defined by the organization - -Meets at least 3 of the other 4 criteria (uppercase, lowercase, numbers, special characters) - -### Yellow: Medium Password - -Password length is lower than the length defined by the organization - -Meets at least 2 of the other 4 criteria (uppercase, lowercase, numbers, special characters) - -### Red: Weak Password - -Fails to meet the criteria for either green or yellow diff --git a/docs/Password Manager/password-manager-web-extension/creating-new-secret/_order.yaml b/docs/Password Manager/password-manager-web-extension/creating-new-secret/_order.yaml deleted file mode 100644 index e70a19470..000000000 --- a/docs/Password Manager/password-manager-web-extension/creating-new-secret/_order.yaml +++ /dev/null @@ -1 +0,0 @@ -- creating-new-secret-value-type diff --git a/docs/Password Manager/password-manager-web-extension/creating-new-secret/creating-new-secret-value-type.md b/docs/Password Manager/password-manager-web-extension/creating-new-secret/creating-new-secret-value-type.md deleted file mode 100644 index 958733273..000000000 --- a/docs/Password Manager/password-manager-web-extension/creating-new-secret/creating-new-secret-value-type.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Creating New Secret Value Type -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -![An Akeyless Password Manager Screenshot of adding a Static Secret.](https://files.readme.io/0f66be8-Screenshot_2024-03-21_at_13.50.36.png) - -The Akeyless Password Manager Web Extension is designed to accommodate a variety of secret types. One of the key features is the flexibility of the 'Value' field, which can store information not just in plain text but also in JSON format. This section will guide you on how to use the 'Value' field for both text and JSON data. - -## Text Data - -For straightforward text data, such as passwords, secure notes, or API keys, simply enter the information directly into the 'Value' field. The application will securely encrypt and store this text, making it accessible only to authorized users. - -## JSON Data - -The 'Value' field can also store structured data in JSON format. This is particularly useful for storing configuration settings or multiple pieces of related information in a structured and easily retrievable form. - -![Illustration for: The 'Value' field can also store structured data in JSON format. This is particularly useful for storing configuration settings or multiple pieces of related information in a…](https://files.readme.io/55cdb8e-Screenshot_2024-03-21_at_13.50.43.png) diff --git a/docs/Password Manager/password-manager-web-extension/creating-new-secret/index.md b/docs/Password Manager/password-manager-web-extension/creating-new-secret/index.md deleted file mode 100644 index dad606892..000000000 --- a/docs/Password Manager/password-manager-web-extension/creating-new-secret/index.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Creating New Secret -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -## Step 1: Launch the Akeyless Web Extension - -1. Once installed, the Akeyless Web Extension icon will appear in your browser's toolbar. -2. Click on the Akeyless Web Extension icon to launch the extension. - -![Illustration for: Step 1: Launch the Akeyless Web Extension 1. Once installed, the Akeyless Web Extension icon will appear in your browser's toolbar. 2. Click on the Akeyless Web Extension icon…](https://files.readme.io/8a3048e-Screenshot_2024-02-22_at_14.23.10.png) - -## Step 2: Access the Password Creation Form - -Click on the "New Item" button. This will open the Akeyless Password Creation form. - -Go to the Static Secret tab. - -Enter a name for the password in the "Secret Name" field - -Optionally, enter a description for the secret in the "Description" field. - -## Step 3: Define Var and Location - -In the `Var` field, enter a unique combination of letters, symbols, and numbers. The value length should be 16 KB. - -![Illustration for: Step 3: Define Var and Location In the Var field, enter a unique combination of letters, symbols, and numbers. The value length should be 16 KB.](https://files.readme.io/774a6f9-Screenshot_2024-02-22_at_14.23.19.png) - -Optionally, you can specify the "Password Location" using the drop-down menu. to choose between "Corporate" and "Personal" areas to store the password. - -If you want to store the password in a folder, you can create a new folder by providing the name in the location field. diff --git a/docs/Password Manager/password-manager-web-extension/csv-password-importer.md b/docs/Password Manager/password-manager-web-extension/csv-password-importer.md deleted file mode 100644 index de9046dad..000000000 --- a/docs/Password Manager/password-manager-web-extension/csv-password-importer.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: CSV Password Importer -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -The "CSV Password Import" feature allows users to seamlessly import passwords from a CSV file directly through the web extension. This feature supports a straightforward import process, enabling users to efficiently upload password data either to personal or corporate areas within the Password Manager. - -## How to Use the CSV Password Import Feature - -Step 1: Access the Web Extension Settings - -* Open the web extension from your browser toolbar. -* Navigate to the 'Settings' option within the extension menu. - -![Illustration for: Step 1: Access the Web Extension Settings Open the web extension from your browser toolbar. Navigate to the 'Settings' option within the extension menu.](https://files.readme.io/522836b-Screenshot_2024-07-01_at_16.09.35.png) - -Step 2: Initiate the Import Process - -* In the Settings menu, locate and click on the "Import from CSV" button to start the import procedure. - -Step 3: Define CSV File Format - -* Ensure your CSV file is prepared according to the required format. The standard format should include columns such as 'Account Name', 'Username', 'Password', and other necessary details. - -Step 4: Select the CSV File - -* Click on the file selection button to browse and choose the desired CSV file from your local storage. - -Step 5: Choose Import Location - -* Select where the passwords will be imported: choose either the 'Personal' or 'Corporate' areas within the Password Manager. - -Step 6: Create a Dedicated Folder - -* Specify if you wish to create a dedicated folder within the target location by entering a folder name in the 'Target Folder Field'. - -![Illustration for: Step 6: Create a Dedicated Folder Specify if you wish to create a dedicated folder within the target location by entering a folder name in the 'Target Folder Field'.](https://files.readme.io/8898628-Screenshot_2024-06-04_at_14.52.18.png) - -Step 7: Submit the Import - -* Once all settings are configured and the file is ready, click the 'Submit' button to finalize the import process. - -![Illustration for: Specify if you wish to create a dedicated folder within the target location by entering a folder name in the 'Target Folder Field'. Step 7: Submit the Import Once all…](https://files.readme.io/97988b1-Screenshot_2024-06-04_at_14.52.11.png) diff --git a/docs/Password Manager/password-manager-web-extension/deleting-password-1.md b/docs/Password Manager/password-manager-web-extension/deleting-password-1.md deleted file mode 100644 index 269a71bc0..000000000 --- a/docs/Password Manager/password-manager-web-extension/deleting-password-1.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: Deleting Password / Secret -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -There are two ways to delete passwords and secrets using the Akeyless Password Manager web browser extension: - -## Method 1: Using the Quick Action Menu - -![Illustration for: Method 1: Using the Quick Action Menu](https://files.readme.io/62cf452-Screenshot_2024-01-10_at_16.46.49.png) - -Hover over the password or secret you want to delete in the password or secrets list. - -A small menu will appear. - -Click on the three dots icon to open the quick action menu. - -Select the "Delete" option. - -A pop-up window will appear asking you to confirm that you want to delete the password or secret. - -Click on the "Delete" button. - -The password or secret will be deleted. - -![Illustration for: A pop-up window will appear asking you to confirm that you want to delete the password or secret. Click on the "Delete" button. The password or secret will be deleted.](https://files.readme.io/cc914f5-Screenshot_2024-01-10_at_16.47.07.png) - -## Method 2: Using the Delete Action Button - -Open the password or secret item you want to delete. - -Scroll down to the bottom of the page. - -Click on the "Delete" button. - -A pop-up window will appear asking you to confirm that you want to delete the password or secret. - -Click on the "Delete" button. - -The password or secret will be deleted. - -## Additional Note - -Once a password or secret is deleted, it cannot be recovered. diff --git a/docs/Password Manager/password-manager-web-extension/editing-password-details-1.md b/docs/Password Manager/password-manager-web-extension/editing-password-details-1.md deleted file mode 100644 index 21b4340ef..000000000 --- a/docs/Password Manager/password-manager-web-extension/editing-password-details-1.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: Editing Password / Secret Details -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -Access Quick Editing Menu: Identify the specific secret you wish to edit within the secrets/passwords list. Click on the three dots icon located next to the secret to reveal the quick editing menu. - -![Illustration for: Access Quick Editing Menu: Identify the specific secret you wish to edit within the secrets/passwords list. Click on the three dots icon located next to the secret to reveal…](https://files.readme.io/b3b9c11-Screenshot_2024-01-10_at_16.40.36.png) - -Locate the Secret: Navigate to the "Secrets"/"Passwords" section of the Akeyless browser extension to view a list of your saved secrets. - -Initiate Edit Mode: From the quick editing menu, select the "Edit" option. This will trigger edit mode for the chosen secret. - -Make Desired Changes: Use the available fields to modify the secret information as needed. - -![Illustration for: Initiate Edit Mode: From the quick editing menu, select the "Edit" option. This will trigger edit mode for the chosen secret. Make Desired Changes: Use the available fields…](https://files.readme.io/e0c4908-Screenshot_2024-01-10_at_16.41.08.png) - -Apply Changes: Once you have made the necessary edits, click the "Save" button to permanently apply your modifications. - -Confirmation of Saved Changes: The Akeyless browser extension will save your changes to the secret, ensuring that your updated information is securely stored. diff --git a/docs/Password Manager/password-manager-web-extension/folder-navigation-within-personal-corporate-areas-1.md b/docs/Password Manager/password-manager-web-extension/folder-navigation-within-personal-corporate-areas-1.md deleted file mode 100644 index 57f5b3cee..000000000 --- a/docs/Password Manager/password-manager-web-extension/folder-navigation-within-personal-corporate-areas-1.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: Folder Navigation within Personal & Corporate Areas -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -## Navigating Within the Folder Hierarchy - -The Akeyless Password Manager web browser extension allows you to organize your passwords and secrets into folders. This can be a helpful way to keep your passwords and secrets organized and easy to find. - -![Illustration for: The Akeyless Password Manager web browser extension allows you to organize your passwords and secrets into folders. This can be a helpful way to keep your passwords and secrets…](https://files.readme.io/b0ea2f8-Screenshot_2024-01-10_at_16.49.31.png) - -To navigate within the folder hierarchy, you can use the following methods: - -## Using the Folder Tree - -The folder tree is located on the left side of the Personal and Corporate Areas. The folder tree displays a list of all of your folders. To open a folder, simply click on the folder name. - -## Using the Back Arrow - -The back arrow is located in the top left corner of the Personal and Corporate Areas. The back arrow allows you to go back to the previous folder in the folder hierarchy. diff --git a/docs/Password Manager/password-manager-web-extension/index.md b/docs/Password Manager/password-manager-web-extension/index.md deleted file mode 100644 index 97d157b57..000000000 --- a/docs/Password Manager/password-manager-web-extension/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Password Manager Web Extension -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -## Introduction - -### Empowering Seamless Password Management With Akeyless Browser Extension - -In today's digital landscape, managing an ever-growing array of passwords and sensitive information can be a daunting task. Introducing the Akeyless browser extension, your gateway to streamlined password management and enhanced security. This powerful tool seamlessly integrates with your Akeyless account, enabling you to access, use, and securely store your credentials with unparalleled ease. - -### Unleash the Convenience of On-the-Go Access - -Whether you're working remotely or simply away from your primary device, the Akeyless browser extension ensures you're never without your crucial password information. With a few clicks, you can access and use select items from your Akeyless account, empowering you to stay productive and connected wherever you go. - -### Securely Inject Passwords Into Remote Access Sessions - -Maintaining secure connections is paramount in today's interconnected world. The Akeyless browser extension seamlessly integrates with Secure Remote Access sessions, enabling you to inject passwords directly into these sessions without compromising your credentials. This added layer of security safeguards your sensitive information and protects your privacy. - -### Experience the Power of Akeyless Browser Extension - -With its intuitive interface, user-friendly features, and unwavering commitment to security, the Akeyless browser extension stands out as an indispensable tool for managing your passwords and sensitive information. Download the extension today and embark on a journey of effortless password management and enhanced security. - -## Tutorial - -Check out the tutorial video on [Using the Akeyless Password Manager Web Extension](https://tutorials.akeyless.io/docs/akeyless-password-manager-web-extension). diff --git a/docs/Password Manager/password-manager-web-extension/installation-of-akeyless-web-extension.md b/docs/Password Manager/password-manager-web-extension/installation-of-akeyless-web-extension.md deleted file mode 100644 index f61b98f09..000000000 --- a/docs/Password Manager/password-manager-web-extension/installation-of-akeyless-web-extension.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: Password Manager Web Extension -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -## Installation Across Browsers - -The Akeyless browser extension seamlessly integrates with your favorite web browsers, including Firefox, Google Chrome, and Microsoft Edge. The installation process is straightforward and consistent across all supported browsers, ensuring a smooth and hassle-free experience. - -> ℹ️ **Note (Installing Akeyless Extensions with SRA Support):** -> -> * To install the web extension for Akeyless Password Manager, please search for "**Akeyless Password Manager**" in your browser's extension store. -> * If you require the web extension that supports SRA, search for "**Akeyless Password Manager**" instead. - -## Akeyless Password Manager Firefox Installation - -Supported Firefox: desktop version 91.1.0 or later. - -To embark on a journey of effortless password management on Firefox, follow these simple steps: - -1. Launch Firefox: Open your Firefox browser and navigate to the Firefox Add-ons website, [link](https://addons.mozilla.org/en-US/firefox/addon/akeyless-sra/). -2. Search for Akeyless: In the search bar at the top of the page, type "Akeyless" and press Enter. -3. Locate Akeyless Extension: From the search results, identify the Akeyless browser extension and click on the "Add to Firefox" button. -4. Grant Permissions: Review the permissions requested by the extension and click on the "Add" button to proceed. -5. Pin Extension for Quick Access: For convenient access, right-click on the Akeyless icon in the toolbar and select "Pin" to keep it permanently visible. - -> ℹ️ **Note:** -> -> **After installing or updating the Akeyless Password Manager extension on the Firefox browser**, please follow these steps to ensure all functionalities work as expected: -> -> 1. Open the Extensions Manager: Go to the Firefox menu, select Add-ons and Themes > Extensions. -> 2. Locate the Akeyless Password Manager Extension: Under the Enabled section, click the three dots (...) next to the extension. -> 3. Verify Permissions: Select Manage and ensure the "Access your data for all websites" permission is enabled. -> 4. Confirm Settings: The toggle switch should be turned on for this permission. - -## Akeyless Password Manager Google Chrome Installation - -![Illustration for: Akeyless Password Manager Google Chrome Installation](https://files.readme.io/3d3d29c-Screenshot_2024-05-07_at_16.02.38.png) - -Elevate your password management efficiency within Google Chrome by following these steps: - -Supported Google Chrome: Version 88+ - -1. Open Chrome Web Store: Launch your Google Chrome browser and access the Chrome Web Store, [link](https://chromewebstore.google.com/search/akeyless?hl=en-US). -2. Search for Akeyless: In the search bar at the top of the page, type "Akeyless" and press Enter. -3. Choose Akeyless Extension: From the search results, identify the Akeyless browser extension and click on the "Add to Chrome" button. -4. Review and Confirm Installation: Review the extension's requested permissions and click on the "Add extension" button to proceed. -5. Pin Extension for Easy Access: For convenient access, right-click on the Akeyless icon in the toolbar and select "Pin" to keep it permanently visible. - -## Akeyless Password Manager Microsoft Edge Installation - -Supported Microsoft Edge: Version 88+ - -Experience the transformative power of Akeyless on Microsoft Edge by following these steps: - -1. Open Microsoft Edge: Launch your Microsoft Edge browser and access the Microsoft Edge Add-ons website, [link](https://microsoftedge.microsoft.com/addons/detail/akeyless-password-manager/bjgnnbhhfenmggpgnlbiilnoadoblmgo). -2. Search for Akeyless: In the search bar at the top of the page, type "Akeyless" and press Enter. -3. Select Akeyless Extension: From the search results, identify the Akeyless browser extension and click on the "Get" button. -4. Confirm Installation: Review the extension's requested permissions and click on the "Add extension" button to proceed. -5. Pin Extension for Easy Access: For convenient access, right-click on the Akeyless icon in the toolbar and select "Pin" to keep it permanently visible. - -## Authentication Methods Support - -Once you've installed the Akeyless browser extension. Simply locate the distinctive "K" icon in your browser's toolbar and initiate the login process. To securely access your Akeyless account, you can use one of the following authentication methods: - -* Email and Password: Enter your registered email address and password to gain access. -* Access-ID and Access-Key: Use your unique Access-ID and Access-Key combination for secure login. -* SAML: Leverage your existing SAML (Security Assertion Markup Language) identity provider for streamlined authentication. -* OIDC: Employ your preferred OIDC (OpenID Connect) identity provider for a seamless login experience. -* GitHub: Integrate your GitHub account for convenient access. -* Google: Use your Google account for effortless login. -* Code-ID: Enter the unique code ID provided by your IT administrator. This code serves as your primary identifier and ensures that only authorized individuals can initiate the login process. -* LDAP: For environments configured with LDAP, you can authenticate using your LDAP credentials for secure access. - * Configure the [LDAP gateway URL](https://docs.akeyless.io/docs/configure-ldap-gateway-url-1) by way of advanced settings then login with Email option as a login type. -* Account Alias: Support for using an account alias to simplify identification and enhance user experience. - -For more details about Akeyless Authentication Methods please visit this [link](https://docs.akeyless.io/docs/access-and-authentication-methods). diff --git a/docs/Password Manager/password-manager-web-extension/passkey.md b/docs/Password Manager/password-manager-web-extension/passkey.md deleted file mode 100644 index d63a04711..000000000 --- a/docs/Password Manager/password-manager-web-extension/passkey.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: Passkey -excerpt: Web Extension -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -## Passkey Management Overview - -This documentation provides an overview of the Passkey management system, including how to view passkey details, use a passkey for login, and create a new passkey. The instructions below describe the key functionalities and flow for managing passkeys. - -## Viewing Passkey Details - -The Passkey Details section allows users to view information about their saved passkeys. - -### Fields Displayed - -* Passkey Name: The label or identifier for the passkey. -* Username/Email: The email or username used when the passkey was created. -* Creation Date: The date when the passkey was created. -* Related Website: The website the passkey is linked to for login. -* Option to Delete Passkey: Allows users to remove the passkey from the system. - -## Using a Passkey for Login - -The following steps guide users on how to log in using an existing passkey for a supported website: - -### Steps - -* Navigate to a Passkey-supported website: - * Example: Adobe Account Security -* Attempt to Sign In: - * Try logging in to the website. -* If a passkey exists for the website: - * A list of available passkeys will be shown. - * Users can select the relevant passkey to sign in. - -### Example Flow - -* Go to the website → Try to sign in → If passkey exists → Show available passkeys. - -## Creating a New Passkey - -Users can create a new passkey for a supported website. Follow the steps below to generate and save a passkey within the system. - -### Steps - -* Navigate to the Passkey creation page on a supported website: - * Example: Adobe Account Security -* Click on "Add Passkey". -* Authenticate: - * If logged in to the website (For example, Adobe), proceed with passkey creation. - * If not logged in, authenticate first. -* Passkey Status: - * If the passkey already exists for the website, the user will be given the option to update or create a new passkey. - * If no passkey exists, a new passkey will be created. -* Save the Passkey: - * If saving the passkey is successful, a Success Message will be shown. - * If there is an error during the process, an Error Message will be displayed. - -#### Example Flow - -* Navigate to the website → Click on "Add Passkey" → Authenticate (if needed) → Check passkey existence → Create or update passkey → Save passkey → Success/Error message. - -## Error and Success Messages - -* Error Message: Shown when the passkey creation or update process fails. -* Success Message: Displayed when the passkey is successfully created or updated. - -## Toggling Passkey Authentication in the Web Extension - -Users can enable or disable Passkey Authentication directly through the web extension. This allows them to control when the extension uses passkeys for login. - -Steps: - -1. Open the web extension. -2. Click on the three-dot menu in the upper-right corner of the extension. -3. Locate the Passkey Authentication Toggle option. -4. Use the toggle button to enable or disable Passkey Authentication: -5. When enabled, the extension will use passkeys for supported logins. -6. When disabled, passkey functionality will be turned off. - -* Note: Disabling Passkey Authentication does not delete saved passkeys but prevents them from being used until re-enabled. diff --git a/docs/Password Manager/password-manager-web-extension/password-list-switching-between-folders-flat-view-1.md b/docs/Password Manager/password-manager-web-extension/password-list-switching-between-folders-flat-view-1.md deleted file mode 100644 index 492580c5d..000000000 --- a/docs/Password Manager/password-manager-web-extension/password-list-switching-between-folders-flat-view-1.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Password / Secrets List Switching Between Folders & Flat View -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -## Switching Between Views in Personal and Corporate Areas - -The Akeyless Password Manager web browser extension offers two viewing options for your passwords and secrets: the flat view and the folder view. - -## Flat View - -The flat view displays all your passwords and secrets without any folder hierarchy. This can be useful if you have a small number of passwords and secrets or if you prefer to have a simple, uncluttered view. - -## Folder View - -The folder view displays your passwords and secrets in a hierarchical structure, organized into folders. This can be helpful if you have a large number of passwords and secrets or if you want to keep your passwords and secrets organized according to their purpose or website. - -## Switching Between Views - -To switch between the flat and folder views, follow these steps: - -1. Navigate to the Flat View / Folder View icon located near the search field. -2. Click on the Flat view option to reveal all passwords within the folders and show the flat view. -3. Click on the Folder list to show the folder structure. diff --git a/docs/Password Manager/password-manager-web-extension/personal-corporate-favorites-areas-navigation.md b/docs/Password Manager/password-manager-web-extension/personal-corporate-favorites-areas-navigation.md deleted file mode 100644 index a0bbe5591..000000000 --- a/docs/Password Manager/password-manager-web-extension/personal-corporate-favorites-areas-navigation.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Personal, Corporate & Favorites Areas Navigation -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -## Personal Area - -The Personal Area is designed for storing and managing passwords and secrets that are for your personal use. This could include passwords for your email, social media accounts, bank accounts, and other online services that you use personally. - -The Personal Area is typically the default area where new passwords and secrets are saved. You can also manually add passwords and secrets to the Personal Area by clicking on the "Add New Password" or "Add New Secret" button. - -## Corporate Area - -The Corporate Area is designed for storing and managing passwords and secrets that are for your work use. This could include passwords for your company's email, intranet, VPN, and other work-related applications. - -The Corporate Area is typically separate from the Personal Area to help you keep your work passwords and secrets separate from your personal passwords and secrets. This can help to improve security and prevent accidental sharing of passwords. - -## Favorites Area - -The Favorites Area is a place where you can store your most frequently used passwords and secrets. This can be a handy way to quickly access passwords for the websites and applications that you use most often. - -You can add passwords and secrets to the Favorites Area by clicking on the star icon next to the password or secret in the Personal or Corporate Area. diff --git a/docs/Password Manager/password-manager-web-extension/pwm-ext-advanced-options.md b/docs/Password Manager/password-manager-web-extension/pwm-ext-advanced-options.md new file mode 100644 index 000000000..d5ac68f6a --- /dev/null +++ b/docs/Password Manager/password-manager-web-extension/pwm-ext-advanced-options.md @@ -0,0 +1,53 @@ +--- +title: Advanced Options + +slug: pwm-ext-advanced-options +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +Advanced Options provides environment-specific settings for the Password Manager Web Extension. + +## Available Settings + +The extension provides the following Advanced Options sections: + +* Passkey Authentication +* LDAP +* Vault URL + +The extension also displays the current extension version on the Advanced Options page. + +## Open Advanced Options + +1. Open the extension sign-in screen. +2. Open the three-dot menu. +3. Select **Advanced Options**. + +## Passkey Authentication + +The Passkey Authentication toggle controls whether the extension can provide passkey-based login suggestions and related authentication support. + +Use this setting when the organization wants to enable or disable passkey support in the extension. + +## LDAP + +The LDAP section allows users to turn on LDAP-specific configuration and provide the LDAP gateway URL required for that environment. + +For step-by-step instructions, see [Configure LDAP gateway URL](https://docs.akeyless.io/docs/pwm-ext-configure-ldap-gateway-url). + +## Vault URL + +The Vault URL section allows users to turn on a custom tenant or vault endpoint and provide the required URL. + +For step-by-step instructions, see [Configure Custom/Specific Tenant](https://docs.akeyless.io/docs/pwm-ext-configure-custom-specific-tenant). + +## Validation + +After saving Advanced Options changes, return to the sign-in flow and confirm that the extension uses the expected environment and authentication behavior. diff --git a/docs/Password Manager/password-manager-web-extension/pwm-ext-autofill-and-password-injection.md b/docs/Password Manager/password-manager-web-extension/pwm-ext-autofill-and-password-injection.md new file mode 100644 index 000000000..bd1dfa4c9 --- /dev/null +++ b/docs/Password Manager/password-manager-web-extension/pwm-ext-autofill-and-password-injection.md @@ -0,0 +1,44 @@ +--- +title: Using Autofill and Password Injection Functionality + +slug: pwm-ext-autofill-and-password-injection +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +The Akeyless Password Manager Web Extension can detect supported sign-in forms and help fill saved credentials. + +![Autofill prompt appearing on a website login form](https://files.readme.io/e491682-Screenshot_2024-01-10_at_16.55.04.png) + +## Use Autofill + +1. Open the target website. +2. Place the cursor in the username, email, or password field. +3. Select the suggested item from the Akeyless prompt when it appears. +4. Confirm the filled values before submitting the sign-in form. + +## Autofill Behavior + +The extension supports the following sign-in assistance behaviors: + +* Supported pages can use username, password, and OTP values from the same saved item. +* Dynamic and rotated secret items can be resolved through an Akeyless Gateway before injection. +* Gateway selection for dynamic and rotated retrieval uses the item-configured gateway when present, or falls back to the current public gateway from Advanced Options. + +## Autofill Setting + +The extension settings include an autofill toggle. Depending on account controls, autofill can also be disabled by an administrator. + +## Save or Update a Credential + +If the extension detects a new or updated credential on a supported page, it can prompt to save the item or update the existing item in the vault. + +When the save-suggestion dialog is shown, users can review the detected values and, where needed, add or adjust custom fields before saving. + +If a matching item already exists, users can update that item or choose to create a new item from the same dialog flow. diff --git a/docs/Password Manager/password-manager-web-extension/pwm-ext-configure-custom-specific-tenant.md b/docs/Password Manager/password-manager-web-extension/pwm-ext-configure-custom-specific-tenant.md new file mode 100644 index 000000000..933a056d9 --- /dev/null +++ b/docs/Password Manager/password-manager-web-extension/pwm-ext-configure-custom-specific-tenant.md @@ -0,0 +1,42 @@ +--- +title: Configure Custom and Specific Tenant + +slug: pwm-ext-configure-custom-specific-tenant +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +Use this setting when the extension should connect to a specific tenant URL instead of the default environment. + +![Custom tenant URL field in web extension settings](https://files.readme.io/72e4da3-Screenshot_2024-03-20_at_11.10.38.png) + +## Configure a Custom Tenant URL + +1. Open the extension sign-in screen. +2. Open the three-dot menu. +3. Go to **Advanced Options**. +4. Turn on **Vault URL**. +5. Enter the tenant URL required for the environment. +6. Click **Save**. + +## When to Use This Setting + +Use a custom tenant URL when: + +* The organization uses a specific vault endpoint. +* Users must connect to a non-default environment. +* The sign-in flow should be directed to an environment-specific hostname. + +## Validation + +After saving the setting, return to the sign-in flow and confirm that authentication uses the intended tenant endpoint. + +> 📘 **For admins** +> +> To pre-configure the tenant URL for managed browser deployments, see [Enterprise Distribution and Pre-Configured Authentication](https://docs.akeyless.io/docs/pwm-ext-enterprise-distribution-preconfigured-authentication). diff --git a/docs/Password Manager/password-manager-web-extension/pwm-ext-configure-ldap-gateway-url.md b/docs/Password Manager/password-manager-web-extension/pwm-ext-configure-ldap-gateway-url.md new file mode 100644 index 000000000..d81cf3bfe --- /dev/null +++ b/docs/Password Manager/password-manager-web-extension/pwm-ext-configure-ldap-gateway-url.md @@ -0,0 +1,40 @@ +--- +title: Configure LDAP Gateway URL + +slug: pwm-ext-configure-ldap-gateway-url +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +Use this setting when the extension should authenticate through an LDAP gateway. + +## Configure the LDAP Gateway URL + +![LDAP Gateway URL field in web extension settings](https://files.readme.io/51e6e76-Screenshot_2024-02-25_at_14.48.30.png) + +1. Open the extension sign-in screen. +2. Open the three-dot menu. +3. Go to **Advanced Options**. +4. Turn on **LDAP**. +5. Enter the required LDAP gateway URL. +6. Click **Save**. + +![Save button for LDAP gateway URL settings](https://files.readme.io/2914cb3-Screenshot_2024-02-25_at_14.47.48.png) + +## Use the LDAP Sign-In Flow + +After saving the LDAP gateway URL, return to the sign-in flow and use the authentication option that matches the organization's LDAP configuration. + +## Validation + +Confirm that the extension reaches the expected LDAP-backed sign-in flow and that users can authenticate with the expected credentials. + +> 📘 **For admins** +> +> To configure the LDAP authentication method on the Akeyless platform, see [LDAP Authentication Method](https://docs.akeyless.io/docs/auth-with-ldap). diff --git a/docs/Password Manager/password-manager-web-extension/pwm-ext-copy-and-paste-passwords.md b/docs/Password Manager/password-manager-web-extension/pwm-ext-copy-and-paste-passwords.md new file mode 100644 index 000000000..7804a62ae --- /dev/null +++ b/docs/Password Manager/password-manager-web-extension/pwm-ext-copy-and-paste-passwords.md @@ -0,0 +1,34 @@ +--- +title: Copy and Paste Functionality for Passwords + +slug: pwm-ext-copy-and-paste-passwords +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +The Akeyless Password Manager extension includes a copy and paste feature for transferring passwords from the extension to web forms. + +Use copy when a site or application cannot use autofill or injection. + +1. Tap on the password field next to the desired password. +2. Look for a 'Copy' icon or button. +3. Open the required item in the extension. +4. Find the password field or relevant value. +5. Click the copy action. +6. Paste the value into the target form. + +7. Switch to the web browser or app where you need to enter the password. +8. Tap on the password entry field. +9. Switch to the target browser tab or application. +10. Place the cursor in the required field. +11. Paste the copied value. + +## Recommendation + +Use autofill when possible. Use copy and paste as a fallback for unsupported or restricted input flows. diff --git a/docs/Password Manager/password-manager-web-extension/pwm-ext-create-password.md b/docs/Password Manager/password-manager-web-extension/pwm-ext-create-password.md new file mode 100644 index 000000000..3ef1670b7 --- /dev/null +++ b/docs/Password Manager/password-manager-web-extension/pwm-ext-create-password.md @@ -0,0 +1,107 @@ +--- +title: Creating a New Password + +slug: pwm-ext-create-password +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +This create-password flow includes improved password generation and password-strength feedback. + +Use these steps to create a password item in the Personal or Corporate area. + +> 📘 **Password items and secret items** +> +> **Password items** store structured credentials — a URL, username, and password — and integrate with autofill and OTP. **Secret items** store arbitrary text values such as API keys, tokens, or notes, and support custom key-value fields. To create a secret item instead, see [Creating a New Secret](https://docs.akeyless.io/docs/pwm-ext-create-secret). + +## Step 1: Launch the Akeyless Web Extension + +1. Once installed, the Akeyless Web Extension icon will appear in your browser's toolbar. +2. Click on the Akeyless Web Extension icon to launch the extension. + +![Akeyless Web Extension icon in the browser toolbar](https://files.readme.io/33368d1-Screenshot_2023-11-14_at_19.10.15.png) + +## Step 2: Access the Password Creation Form + +![Password creation form in the web extension](https://files.readme.io/9d80c86-Screenshot_2024-02-22_at_14.22.38.png) + +1. Click **New Item**. +2. Enter the password name. +3. Optionally, add a description. +4. Generate a password or enter one manually. + +## Step 3: Define Password Name and Location + +Choose the target location for the password: + +* Personal area +* Corporate area +* A folder within the selected area + +> ℹ️ **Note:** +> +> Access to the Personal area depends on account settings. If the Personal area is not available, save the password in the Corporate area. + +![Password Location drop-down showing Corporate and Personal options](https://files.readme.io/d75a38d-Screenshot_2024-02-22_at_14.22.54.png) + +## Step 4: Enhance Security and Add Context + +Optionally, add supporting details such as the related website, service, or application. + +If needed, enable delete protection to reduce accidental deletion. + +## Step 5: Generate and Save the Password + +Generate the password according to the active password policy and generation preferences. + +The extension provides stronger generation guidance, including improved password-strength feedback and support for tuning allowed special characters. + +When the password is ready, click **Save**. + +The extension stores the item in the selected area. + +## Step 6: Access Saved Passwords + +Open the extension to view saved passwords, review item details, or copy values. + +## Password Strength Policy + +The Password Strength Policy feature helps ensure that new passwords meet organizational requirements. + +![Password Strength Policy settings in the web extension](https://files.readme.io/91fa4a2-Screenshot_2024-04-11_at_14.21.32.png) + +Users can customize password settings, but they cannot go below the minimum standards set by the organization. + +The password-strength experience includes clearer feedback during password creation. + +Password Strength Evaluation Criteria: + +### Green: Strong Password + +Password length is at the minimum or more of the length defined by the organization + +Meets at least 3 of the other 4 criteria (uppercase, lowercase, numbers, special characters) + +### Yellow: Medium Password + +Password length is lower than the length defined by the organization + +Meets at least 2 of the other 4 criteria (uppercase, lowercase, numbers, special characters) + +### Red: Weak Password + +Fails to meet the criteria for either green or yellow + +## Related Tasks + +After creating a password, you can: + +* Add it to Favorites. +* Use it for autofill. +* Add OTP data if the site requires MFA. diff --git a/docs/Password Manager/password-manager-web-extension/pwm-ext-create-secret.md b/docs/Password Manager/password-manager-web-extension/pwm-ext-create-secret.md new file mode 100644 index 000000000..db8ef58f5 --- /dev/null +++ b/docs/Password Manager/password-manager-web-extension/pwm-ext-create-secret.md @@ -0,0 +1,71 @@ +--- +title: Creating a New Secret + +slug: pwm-ext-create-secret +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +Use these steps to create a static secret item in the extension. + +> 📘 **Secret items and password items** +> +> **Secret items** store arbitrary text values such as API keys, tokens, or notes, and support custom key-value fields. **Password items** store structured credentials — a URL, username, and password — and integrate with autofill and OTP. To create a password item instead, see [Creating a New Password](https://docs.akeyless.io/docs/pwm-ext-create-password). + +## Step 1: Launch the Akeyless Web Extension + +1. Once installed (see [Install and Sign In to the Akeyless Web Extension](https://docs.akeyless.io/docs/pwm-ext-install-and-sign-in)), the Akeyless Web Extension icon will appear in your browser's toolbar. +2. Click on the Akeyless Web Extension icon to launch the extension. + +![Akeyless Web Extension icon in the browser toolbar](https://files.readme.io/8a3048e-Screenshot_2024-02-22_at_14.23.10.png) + +## Step 2: Access the Password Creation Form + +1. Click **New Item**. +2. Open the **Static Secret** tab. +3. Enter the secret name. +4. Optionally, add a description. + +## Step 3: Add Custom Fields (Optional) + +You can add custom fields to store additional key-value data on the secret item. + +1. Select **Add Field**. +2. Enter field name and value. +3. Save the field. + +Field names must be unique per item. + +For OTP-specific custom field setup, see [OTP setup and usage](https://docs.akeyless.io/docs/pwm-ext-otp). + +## Step 4: Define Value and Location + +Enter the secret value in the **Value** field. + +![Value and Location fields in the secret creation form](https://files.readme.io/774a6f9-Screenshot_2024-02-22_at_14.23.19.png) + +Then choose the target location: + +* Personal area +* Corporate area +* A folder within the selected area + +## Save the Secret + +After entering the value and location, click **Save**. + +## Secret Value Types + +The secret value field supports both plain text and JSON values. + +Use plain text for single-value items such as tokens, notes, or one-value credentials. + +Use JSON when the secret needs structured key-value data in one item. + +![Value field containing JSON data in the secret creation form](https://files.readme.io/55cdb8e-Screenshot_2024-03-21_at_13.50.43.png) diff --git a/docs/Password Manager/password-manager-web-extension/pwm-ext-csv-password-importer.md b/docs/Password Manager/password-manager-web-extension/pwm-ext-csv-password-importer.md new file mode 100644 index 000000000..18fd69bb6 --- /dev/null +++ b/docs/Password Manager/password-manager-web-extension/pwm-ext-csv-password-importer.md @@ -0,0 +1,73 @@ +--- +title: CSV Password Importer + +slug: pwm-ext-csv-password-importer +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +The CSV Password Import feature allows users to import passwords from a CSV file directly through the web extension. Passwords can be imported into the Personal or Corporate area, depending on account permissions. + +The importer uses the current account configuration when a new import session starts. + +## How to Use the CSV Password Import Feature + +## Step 1: Access the Web Extension Settings + +* Open the web extension from your browser toolbar. +* Navigate to the 'Settings' option within the extension menu. + +![Settings option in the web extension menu](https://files.readme.io/522836b-Screenshot_2024-07-01_at_16.09.35.png) + +## Step 2: Initiate the Import Process + +* In the Settings menu, locate and click on the "Import from CSV" button to start the import procedure. + +## Step 3: Define CSV File Format + +* Ensure your CSV file is prepared according to the required format. The standard format should include columns such as 'Account Name', 'Username', 'Password', and other necessary details. + +## Step 4: Select the CSV File + +* Click on the file selection button to browse and choose the desired CSV file from your local storage. + +## Step 5: Choose Import Location + +* Select where the passwords will be imported: choose either the Personal or Corporate area in Password Manager. +* If the Personal area is not available for the account, import into the Corporate area. + +## Step 6: Create a Dedicated Folder + +* Specify if you wish to create a dedicated folder within the target location by entering a folder name in the 'Target Folder Field'. + +![Target Folder field in the CSV import screen](https://files.readme.io/8898628-Screenshot_2024-06-04_at_14.52.18.png) + +## Step 7: Submit the Import + +* Once all settings are configured and the file is ready, click the 'Submit' button to finalize the import process. + +## Import Behavior + +The extension improves import consistency in these areas: + +* Import settings are refreshed when a new import session starts. +* Current account configuration is reflected in the import flow before submission. +* Imported items follow the active destination and account defaults selected during import. + +## Import Progress + +The extension can display import progress while CSV import is running. + +During import, the status view can show: + +* The number of completed items. +* The total number of items in the import batch. +* A progress bar for the current import operation. + +![CSV import progress screen](https://files.readme.io/97988b1-Screenshot_2024-06-04_at_14.52.11.png) diff --git a/docs/Password Manager/password-manager-web-extension/pwm-ext-deleting-password.md b/docs/Password Manager/password-manager-web-extension/pwm-ext-deleting-password.md new file mode 100644 index 000000000..8bbdfb878 --- /dev/null +++ b/docs/Password Manager/password-manager-web-extension/pwm-ext-deleting-password.md @@ -0,0 +1,48 @@ +--- +title: Deleting a Password or Secret + +slug: pwm-ext-deleting-password +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +You can delete an item from the list view or from the item details view. + +## Delete from the Item List + +![Quick action menu with Delete option next to a password entry](https://files.readme.io/62cf452-Screenshot_2024-01-10_at_16.46.49.png) + +1. Locate the password or secret in the list. +2. Open the item actions menu. +3. Select **Delete**. +4. Confirm the deletion. + +![Deletion confirmation pop-up in the web extension](https://files.readme.io/cc914f5-Screenshot_2024-01-10_at_16.47.07.png) + +## Delete from the Item Details View + +1. Open the password or secret. +2. Scroll to the bottom of the item details view. +3. Click **Delete**. +4. Confirm the deletion. + +## Delete Protection + +If Delete Protection is enabled on an item, you must disable it before you can delete it. + +1. Open the item details. +2. Toggle off **Delete Protection**. +3. Save the item. +4. Follow the deletion steps above. + +## Important + +> ⚠️ **Warning:** +> +> Once an item is deleted, it cannot be recovered from the extension. diff --git a/docs/Password Manager/password-manager-web-extension/pwm-ext-editing-password-details.md b/docs/Password Manager/password-manager-web-extension/pwm-ext-editing-password-details.md new file mode 100644 index 000000000..65cee3f1a --- /dev/null +++ b/docs/Password Manager/password-manager-web-extension/pwm-ext-editing-password-details.md @@ -0,0 +1,38 @@ +--- +title: Editing Password or Secret Details + +slug: pwm-ext-editing-password-details +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +Use the item actions menu to edit an existing password or secret. + +## Edit an Existing Item + +1. Open the extension and locate the password or secret. +2. Click the three-dot menu next to the item. +3. Select **Edit**. +4. Update the required fields. +5. Click **Save**. + +![Three-dot quick editing menu next to a password entry in the web extension](https://files.readme.io/b3b9c11-Screenshot_2024-01-10_at_16.40.36.png) + +## Common Changes + +Typical edit actions include: + +* Updating the item name or description. +* Changing the location or folder. +* Updating the username, password, or related secret value. +* Adjusting custom fields such as OTP data where supported. + +![Password entry in edit mode with editable fields](https://files.readme.io/e0c4908-Screenshot_2024-01-10_at_16.41.08.png) + +After saving, the updated item remains available in the same area of the extension. diff --git a/docs/Password Manager/password-manager-web-extension/pwm-ext-enterprise-distribution-preconfigured-authentication.md b/docs/Password Manager/password-manager-web-extension/pwm-ext-enterprise-distribution-preconfigured-authentication.md new file mode 100644 index 000000000..d291f24d2 --- /dev/null +++ b/docs/Password Manager/password-manager-web-extension/pwm-ext-enterprise-distribution-preconfigured-authentication.md @@ -0,0 +1,135 @@ +--- +title: Enterprise Distribution with Preconfigured Authentication + +slug: pwm-ext-enterprise-distribution-preconfigured-authentication +excerpt: 'Deploy the Akeyless Password Manager browser extension with preconfigured authentication fields for managed enterprise environments.' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +Use this enterprise deployment pattern to prefill authentication fields in the Akeyless Password Manager browser extension. This approach helps IT teams reduce first-login friction and guide users to approved authentication methods. + +The process described on this page is validated for managed Chromium deployments. + +## Prerequisites + +Before preparing a managed extension package, confirm the following: + +* The organization has a validated browser-extension distribution method. +* The required Akeyless authentication method is enabled in the target account. +* The IT team has the Access ID and target authentication method values. +* The IT team has a staging environment to validate sign-in before broad rollout. + +## Configuration File Example + +The following example pre-fills Access ID and restricts authentication to OIDC: + +```json +{ + "enabled": true, + "prefillAccessId": "", + "preferredAuthMethod": "oidc", + "allowedAuthMethods": ["oidc"], + "installationSource": "bundled_prefill" +} +``` + +### Configuration Fields + +| Field | Type | Description | +| --- | --- | --- | +| `enabled` | boolean | Activates the preconfigured authentication feature. Set to `true` to enable. | +| `prefillAccessId` | string | The Akeyless Access ID to prefill on the sign-in screen. | +| `preferredAuthMethod` | string | The authentication method shown by default. Must be one of the values listed in `allowedAuthMethods`. Use lowercase (for example, `oidc`, `saml`, `ldap`). | +| `allowedAuthMethods` | array of strings | The set of authentication methods available to users. Valid values (use lowercase): `oidc`, `saml`, `ldap`, `email_pass`, `access_key`, `github`, `google`, `certificate`. | +| `installationSource` | string | Identifies the deployment origin. Use `bundled_prefill` for enterprise-packaged deployments. | + +## Chromium-Based Browsers (Chrome and Edge) + +Use this flow for Chrome, Edge, and other Chromium-based browsers: + +1. Install the Akeyless Password Manager extension: + * **Chrome**: [Akeyless Password Manager on Chrome Web Store](https://chromewebstore.google.com/) + * **Edge**: [Akeyless Password Manager on Microsoft Edge Add-ons](https://microsoftedge.microsoft.com/addons) + + Note the extension ID (``) displayed in your browser's extensions management page. + +2. Locate your browser profile directory: + * **Chrome/Chromium**: Open `chrome://settings/help` (or `edge://settings/help` for Edge). The Profile Path is displayed in the About tab. + * **Alternative**: Open the browser's settings, navigate to **About → About Chrome** (or Edge), and copy the Profile Path shown. +3. Open the profile directory on your local machine. +4. Navigate to `\Extensions\\` (replace `` with the ID from step 1). +5. Open the version folder (the numeric folder inside; for example, `\1.2.3.0\`). +6. Copy this version folder to a working directory. +7. In the copied version folder, locate the file `preconfigured_install.json`. If it does not exist, create it. Edit the file to include the configuration fields (see Configuration Fields table above), and update all values with your organization-specific settings. +8. Package the updated folder and distribute it with the internal software-delivery process. +9. Validate first-login behavior in a test user profile. + +> ⚠️ **Warning:** +> +> Repackaged browser extensions should be distributed only through approved internal enterprise channels. + +Browser-signing requirements, update-channel behavior, and endpoint-management policy configuration are outside the scope of this page. + +## Firefox + +Firefox enterprise extension deployment uses the `policies.json` file or an enterprise policy service (such as Group Policy or Jamf). The configuration storage mechanism differs from Chromium. + +### Firefox Configuration Overview + +Firefox managed extensions use a managed storage API instead of direct file modification. The configuration is managed through: + +* **Group Policy (Windows)**: For domain-joined devices, define managed storage settings in Group Policy. +* **Jamf (macOS)**: For managed macOS devices, define managed storage settings via Jamf configuration profiles. +* **Standalone Firefox ESR**: For unmanaged deployments, place a `policies.json` file in the Firefox installation directory. + +The configuration keys and format for managed storage differ from the Chromium `preconfigured_install.json` structure. The Akeyless Password Manager extension on Firefox uses the managed storage API to read configuration values. + +### Steps + +1. Consult the official [Firefox for Enterprise](https://support.mozilla.org/en-US/products/firefox-enterprise) documentation to determine the appropriate deployment method for your environment (Group Policy, Jamf, or standalone `policies.json`). +2. Configure the managed storage using the same field names and values as the Chromium configuration table above (for example, `enabled`, `prefillAccessId`, `preferredAuthMethod`, `allowedAuthMethods`). +3. Deploy via your enterprise policy service or update the Firefox `policies.json` file. +4. Validate that the extension reads the configuration on first launch. + +## Authentication Method Selection Guide + +When choosing allowed authentication methods, consider these use cases: + +* **OIDC (OpenID Connect)**: Enterprise identity providers, modern cloud deployments. +* **SAML**: Legacy enterprise SSO systems, often paired with on-premises Active Directory. +* **LDAP**: On-premises LDAP/Active Directory environments without SSO gateway. +* **Email + Password**: Legacy fallback; less secure, not recommended as sole method. +* **Access Key**: Service accounts or programmatic access; restricted to specific roles. +* **GitHub, Google**: Development teams using public identity providers; less suitable for regulated environments. +* **Certificate**: Mutual TLS or certificate-based authentication; requires client certificate distribution. + +Restricting to a single method (set `allowedAuthMethods` to one value) simplifies support and reduces configuration errors. + +## Validation Checklist + +After deployment, verify the following outcomes: + +* The extension opens with prefilled authentication values on first launch. +* Only approved authentication methods appear in the sign-in dropdown. +* Users can complete authentication without manual endpoint customization. +* Check the browser's extension logs for errors: Open the extension's popup, right-click → **Inspect**, and review the Console tab for any configuration-related warnings. +* Verify that failed login attempts are logged in your identity provider's audit logs as expected. + +## Troubleshooting + +If prefilled authentication does not appear, check these areas: + +* The deployed package includes the updated `preconfigured_install.json` file in the correct extension version folder. +* JSON syntax is valid. Use a JSON validator if needed. +* All method names and string values are **lowercase** (for example, `"preferredAuthMethod": "oidc"`, not `"Oidc"` or `"OIDC"`). +* The configured authentication method (`preferredAuthMethod`) is enabled for the target Akeyless account. +* The configured authentication method is included in the `allowedAuthMethods` array. +* The browser is running the expected extension build and version (verify in the extension's details page). +* No browser policies or security software are blocking the extension from reading the configuration file. +* For Firefox: Verify that managed storage is correctly deployed via your enterprise policy service (Group Policy, Jamf, or `policies.json`). diff --git a/docs/Password Manager/password-manager-web-extension/pwm-ext-folder-navigation-within-personal-corporate-areas.md b/docs/Password Manager/password-manager-web-extension/pwm-ext-folder-navigation-within-personal-corporate-areas.md new file mode 100644 index 000000000..b58cd989f --- /dev/null +++ b/docs/Password Manager/password-manager-web-extension/pwm-ext-folder-navigation-within-personal-corporate-areas.md @@ -0,0 +1,35 @@ +--- +title: Folder Navigation within Personal & Corporate Areas + +slug: pwm-ext-folder-navigation-within-personal-corporate-areas +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +Passwords and secrets in the extension can be organized into folders within the Personal and Corporate areas. + +## Navigating Within the Folder Hierarchy + +Use folder navigation to browse items within the Personal or Corporate area. + +![Folder hierarchy in the web extension Personal or Corporate area](https://files.readme.io/b0ea2f8-Screenshot_2024-01-10_at_16.49.31.png) + +The extension supports these folder-navigation methods: + +## Using the Folder Tree + +Use the folder tree to open nested folders in the current area. + +## Using the Back Arrow + +Use the back arrow to move to the previous level in the folder hierarchy. + +## Tip + +Use folder navigation together with search and filters when the same item name appears in multiple locations. diff --git a/docs/Password Manager/password-manager-web-extension/pwm-ext-install-and-sign-in.md b/docs/Password Manager/password-manager-web-extension/pwm-ext-install-and-sign-in.md new file mode 100644 index 000000000..d96b239ed --- /dev/null +++ b/docs/Password Manager/password-manager-web-extension/pwm-ext-install-and-sign-in.md @@ -0,0 +1,93 @@ +--- +title: Password Manager Web Extension + +slug: pwm-ext-install-and-sign-in +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +Use the following steps to install and sign in to the Akeyless Password Manager Web Extension in your browser. + +## Installation Across Browsers + +The Akeyless Password Manager Web Extension is available for: + +* [Firefox](#akeyless-password-manager-firefox-installation) +* [Google Chrome](#akeyless-password-manager-google-chrome-installation) +* [Microsoft Edge](#akeyless-password-manager-microsoft-edge-installation) + +> ℹ️ **Note (Installing Akeyless Extensions with SRA Support):** +> +> Search for **Akeyless Password Manager** in the relevant browser extension store. + +## Akeyless Password Manager Firefox Installation + +Supported Firefox: desktop version 91.1.0 or later. + +1. Open Firefox and go to the Firefox Add-ons listing for Akeyless Password Manager: [link](https://addons.mozilla.org/en-US/firefox/addon/akeyless-sra/). +2. Click **Add to Firefox**. +3. Review the requested permissions, and confirm the installation. +4. Pin the extension so it remains visible in the browser toolbar. + +> ℹ️ **Note:** +> +> After installing or updating the extension on Firefox, verify that the extension can access website data: +> +> 1. Open the Extensions Manager: Go to the Firefox menu, select Add-ons and Themes > Extensions. +> 2. Locate the Akeyless Password Manager Extension: Under the Enabled section, click the three dots (...) next to the extension. +> 3. Verify Permissions: Select Manage and ensure the "Access your data for all websites" permission is enabled. +> 4. Confirm Settings: The toggle switch should be turned on for this permission. + +## Akeyless Password Manager Google Chrome Installation + +![Akeyless Password Manager in the Chrome Web Store](https://files.readme.io/3d3d29c-Screenshot_2024-05-07_at_16.02.38.png) + +Supported Google Chrome: Version 88+ + +1. Open the Chrome Web Store search results for Akeyless: [link](https://chromewebstore.google.com/search/akeyless?hl=en-US). +2. Select the Akeyless Password Manager extension. +3. Click **Add to Chrome**. +4. Review the requested permissions, and confirm the installation. +5. Pin the extension so it remains visible in the browser toolbar. + +## Akeyless Password Manager Microsoft Edge Installation + +Supported Microsoft Edge: Version 88+ + +1. Open the Microsoft Edge Add-ons listing for Akeyless Password Manager: [link](https://microsoftedge.microsoft.com/addons/detail/akeyless-password-manager/bjgnnbhhfenmggpgnlbiilnoadoblmgo). +2. Click **Get**. +3. Review the requested permissions, and confirm the installation. +4. Pin the extension so it remains visible in the browser toolbar. + +## Next Step + +After installation, sign in with the required authentication method. For environment-specific options, see the Advanced Options, tenant URL, LDAP, and enterprise deployment pages in this section. + +## Authentication Methods Support + +After installation, click the Akeyless icon in the browser toolbar and start the sign-in flow. The extension supports these authentication methods: + +* Email and Password: Enter your registered email address and password to gain access. +* Access-ID and Access-Key: Use your unique Access-ID and Access-Key combination for secure login. +* SAML: Sign in with your configured SAML identity provider. +* OIDC: Sign in with your configured OIDC identity provider. +* GitHub: Sign in with GitHub when enabled by account policy. +* Google: Sign in with Google when enabled by account policy. +* Code-ID: Enter the unique code ID provided by your IT administrator. This code serves as your primary identifier and ensures that only authorized individuals can initiate the login process. +* LDAP: For environments configured with LDAP, you can authenticate using LDAP credentials. + Configure the [LDAP gateway URL](https://docs.akeyless.io/docs/pwm-ext-configure-ldap-gateway-url) in Advanced Options, and then sign in with the Email option. +* Account Alias: Sign in with account alias when enabled by account policy. + +## Sign-In Policy Notes + +Available authentication methods depend on account configuration and administrator policy. + +If a configured method is not shown in the extension sign-in screen, verify account-level authentication settings before troubleshooting the client. + +For more details, see [Access and Authentication Methods](https://docs.akeyless.io/docs/access-and-authentication-methods). diff --git a/docs/Password Manager/password-manager-web-extension/pwm-ext-managing-favorites.md b/docs/Password Manager/password-manager-web-extension/pwm-ext-managing-favorites.md new file mode 100644 index 000000000..93a797743 --- /dev/null +++ b/docs/Password Manager/password-manager-web-extension/pwm-ext-managing-favorites.md @@ -0,0 +1,36 @@ +--- +title: Managing Favorites + +slug: pwm-ext-managing-favorites +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +Use Favorites to keep frequently used items easy to reach. + +![Favorites icon highlighted on a password entry in the web extension](https://files.readme.io/313aa73-Screenshot_2024-03-21_at_14.07.31.png) + +## Add an Item to Favorites + +1. Open the extension. +2. Locate the password or secret. +3. Click the star icon for the item. +4. Confirm that the star is filled. + +## View Favorites + +Open the Favorites area to review items marked for quick access. + +## Remove an Item from Favorites + +![Remove from Favorites option on a password entry](https://files.readme.io/daa2c75-Screenshot_2024-03-21_at_14.08.18.png) + +1. Open the Favorites area or locate the item in another list view. +2. Click the filled star icon. +3. Confirm that the star is no longer filled. diff --git a/docs/Password Manager/password-manager-web-extension/pwm-ext-navigate-personal-corporate-favorites.md b/docs/Password Manager/password-manager-web-extension/pwm-ext-navigate-personal-corporate-favorites.md new file mode 100644 index 000000000..7c98e235c --- /dev/null +++ b/docs/Password Manager/password-manager-web-extension/pwm-ext-navigate-personal-corporate-favorites.md @@ -0,0 +1,51 @@ +--- +title: Personal, Corporate, & Favorites Areas Navigation + +slug: pwm-ext-navigate-personal-corporate-favorites +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +The extension organizes items into Personal, Corporate, and Favorites areas. + +## Personal Area + +Use the Personal area for credentials that are private to your user account. + +> ℹ️ **Note:** +> +> Account-level Password Manager policy controls visibility of the Personal area. + +## Corporate Area + +Use the Corporate area for credentials managed under organizational access policy. + +## Favorites Area + +Use Favorites to pin frequently used items from either Personal or Corporate areas. + +## Switch Between Personal and Corporate Areas + +1. Open the extension. +2. Select **Personal** or **Corporate** in the area selector. +3. Confirm that the displayed list matches the selected area. + +## Add an Item to Favorites + +1. Locate the item in Personal or Corporate area. +2. Open item actions. +3. Select **Add to Favorites**. + +## Remove an Item From Favorites + +1. Open the Favorites view. +2. Open actions for the item. +3. Select **Remove from Favorites**. + +Favorites updates immediately after add or remove actions. diff --git a/docs/Password Manager/password-manager-web-extension/pwm-ext-otp.md b/docs/Password Manager/password-manager-web-extension/pwm-ext-otp.md new file mode 100644 index 000000000..377951fab --- /dev/null +++ b/docs/Password Manager/password-manager-web-extension/pwm-ext-otp.md @@ -0,0 +1,56 @@ +--- +title: Adding and Using One-Time Passwords + +slug: pwm-ext-otp +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +The extension supports OTP for saved credentials. OTP values can be added from QR content or from manual `otpauth://`-compatible data, and supported sign-in pages can use those values during autofill and injection flows. + +## Add an OTP by Scanning QR Content + +1. Navigate to the Corporate or Personal area where the password is stored. +2. Click the three-dot menu next to the password entry. +3. Make sure the OTP QR code is visible on the current page. +4. Select "Scan OTP" from the item menu. +5. Confirm that the OTP value is added as a custom field on the selected item. + +![Three-dot options menu next to a password entry in the web extension](https://files.readme.io/ba937b7-Screenshot_2024-06-16_at_11.01.45.png) + +## View the OTP Value + +After the OTP value is saved, click the eye icon next to the custom field to reveal the current code. + +## OTP Behavior + +The extension supports OTP in these areas: + +* OTP values can be stored from QR-based flows and manual OTP entry. +* Supported sign-in pages can use OTP values alongside username and password. +* Better field detection helps distinguish OTP and MFA fields from standard password fields. +* Multi-step sign-in pages can keep the OTP field as the active target during injection. + +## Add an OTP Manually + +Use manual entry when the OTP secret is provided as a setup key or `otpauth://`-compatible value instead of a QR code. + +1. Open the extension. +2. Open the three-dot menu. +3. Select **Manual OTP**. +4. Open the password edit screen for the target item. +5. In the custom-field flow, use the `otpauth` field. +6. Enter the setup key or related OTP value. +7. Save the item. + +![OTP setup key and secret input fields in the web extension](https://files.readme.io/8ad8ef4-Screenshot_2024-08-19_at_16.25.10.png) + +After saving, the OTP value becomes available as part of the item and can be used in supported OTP-related operations. + +![OTP code added as a custom field to a password entry in the web extension](https://files.readme.io/f962648-Screenshot_2024-06-16_at_11.08.08.png) diff --git a/docs/Password Manager/password-manager-web-extension/pwm-ext-overview.md b/docs/Password Manager/password-manager-web-extension/pwm-ext-overview.md new file mode 100644 index 000000000..160361db3 --- /dev/null +++ b/docs/Password Manager/password-manager-web-extension/pwm-ext-overview.md @@ -0,0 +1,87 @@ +--- +title: Password Manager Web Extension + +slug: pwm-ext-overview +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +The Akeyless Password Manager Web Extension provides browser-based access to passwords, secrets, one-time passwords (OTPs), and passkeys. + +## Recommended Reading Order + +Start with this reading order for the Password Manager documentation: + +1. [Install the extension and sign in](https://docs.akeyless.io/docs/pwm-ext-install-and-sign-in). +2. Configure settings if needed: [Advanced Options](https://docs.akeyless.io/docs/pwm-ext-advanced-options), [Tenant URL](https://docs.akeyless.io/docs/pwm-ext-configure-custom-specific-tenant), [LDAP](https://docs.akeyless.io/docs/pwm-ext-configure-ldap-gateway-url), or [Enterprise Deployment](https://docs.akeyless.io/docs/pwm-ext-enterprise-distribution-preconfigured-authentication). +3. [Create passwords](https://docs.akeyless.io/docs/pwm-ext-create-password) or [import existing ones](https://docs.akeyless.io/docs/pwm-ext-csv-password-importer). +4. Use [autofill](https://docs.akeyless.io/docs/pwm-ext-autofill-and-password-injection), [OTP](https://docs.akeyless.io/docs/pwm-ext-otp), and [passkey](https://docs.akeyless.io/docs/pwm-ext-passkey) features during sign-in. +5. Review [Security Health](https://docs.akeyless.io/docs/pwm-security-health) in the personal vault. + +## Capabilities + +### Password creation and import + +The extension supports the following password-management operations: + +* Strong password generation with improved feedback. +* Tuning for allowed special characters when generating passwords. +* Import behavior that uses current account settings when a new import session starts. +* Support for account-level controls that can limit access to the personal vault area. + +### Sign-in assistance + +The extension supports these sign-in options: + +* Username and password autofill for supported pages. +* OTP support for scanned and manually added `otpauth://` values. + +### Passkeys + +The extension supports passkey capabilities including: + +* Passkey creation and sign-in flows from the extension. +* A passkey toggle in advanced settings. +* Site-matching and suggestion behavior on supported relying parties. + +### Security Health + +Security Health support for personal-vault review includes: + +* A protection score view. +* Visual breakdowns of password hygiene metrics. +* Breach-related insights and actionable follow-up. + +### Secret value retrieval behavior + +The extension supports value retrieval for these secret types: + +* Static secrets. +* Dynamic secrets. +* Rotated secrets. + +When a dynamic or rotated item is opened for value retrieval, the extension uses the gateway defined on the item when available. If the item does not define a gateway, the extension falls back to the currently configured public gateway in Advanced Options. + +### Enterprise deployment + +PWM documentation includes an enterprise deployment guide for preconfigured authentication in managed browser environments. + +## Cross-Platform Features + +Use these links for features covered in both the extension and mobile app: + +* [Web Extension create a password](https://docs.akeyless.io/docs/pwm-ext-create-password) and [Mobile create a password](https://docs.akeyless.io/docs/pwm-mobile-create-password) +* [Web Extension create a static secret](https://docs.akeyless.io/docs/pwm-ext-create-secret) and [Mobile create a static secret](https://docs.akeyless.io/docs/pwm-mobile-create-static-secret) +* [Web Extension autofill and injection](https://docs.akeyless.io/docs/pwm-ext-autofill-and-password-injection) and [Mobile autofill and injection](https://docs.akeyless.io/docs/pwm-mobile-autofill-and-password-injection) +* [Web Extension OTP setup](https://docs.akeyless.io/docs/pwm-ext-otp) and [Mobile OTP setup](https://docs.akeyless.io/docs/pwm-mobile-otp) +* [Web Extension password policy settings](https://docs.akeyless.io/docs/pwm-ext-setting-password-policy-on-account-level) and [Mobile password policy settings](https://docs.akeyless.io/docs/pwm-mobile-setting-password-policy-on-account-level) + +## Tutorial + +Check out the tutorial video on [Using the Akeyless Password Manager Web Extension](https://tutorials.akeyless.io/docs/akeyless-password-manager-web-extension). diff --git a/docs/Password Manager/password-manager-web-extension/pwm-ext-passkey.md b/docs/Password Manager/password-manager-web-extension/pwm-ext-passkey.md new file mode 100644 index 000000000..3ea19d798 --- /dev/null +++ b/docs/Password Manager/password-manager-web-extension/pwm-ext-passkey.md @@ -0,0 +1,113 @@ +--- +title: Passkey + +slug: pwm-ext-passkey +excerpt: Web Extension +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +Use the following steps to view, create, and use passkeys with the Akeyless Password Manager Web Extension. + +## Passkey Management Overview + +The extension supports passkey operations, including viewing saved passkeys, using them for sign-in, and creating new passkeys for supported websites. + +## Viewing Passkey Details + +The Passkey Details section allows users to view information about their saved passkeys. + +### Fields Displayed + +* Passkey Name: The label or identifier for the passkey. +* Username/Email: The email or username used when the passkey was created. +* Creation Date: The date when the passkey was created. +* Related Website: The website the passkey is linked to for login. +* Option to Delete Passkey: Allows users to remove the passkey from the system. + +The extension improves passkey lookup and suggestion behavior for supported sites. + +## Using a Passkey for Login + +The following steps guide users on how to log in using an existing passkey for a supported website: + +### Steps + +1. Navigate to a passkey-supported website. +2. Start the sign-in flow. +3. If matching passkeys exist, select the passkey to continue authentication. + +This flow includes matching passkeys to supported sites and login contexts. + +### Example Flow + +* Go to the website → Try to sign in → If passkey exists → Show available passkeys. + +## Creating a New Passkey + +Users can create a new passkey for a supported website. Follow the steps below to generate and save a passkey within the system. + +### Steps + +1. Navigate to passkey creation on a supported website. +2. Select the website option to add a passkey. +3. Complete website authentication if required. +4. Complete the extension prompt to create or update the passkey. +5. Confirm success message. + +The extension supports choosing the account default protection key or a specific protection key when creating supported passkeys. + +#### Example Flow + +* Navigate to the website → Click on "Add Passkey" → Authenticate (if needed) → Check passkey existence → Create or update passkey → Save passkey → Success/Error message. + +## Error and Success Messages + +* Error Message: Shown when the passkey creation or update process fails. +* Success Message: Displayed when the passkey is successfully created or updated. + +## Transport and Authenticator Behavior + +When a passkey is created, the extension processes browser-provided WebAuthn data, including authenticator transport metadata. + +Transport values can include: + +* `hybrid` +* `internal` +* `usb` + +These values come from the authenticator and browser flow. They are used by the extension during passkey handling and are not configured as manual user inputs in Password Manager pages. + +## WebAuthn Metadata Handling + +During passkey create and assert flows, the extension normalizes WebAuthn request metadata from the browser before processing. + +Normalized metadata includes values such as: + +* Challenge and RP context. +* Origin and client data payload. +* User verification and resident-key requirements. +* Credential include or exclude descriptors. +* Supported public-key algorithm selection. + +These values are handled internally by the extension flow and are not directly edited by end users in Password Manager screens. + +## Toggling Passkey Authentication in the Web Extension + +Users can enable or disable Passkey Authentication directly through the web extension. This allows them to control when the extension uses passkeys for login. + +Steps: + +1. Open the web extension. +2. Click on the three-dot menu in the upper-right corner of the extension. +3. Locate the Passkey Authentication toggle in settings. +4. Turn the setting on or off. +5. When enabled, the extension can provide passkey-based login suggestions on supported pages. +6. When disabled, passkey functionality is not used for sign-in suggestions. + +* Note: Disabling Passkey Authentication does not delete saved passkeys but prevents them from being used until re-enabled. diff --git a/docs/Password Manager/password-manager-web-extension/pwm-ext-search-passwords-and-secrets.md b/docs/Password Manager/password-manager-web-extension/pwm-ext-search-passwords-and-secrets.md new file mode 100644 index 000000000..eac28c9fb --- /dev/null +++ b/docs/Password Manager/password-manager-web-extension/pwm-ext-search-passwords-and-secrets.md @@ -0,0 +1,55 @@ +--- +title: Searching for Passwords and Secrets + +slug: pwm-ext-search-passwords-and-secrets +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +Use search to find passwords and secrets across the current area in the extension. + +![Search bar in the web extension showing multi-field search results](https://files.readme.io/6f615f8-Screenshot_2024-04-11_at_14.12.10.png) + +Search can help match items by: + +* Item name. +* Folder path. +* Username. +* Website context, where available. + +## Multi-Field Search Behavior + +The search input applies a multi-field filter across item metadata and not only item names. + +When a match is found in username or website fields, the extension can display that matched value in the item row to help explain why an item appeared in results. + +The same search term also applies to favorites in the extension view. + +## Search Results Display + +Search results show key item details to help differentiate similar credentials: + +* Item name. +* Item path. +* Username or related website context, depending on the item data available. + +## Using the Search Bar + +To search for an item: + +1. Click on the search bar located at the top of either the Personal or Corporate Area. +2. Enter the relevant search term. +3. Review the filtered results. +4. Open the matching item. + +## Tip + +Use search together with filters, tags, and folder navigation when many similar items exist in the same area. + +For more advanced organization and filtering strategies, see [Using Filters and Tags](https://docs.akeyless.io/docs/pwm-ext-use-filters-and-tags). diff --git a/docs/Password Manager/password-manager-web-extension/pwm-ext-setting-password-policy-on-account-level.md b/docs/Password Manager/password-manager-web-extension/pwm-ext-setting-password-policy-on-account-level.md new file mode 100644 index 000000000..ef0195034 --- /dev/null +++ b/docs/Password Manager/password-manager-web-extension/pwm-ext-setting-password-policy-on-account-level.md @@ -0,0 +1,65 @@ +--- +title: Setting Password Policy + +slug: pwm-ext-setting-password-policy-on-account-level +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +Use the following steps to view and configure the password generation policy for your account in the web extension. + +## Access the Password Generation Policy + +![Password generation policy setting in the web extension](https://files.readme.io/dcc11c6-Screenshot_2024-01-10_at_16.43.35.png) + +1. Open the extension. +2. Open the three-dot menu. +3. Select **Password generation policy**. +4. Review and update the default password-generation settings. + +## Set the Account-Level Default Policy + +**Character Length**: Set the default password length. + +**Include Uppercase Letters (A-Z):** Require uppercase letters. + +**Include Lowercase Letters (a-z):** Require lowercase letters. + +**Include Numbers (0-9):** Require numbers. + +**Include Special Characters (!@#):** Require special characters. + +The extension supports password-generation guidance and tuning allowed special characters during generation. + +These settings provide the default generation behavior. Users can still work within the limits allowed by the configured policy. + +## Set the Policy for a Specific Password + +You can adjust password-generation settings while creating or editing an individual password, as long as the selected values stay within the organization-level policy. + +![Password policy configuration screen in the web extension](https://files.readme.io/c6ca311-Screenshot_2024-01-10_at_16.41.08.png) + +### Configure Password Settings During Creation + +1. Start creating a new password. +2. Open the password-generation settings. +3. Adjust the available password parameters. +4. Generate or enter the password. +5. Save the item. + +### Update Password Settings During Editing + +1. Open the existing password. +2. Select **Edit**. +3. Adjust the password-related settings that are available for the item. +4. Save the changes. + +## Important + +Item-level password settings cannot reduce the effective requirements below the account-level policy. diff --git a/docs/Password Manager/password-manager-web-extension/pwm-ext-sharing-password.md b/docs/Password Manager/password-manager-web-extension/pwm-ext-sharing-password.md new file mode 100644 index 000000000..98089eab4 --- /dev/null +++ b/docs/Password Manager/password-manager-web-extension/pwm-ext-sharing-password.md @@ -0,0 +1,34 @@ +--- +title: Sharing a Password or Secret + +slug: pwm-ext-sharing-password +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +Use the following steps to share a password or secret with other users from the Akeyless Password Manager Web Extension. + +## Share an Item + +![Quick action menu with Share option next to a password entry](https://files.readme.io/264d287-Screenshot_2024-01-10_at_16.44.54.png) + +1. Locate the password or secret in the item list. +2. Open the item actions menu. +3. Select **Share**. +4. Enter the recipient information required by the share flow. +5. Select the validity period for the sharing link. +6. Generate the share link. + +After the link is generated, copy it and deliver it through the required communication channel. + +![Get Link to Share button in the sharing dialog](https://files.readme.io/8101e3f-Screenshot_2024-01-10_at_16.46.00.png) + +## Recommendation + +Share only the specific item needed for the task, and use the shortest practical link validity period. diff --git a/docs/Password Manager/password-manager-web-extension/pwm-ext-switch-between-folder-and-flat-views.md b/docs/Password Manager/password-manager-web-extension/pwm-ext-switch-between-folder-and-flat-views.md new file mode 100644 index 000000000..8cb7bc0ed --- /dev/null +++ b/docs/Password Manager/password-manager-web-extension/pwm-ext-switch-between-folder-and-flat-views.md @@ -0,0 +1,35 @@ +--- +title: Passwords and Secrets List Switching Between Folders and Flat View + +slug: pwm-ext-switch-between-folder-and-flat-views +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +Use the following steps to switch between the folder and flat list views in the extension. + +## Switching Between Views in Personal and Corporate Areas + +The extension provides two ways to view items in the Personal and Corporate areas. + +## Flat View + +Flat view shows items without folder nesting. + +## Folder View + +Folder view shows items within the folder hierarchy. + +## Switching Between Views + +To switch between the flat and folder views, follow these steps: + +1. Navigate to the Flat View / Folder View icon located near the search field. +2. Select **Flat View** to display items without folder nesting. +3. Select **Folder View** to display the folder structure. diff --git a/docs/Password Manager/password-manager-web-extension/pwm-ext-use-filters-and-tags.md b/docs/Password Manager/password-manager-web-extension/pwm-ext-use-filters-and-tags.md new file mode 100644 index 000000000..f03a00b3d --- /dev/null +++ b/docs/Password Manager/password-manager-web-extension/pwm-ext-use-filters-and-tags.md @@ -0,0 +1,60 @@ +--- +title: Using Filters & Tags + +slug: pwm-ext-use-filters-and-tags +excerpt: '' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +The extension supports filtering by item type and tags to help you locate specific items quickly. + +## Filtering Passwords and Secrets + +Use filters to narrow the current item list by type, tags, or both. + +## Using Types + +![Type filter options in the web extension](https://files.readme.io/1525939-Screenshot_2024-01-10_at_16.51.06.png) + +Types help group items by purpose or item category. + +### Filter by Types + +1. Click **Filter** in the current area. +2. Open the **Types** tab. +3. Select the required types. +4. Click **Apply**. + +## Using Tags + +Tags help categorize items beyond their basic type. + +![Tag filter options in the web extension](https://files.readme.io/c13164c-Screenshot_2024-01-10_at_16.50.58.png) + +### Filter by Tags + +1. Click **Filter** in the current area. +2. Open the **Tags** tab. +3. Select the required tags. +4. Click **Apply**. + +## Combining Types and Tags + +You can combine types and tags in the same filter selection. + +### Combine Types and Tags + +1. Click **Filter**. +2. Select the required types. +3. Select the required tags. +4. Click **Apply**. + +## Tip + +Use filters together with search when the same application or environment has multiple related items. diff --git a/docs/Password Manager/password-manager-web-extension/setting-password-policy-on-account-level-1.md b/docs/Password Manager/password-manager-web-extension/setting-password-policy-on-account-level-1.md deleted file mode 100644 index dc9f79ec3..000000000 --- a/docs/Password Manager/password-manager-web-extension/setting-password-policy-on-account-level-1.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Setting Password Policy On Account Level -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -## Accessing Secret Generation Policy - -![Illustration for: Accessing Secret Generation Policy](https://files.readme.io/dcc11c6-Screenshot_2024-01-10_at_16.43.35.png) - -Open the Akeyless browser extension. - -Navigate to the "Settings" menu on the bottom represented as 3 dots on the upper top part of the screen. - -Locate and click on "Password Generation Policy" in the displayed, click on this option. - -A Password Generation Policy screen will appear, providing options to configure the secret generation policy. - -## Define the Following Parameters - -**Character Length**: Set the desired default length for secrets created within your account. - -**Include Uppercase Letters (A-Z):** Check this box to require at least one uppercase letter in the secret. If solely selected, the secret will consist exclusively of uppercase letters. - -**Include Lowercase Letters (a-z):** Check this box to ensure at least one lowercase letter is included in the secret. If solely selected, the secret will consist exclusively of lowercase letters. - -**Include Numbers (0-9):** Check this box to mandate at least one numeric character in the secret. If solely selected, the secret will consist exclusively of numeric characters. - -**Include Special Characters (!@#):** Check this box to ensure at least one special character is included in the secret. If solely selected, the secret will consist exclusively of special characters. - -By configuring these settings, you establish a standardized default for secret generation in your organization's account. Users can still modify parameters during secret creation, but the defaults will adhere to the rules you've set. diff --git a/docs/Password Manager/password-manager-web-extension/setting-password-policy-on-password-level-1.md b/docs/Password Manager/password-manager-web-extension/setting-password-policy-on-password-level-1.md deleted file mode 100644 index 7a678893f..000000000 --- a/docs/Password Manager/password-manager-web-extension/setting-password-policy-on-password-level-1.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Setting Password Policy On Password Level -excerpt: '' -deprecated: false -hidden: true -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -In our Akeyless browser extension, you have the flexibility to define specific secret policies for individual secrets during creation or editing. This ensures that your security requirements align with the uniqueness of each secret. - -## How It Works - -![Illustration for: How It Works](https://files.readme.io/c6ca311-Screenshot_2024-01-10_at_16.41.08.png) - -## Creating a New Secret - -When creating a new secret, find these options under the secret field. Adjust the settings based on your specific requirements, and the secret will be generated accordingly. - -## Editing an Existing Secret - -If you need to update the secret policy for an existing secret, navigate to the secret editing screen. Here, you'll find the same options under the secret field to tailor the policy as needed. diff --git a/docs/Password Manager/password-manager-web-extension/sharing-password-1.md b/docs/Password Manager/password-manager-web-extension/sharing-password-1.md deleted file mode 100644 index e96706d0a..000000000 --- a/docs/Password Manager/password-manager-web-extension/sharing-password-1.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Sharing Password / Secret -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -## Sharing a Password with the Quick Action Menu - -![Illustration for: Sharing a Password with the Quick Action Menu](https://files.readme.io/264d287-Screenshot_2024-01-10_at_16.44.54.png) - -1. Hover over the password or secret you want to share in the password or secrets list. A small menu will appear. - -2. Click on the "Share" option. A share window will appear. - -3. Enter the email address of the person you want to share the password or secret with. - -4. Select for how long the sharing link will be valid. - -5. Click on the "Get Link to Share" button. The link to share will be copied to your clipboard. - -You can then paste the link into an email or other message to send to the person you want to share the password or secret with. - -![Illustration for: 5. Click on the "Get Link to Share" button. The link to share will be copied to your clipboard. You can then paste the link into an email or other message to send to the person…](https://files.readme.io/8101e3f-Screenshot_2024-01-10_at_16.46.00.png) diff --git a/docs/Password Manager/password-manager-web-extension/using-autofillpassword-injection-functionality-1.md b/docs/Password Manager/password-manager-web-extension/using-autofillpassword-injection-functionality-1.md deleted file mode 100644 index 372b99eeb..000000000 --- a/docs/Password Manager/password-manager-web-extension/using-autofillpassword-injection-functionality-1.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: Using Autofill/Password Injection Functionality -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -Password AutoFill is a feature of many web browsers that allows you to automatically fill in your login credentials for websites. - -![Illustration for: Password AutoFill is a feature of many web browsers that allows you to automatically fill in your login credentials for websites.](https://files.readme.io/e491682-Screenshot_2024-01-10_at_16.55.04.png) - -How to Use Password AutoFill - -Go to the website where you want to log in. - -Enter your email address or username into the appropriate field. - -Click on the password field. - -If your browser has saved your credentials for this website, it will automatically fill in your password for you. - -If your browser has not saved your credentials for this website, you will be prompted to save it. diff --git a/docs/Password Manager/password-manager-web-extension/using-filters-tags.md b/docs/Password Manager/password-manager-web-extension/using-filters-tags.md deleted file mode 100644 index 79fac4406..000000000 --- a/docs/Password Manager/password-manager-web-extension/using-filters-tags.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: Using Filters & Tags -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -## Filtering Passwords and Secrets - -The Akeyless Password Manager web browser extension provides a powerful filtering feature to help you quickly find the passwords and secrets you need. You can filter passwords and secrets by using types, tags, or a combination of both. - -## Using Types - -![Illustration for: Using Types](https://files.readme.io/1525939-Screenshot_2024-01-10_at_16.51.06.png) - -Types are custom identifiers that you can assign to passwords and secrets. This can be helpful for organizing passwords and secrets according to their purpose or website. - -### To Filter Passwords and Secrets by Labels - -Click on the "Filter" button in the top right corner of the Personal or Corporate Area. - -Select the "Types" tab. - -Click on the checkbox next to the types you want to filter by. - -Click on the "Apply" button. - -The filtered passwords and secrets will be displayed in the Personal or Corporate Area. - -## Using Tags - -Tags are predefined keywords that are associated with passwords and secrets. Tags can be used to further categorize passwords and secrets. - -![Illustration for: Tags are predefined keywords that are associated with passwords and secrets. Tags can be used to further categorize passwords and secrets.](https://files.readme.io/c13164c-Screenshot_2024-01-10_at_16.50.58.png) - -### To Filter Passwords and Secrets by Tags - -Click on the "Filter" button in the top right corner of the Personal or Corporate Area. - -Select the "Tags" tab. - -Click on the checkbox next to the tags you want to filter by. - -Click on the "Apply" button. - -The filtered passwords and secrets will be displayed in the Personal or Corporate Area. - -## Combining Types and Tags - -You can combine labels and tags to create even more powerful filters. For example, you could filter passwords and secrets that have the label "banking" and the tag "personal." - -### To Filter Passwords and Secrets by Labels and Tags - -Click on the "Filter" button in the top right corner of the Personal or Corporate Area. - -Select the "Types" tab and select the desired labels. - -Select the "Tags" tab and select the desired tags. - -Click on the "Apply" button. - -The filtered passwords and secrets will be displayed in the Personal or Corporate Area. diff --git a/docs/Password Manager/password-manager-web-extension/using-search.md b/docs/Password Manager/password-manager-web-extension/using-search.md deleted file mode 100644 index e383dfd82..000000000 --- a/docs/Password Manager/password-manager-web-extension/using-search.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Searching for Passwords and Secrets -excerpt: '' -deprecated: false -hidden: false -metadata: - title: '' - description: '' - robots: index -next: - description: '' ---- -The Akeyless Password Manager web browser extension enhances its functionality with an advanced multi-field search capability, designed to streamline your search process and ensure you find the passwords and secrets you need with ease. This powerful feature allows you to simultaneously search across multiple criteria, significantly broadening your search scope and improving the chances of locating the exact information you require. - -![Illustration for: The Akeyless Password Manager web browser extension enhances its functionality with an advanced multi-field search capability, designed to streamline your search process and…](https://files.readme.io/6f615f8-Screenshot_2024-04-11_at_14.12.10.png) - -Password Name: Directly look up the name you've assigned to your password or secret, ensuring you can quickly find credentials without remembering their associated details. - -Location (Paths): Navigate through the hierarchy of your saved passwords and secrets by specifying their storage path, making it easier to manage credentials stored in different folders. - -Username: If you're looking for a password or secret associated with a specific username, this search criterion can narrow down your results to the most relevant entries. - -Website URL (Hover Feature): For an enhanced user experience, hovering over a search result will reveal the website URL associated with each password or secret, provided this information exists. This feature is especially useful when you need to differentiate between multiple accounts held on the same platform. - -## Search Results Display - -When your search yields results, the Akeyless Password Manager web browser extension ensures that certain key fields are always visible to you: - -* Password/Secret Name: This is always displayed, making it straightforward to identify the specific credential you're after. -* Password/Secret Path: The path is also always shown, helping you understand where in your folder hierarchy the password or secret resides. - - Additionally, the username associated with each password or secret will be displayed by default. However, for a deeper insight, simply hover over an item to switch this display to the website URL, if such information is available. This dual-display functionality enriches your search experience by providing contextual information that can help you better manage your credentials. - -## Using the Search Bar - -To use this enhanced search functionality, follow these steps: - -1. Click on the search bar located at the top of either the Personal or Corporate Area. -2. Input the search term or criteria relevant to the passwords and secrets you wish to find. You can include password names, location paths, or usernames in your search. -3. View the filtered results displayed in your chosen area, making it quicker and more efficient to access your desired passwords and secrets. diff --git a/docs/Password Manager/pwm-security-health.md b/docs/Password Manager/pwm-security-health.md new file mode 100644 index 000000000..f3877a8db --- /dev/null +++ b/docs/Password Manager/pwm-security-health.md @@ -0,0 +1,69 @@ +--- +title: Security Health + +slug: pwm-security-health +excerpt: 'Monitor password strength, breach exposure, and account risk across your Password Manager vault.' +deprecated: false +hidden: false +metadata: + title: '' + description: '' + robots: index +next: + description: '' +--- +Security Health helps users and administrators review password risk indicators and identify remediation actions across both the Password Manager Web Extension (personal vault view) and the Password Manager Web Console (admin dashboard). Both surfaces provide visibility into password strength, breach exposure, and other signals that indicate elevated account risk to help prioritize password updates and security improvements. + +## What Security Health Shows + +* Overall security score for password hygiene review. +* Weak-password indicators and remediation suggestions. +* Reused-password detection across your vault. +* Breach-related insights identifying passwords exposed in known data breaches. +* Personal-vault analysis (extension) or account-level analysis (console). + +## Typical Review Flow + +1. Open the relevant Password Manager surface (Web Extension or Web Console). +2. Navigate to the Security Health view. +3. Review the current score and supporting metrics. +4. Inspect affected items and update weak, reused, or exposed passwords as needed. + +## Password Manager Web Extension (User View) + +The Web Extension provides a personal-vault view of password hygiene, helping individual users review the security of their stored credentials. The interface includes an overall score view, weak and reused password insights, and breach-related alerts to help users identify passwords that require attention. + +Security Health features may vary based on account configuration. When enabled, password-score functionality uses password-related signals to help summarize the current state of your vault. + +## Password Manager Web Console (Admin View) + +The Web Console provides an admin dashboard for reviewing account-level password security metrics, including aggregated scores across all users and password strength analytics. + +### Security Score + +The **Overall Security Score** is a 0–100 aggregate value calculated as the average of all individual password scores in the account, reflecting the overall strength of passwords stored in Password Manager. Each password's score is determined by factors such as password length and character variety. + +The dashboard gauge shows the current score out of 100. Scores closer to 100 indicate a stronger password portfolio. + +> 📘 **Note:** +> +> The password score feature must be enabled in account settings before scores are calculated and displayed. When disabled, the Security Health page is not accessible. + +When a password's score is low, the **Suggestion** column in the password list shows a remediation prompt, for example: **Low score**: Strengthen password. Consider length or variety. **Zero score**: Weak password. Use longer password and mix character types. + +### Dashboard Layout and Filtering + +The Security Health dashboard displays: + +1. **Gauges section** — Overall Security Score, Weak passwords count, and Reused passwords count. +2. **Password list section** — Password name, location, Risk Level, Suggestion, and Last updated timestamp. + +[Use filters](https://docs.akeyless.io/docs/pwm-ext-use-filters-and-tags) to scope the password list: Weak passwords, Compromised passwords, or Update-required passwords. + +### Compromised Password Detection + +Security Health checks passwords against the [Have I Been Pwned](https://haveibeenpwned.com/) database, which aggregates publicly disclosed password breaches. This check identifies **Exposure** (whether a password appeared in any known breach), **Reuse-risk indicators** (how many times the same password was exposed across breaches), and **Security score enrichment** (incorporating breach metrics into overall assessment). Passwords flagged appear in the password list with a **Compromised** risk level—use the filter to isolate and prioritize remediation. + +### Toggle for Password Score Feature + +The account settings page includes a toggle for password scoring located under "Password Management." The feature is disabled by default. When enabled, password scores are calculated and displayed; when disabled, scores are hidden.