mirror of
https://github.com/Unleash/unleash.git
synced 2025-08-27 13:49:10 +02:00
Delete how-to download login history
This commit is contained in:
melindafekete
parent
44dc5ab29b
commit
2251390944
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: How to download your login history
|
||||
---
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.22+`
|
||||
|
||||
:::
|
||||
|
||||
[Login history](../reference/login-history.md) enables Unleash admins to audit login events and their respective information, including whether they were successful or not.
|
||||
|
||||
## Step 1: Navigate to the login history page {#step-1}
|
||||
|
||||
Navigate to the _login history_ page in the admin UI (available at the URL `/admin/logins`). Use the _settings_ button in the navigation menu and select "login history".
|
||||
|
||||
|
||||
|
||||
## Step 2: Click the "Download login history" button {#step-2}
|
||||
|
||||
Use the "download login history" button to proceed with the download of the login history as CSV.
|
||||
|
||||
|
||||
@ -1,42 +0,0 @@
|
||||
---
|
||||
title: Login History
|
||||
---
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.22+`
|
||||
|
||||
:::
|
||||
|
||||
Unleash's login history lets you track login events in your Unleash instance, and whether the attempts were successful in logging in or not.
|
||||
|
||||
|
||||
|
||||
For each login event, it lists:
|
||||
|
||||
- **Created**: When it happened
|
||||
- **Username**: The username that was used
|
||||
- **Authentication**: The authentication type that was used
|
||||
- **IP address**: The IP address that made the attempt
|
||||
- **Success**: Whether the attempt was successful or not
|
||||
- **Failure reason**: If the attempt was not successful, the reason why
|
||||
|
||||
You can see the failure reason by hovering over the "False" badge in the "Success" column.
|
||||
|
||||
|
||||
|
||||
Use the login history to:
|
||||
|
||||
- Audit login events in your Unleash instance
|
||||
- Identify failed login attempts and investigate the cause
|
||||
- Debug misconfigured authentication providers
|
||||
|
||||
The login history is mutable: You can remove individual login events or clear the entire history by deleting all of them.
|
||||
|
||||
Finally, the login history can be downloaded ([how do I download my Unleash login history](../how-to/how-to-download-login-history.mdx)) for external backups, audits, and the like.
|
||||
|
||||
## Retention
|
||||
|
||||
Events in the login history are retained for 336 hours (14 days).
|
||||
|
||||
Events older than the retention period are automatically deleted, and you won't be able to recover them. If you would like to collect login event information past the retention period, we suggest periodically downloading the login history.
|
||||
31
website/docs/reference/login-history.mdx
Normal file
31
website/docs/reference/login-history.mdx
Normal file
@ -0,0 +1,31 @@
|
||||
---
|
||||
title: Login History
|
||||
---
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.22+`
|
||||
|
||||
:::
|
||||
|
||||
Login history helps you monitor access to your Unleash instance by tracking login events. It records both successful and unsuccessful login attempts. You can use this information to audit user activity within your instance, identify and investigate failed login attempts, or debug issues related to misconfigured authentication providers.
|
||||
|
||||
You can find the login history in the Admin UI by navigating to **Admin settings > User config > Login history**.
|
||||
|
||||
For each login event, it lists:
|
||||
|
||||
- **Created**: The date and time the login event occurred.
|
||||
- **Username**: The username used for the login attempt.
|
||||
- **Authentication**: The type of authentication method used (for example, `password`, `open-id-connect`).
|
||||
- **IP address**: The IP address from which the login attempt was made.
|
||||
- **Success**: Whether the attempt was successful (`True` for successful).
|
||||
- **Failure reason**: If a login attempt failed, this provides the reason. To see the failure reason, hover over the `False` label in the **Success** column.
|
||||
|
||||
## Data retention
|
||||
|
||||
Login history events are kept for 336 hours (14 days). Events older than this retention period are automatically deleted and cannot be recovered. If you need to retain login event information for a longer period, consider periodically [downloading login history](#download-login-history).
|
||||
|
||||
# Download login history
|
||||
|
||||
To download the login history, go to the login history page and click **Download login history**.
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: I don't see a documented Unleash feature in my admin UI
|
||||
---
|
||||
|
||||
Occasionally, users might come across a situation where a documented Unleash feature isn't visible in their admin UI. Here's how to troubleshoot this issue.
|
||||
|
||||
You can usually find availability information in the feature's documentation page, displayed in a box like this:
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.5+`
|
||||
|
||||
:::
|
||||
|
||||
1. Check that the feature is available in your current Unleash version. For example, [Service accounts](/reference/service-accounts) are available in **Unleash 4.21** and later. If you're running a previous version, you'll need to update your Unleash instance.
|
||||
2. Make sure the feature is available for your plan, as you may need to [upgrade your plan](https://www.getunleash.io/pricing) to access the feature.
|
||||
3. If this is a beta feature, it may not be enabled for your Unleash instance. Here's how you can enable it:
|
||||
- If you have a **hosted** Unleash instance and you'd like early access to the new feature, reach out to us so we can enable it for you.
|
||||
- If you're running a **self-hosted** Unleash instance, make sure you've enabled the feature in your Unleash configuration. Usually, this involves setting the correct environment variable. You can check the current flags and respective environment variables in your version's [src/lib/types/experimental.ts](https://github.com/Unleash/unleash/blob/main/src/lib/types/experimental.ts). Setting this variable may look something like `UNLEASH_EXPERIMENTAL_NEW_FEATURE=true`.
|
||||
|
||||
If you've followed the above steps and still can't access the feature, please [contact us](https://slack.unleash.run) for further assistance.
|
||||
|
||||
If you're currently using a beta feature, please [reach out to us](https://slack.unleash.run)! We would be thrilled if you could provide some feedback.
|
||||
@ -849,10 +849,6 @@ class="header-github-link"
|
||||
from: '/how-to/how-to-troubleshoot-https',
|
||||
to: '/using-unleash/troubleshooting/https',
|
||||
},
|
||||
{
|
||||
from: '/how-to/how-to-troubleshoot-feature-not-available',
|
||||
to: '/using-unleash/troubleshooting/feature-not-available',
|
||||
},
|
||||
{
|
||||
from: [
|
||||
'/reference/deploy/import-export',
|
||||
|
||||
@ -646,12 +646,11 @@ const sidebars: SidebarsConfig = {
|
||||
type: 'category',
|
||||
link: {
|
||||
type: 'doc',
|
||||
id: '/using-unleash/troubleshooting/cors',
|
||||
id: 'using-unleash/troubleshooting/cors',
|
||||
},
|
||||
items: [
|
||||
'using-unleash/troubleshooting/cors',
|
||||
'using-unleash/troubleshooting/https',
|
||||
'using-unleash/troubleshooting/feature-not-available',
|
||||
'using-unleash/troubleshooting/flag-exposure',
|
||||
'using-unleash/troubleshooting/flag-not-returned',
|
||||
'using-unleash/troubleshooting/flag-abn-test-unexpected-result',
|
||||
@ -678,7 +677,6 @@ const sidebars: SidebarsConfig = {
|
||||
slug: '/how-to/api',
|
||||
},
|
||||
items: [
|
||||
'how-to/how-to-download-login-history',
|
||||
'how-to/how-to-use-the-admin-api',
|
||||
'how-to/how-to-enable-openapi',
|
||||
],
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 66 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 36 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 22 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 78 KiB |
@ -802,8 +802,13 @@
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/how-to/how-to-troubleshoot-feature-not-available",
|
||||
"destination": "/using-unleash/troubleshooting/feature-not-available",
|
||||
"source": "/using-unleash/troubleshooting/feature-not-available",
|
||||
"destination": "/availability",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/how-to/how-to-download-login-history",
|
||||
"destination": "/reference/login-history",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
|
||||
Loading…
Reference in New Issue
Block a user