mirror of
https://github.com/Unleash/unleash.git
synced 2025-01-20 00:08:02 +01:00
docs: login history (#3261)
https://linear.app/unleash/issue/2-728/documentation-login-history - [reference/login-history](https://unleash-docs-git-docs-login-history-unleash-team.vercel.app/reference/login-history) - [how-to/how-to-download-login-history](https://unleash-docs-git-docs-login-history-unleash-team.vercel.app/how-to/how-to-download-login-history) ![image](https://user-images.githubusercontent.com/14320932/223392428-fb693624-77a5-4d63-bb00-20e035e23f9e.png) --------- Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
This commit is contained in:
parent
f80ce1e0b5
commit
516cb1884b
23
website/docs/how-to/how-to-download-login-history.mdx
Normal file
23
website/docs/how-to/how-to-download-login-history.mdx
Normal file
@ -0,0 +1,23 @@
|
||||
---
|
||||
title: How to download your login history
|
||||
---
|
||||
|
||||
:::info availability
|
||||
|
||||
Login history is an enterprise feature available from Unleash 4.22 onwards.
|
||||
|
||||
:::
|
||||
|
||||
[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".
|
||||
|
||||
![The admin UI navigation settings submenu with the login history item highlighted.](/img/login-history-1.png)
|
||||
|
||||
## 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.
|
||||
|
||||
![The login history table with the "download login history" button highlighted.](/img/login-history-2.png)
|
42
website/docs/reference/login-history.md
Normal file
42
website/docs/reference/login-history.md
Normal file
@ -0,0 +1,42 @@
|
||||
---
|
||||
title: Login history
|
||||
---
|
||||
|
||||
:::info
|
||||
|
||||
Login history is an enterprise feature available from Unleash 4.22 onwards.
|
||||
|
||||
:::
|
||||
|
||||
Unleash's login history lets you track login events in your Unleash instance, and whether the attempts were successful in logging in or not.
|
||||
|
||||
![Login history table](/img/login-history-table.png)
|
||||
|
||||
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.
|
||||
|
||||
![Login history table failure reason](/img/login-history-table-fail.png)
|
||||
|
||||
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.
|
@ -69,6 +69,7 @@ module.exports = {
|
||||
'how-to/how-to-create-api-tokens',
|
||||
'how-to/how-to-create-personal-access-tokens',
|
||||
'how-to/how-to-create-service-accounts',
|
||||
'how-to/how-to-download-login-history',
|
||||
'how-to/how-to-use-the-admin-api',
|
||||
'how-to/how-to-enable-openapi',
|
||||
],
|
||||
@ -316,6 +317,7 @@ module.exports = {
|
||||
'reference/feature-toggle-types',
|
||||
'reference/feature-toggle-variants',
|
||||
'reference/front-end-api',
|
||||
'reference/login-history',
|
||||
'reference/network-view',
|
||||
'reference/playground',
|
||||
'reference/public-signup',
|
||||
|
BIN
website/static/img/login-history-1.png
Normal file
BIN
website/static/img/login-history-1.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 66 KiB |
BIN
website/static/img/login-history-2.png
Normal file
BIN
website/static/img/login-history-2.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 36 KiB |
BIN
website/static/img/login-history-table-fail.png
Normal file
BIN
website/static/img/login-history-table-fail.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 22 KiB |
BIN
website/static/img/login-history-table.png
Normal file
BIN
website/static/img/login-history-table.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 78 KiB |
Loading…
Reference in New Issue
Block a user