Skip to content

Commit

Permalink
website/docs: add new section about impersonation (cherry-pick #12328) (
Browse files Browse the repository at this point in the history
#12424)

website/docs: add new section about impersonation (#12328)

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Co-authored-by: Tana M Berry <tana@goauthentik.com>
Co-authored-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>
  • Loading branch information
4 people authored Dec 19, 2024
1 parent 249dc27 commit d313225
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 1 deletion.
4 changes: 4 additions & 0 deletions website/docs/sys-mgmt/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,10 @@ When enabled, all the events caused by a user will be deleted upon the user's de

Globally enable/disable impersonation. Defaults to `true`.

### Require reason for impersonation

Require administrators to provide a reason for impersonating a user. Defaults to `true`.

### Default token duration

Default duration for generated tokens. Defaults to `minutes=30`.
Expand Down
17 changes: 16 additions & 1 deletion website/docs/users-sources/user/user_basic_operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ If the user does not receive the email, check if the mail server parameters [are
As an Admin, you can simply reset the password for the user.

1. In the Admin interface, navigate to **Directory > Users** to display all users.
2. Either click the name of the user to display the full User details page, or click the chevron beside their name to expand the toptions.
2. Either click the name of the user to display the full User details page, or click the chevron beside their name to expand the options.
3. To reset the user's password, click **Reset password**, and then define the new value.

## Deactivate or Delete user
Expand All @@ -128,3 +128,18 @@ You may instead deactivate the account to preserve identity data.
2. Review the changes and click **Delete**.

The user list refreshes and no longer displays the removed users.

## Impersonate a user

With authentik, an Admin can impersonate a user, meaning that the Admin temporarily assumes the identity of the user.

1. In the Admin interface, navigate to **Directory > Users** to display all users.
2. Click the name of the user to display the full User details page.
3. On the Overview tab, beneath **User Details**, in the **Actions** area, click **Impersonate**.
4. At the prompt, provide a reason why you are impersonating this user, and then click **Impersonate**.

:::info
An Admin can globally enable or disable impersonation in the [System Settings](../../sys-mgmt/settings.md#impersonation). By default, this option is set to true, meaning all users can be impersonated.

An Admin can also configure whether inputting a reason for impersonation is required in the [System Settings](../../sys-mgmt/settings.md#require-reason-for-impersonation).
:::

0 comments on commit d313225

Please sign in to comment.