Skip to content

fix(users): use <details/> tags for user types to correct toc #516

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stijnmoreels merged 3 commits into from
Mar 30, 2026
Merged

fix(users): use <details/> tags for user types to correct toc #516

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a7d19f1
fix(users): use <details/> tags for user types to correct toc
stijnmoreels Mar 27, 2026
4ea48ab
fix(users): use query string to fix anchor links
stijnmoreels Mar 27, 2026
03a4e78
Merge branch 'main' into chore/use-details-io-tabs-for-users
stijnmoreels Mar 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ module.exports = {
]
],
plugins: [
'docusaurus-plugin-image-zoom'
'docusaurus-plugin-zooming'
],
presets: [
[
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"@mdx-js/react": "^3.0.1",
"@svgr/webpack": "^8.1.0",
"clsx": "^2.1.1",
"docusaurus-plugin-image-zoom": "^3.0.1",
"docusaurus-plugin-zooming": "^1.0.0",
"file-loader": "^6.2.0",
"prism-react-renderer": "^2.3.1",
"react": "^18.3.1",
Expand Down
28 changes: 16 additions & 12 deletions pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion versioned_docs/version-v6.0.0/dashboard/installation/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -402,7 +402,7 @@ stages:
During the deployment of the system, an administrator account has been generated for your initial login to the Dashboard.

:::praise[recommended]
It is recommended to create a new `System Admin` user with your own email address after signing in for the first time. This will help during the [Forgot Password](../security/01_users.mdx#configure-forgot-password-procedure-) procedure.
It is recommended to create a new `System Admin` user with your own email address after signing in for the first time. This will help during the [Forgot Password](../security/01_users.mdx?user-type=local) procedure.
:::

Follow the steps below to sign in to the Dashboard:
Expand Down
62 changes: 45 additions & 17 deletions versioned_docs/version-v6.0.0/dashboard/security/01_users.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,32 +15,45 @@ Use **Entra ID** users over local users for security reasons.

![users overview](/images/v2_users1.png)

<Tabs groupId="user-source">
<TabItem value="ad" label="Entra ID" default>
<Tabs groupId="user-type" queryString>
<TabItem value="entra-id" label="Entra ID" default>

> 👤 Requires membership of a [synced Entra ID group](../installation/01_give_ad_access.mdx#sync-your-microsoft-entra-id-groups-to-invictus-).

The Invictus Dashboard can be configured to [use existing users in Microsoft Entra ID groups](../installation/01_give_ad_access.mdx). This removes the need to work with additional local Dashboard users.

### Add an Entra ID user to the Dashboard
<details>
<summary><span id="add-an-entra-id-user">**Add an Entra ID user to the Dashboard**</span></summary>

Microsoft Entra ID users can sign in automatically into the Invictus Dashboard if that user is part of an Entra ID group that is [synced into the Dashboard](../installation/01_give_ad_access.mdx#sync-your-microsoft-entra-id-groups-to-invictus-).

:::warning[requires role]
Make sure that the group has a [role assigned](./03_roles.md), otherwise the Dashboard will be unusable for the user.
:::

![Entra ID user sign in](/images/dashboard/AdminAccount/adminAccount-4.jpg)
</details>

<details>
<summary>**Delete an Entra ID user from the Dashboard** <OnlyAdminsBadge/></summary>

### Delete an Entra ID user from the Dashboard <OnlyAdminsBadge/>
To delete a user click on the delete icon next to the user in the user list.

![delete azure user](/images/delete-azure-user.PNG)
> 👀 Linked Entra ID users can be distinguished as they do not have a personal role assigned. The role is determined by the group the user is a member of.

### Edit an Entra ID user's role in the Dashboard <OnlyAdminsBadge/>
</details>

<details>
<summary>**Edit an Entra ID user's role in the Dashboard** <OnlyAdminsBadge/></summary>

Entra ID users don't have personalized roles that allow them to access certain flows in the Dashboard. The user role is determined by the Entra ID group(s) where the user is a member of. [If the group(s) has access to the flow](../installation/01_give_ad_access.mdx#sync-your-microsoft-entra-id-groups-to-invictus-), so will the user.

### Configure forgot password procedure <OnlyAdminsBadge/>
</details>

<details>
<summary>**Configure forgot password procedure** <OnlyAdminsBadge/></summary>

Before you can use the forgot password feature, you need to create an Microsoft Entra ID application registration and [set it up with the Mail.Send API permissions](../installation/01_give_ad_access.mdx). This is required because emails can only be sent through an OAuth 2.0 flow.

:::warning
Expand All @@ -59,12 +72,16 @@ Please note that the permission granted allows any email address within the orga

![Global settings page as system admin](/images/dashboard/settings-page-as-admin.png)

</details>

</TabItem>
<TabItem value="local" label="Local">

Local users are entirely managed by the Invictus Dashboard. They can have their own personal permissions assigned and can be deleted at anytime.

### Add a local user to the Dashboard <OnlyAdminsBadge/>
<details>
<summary>**Add a local user to the Dashboard** <OnlyAdminsBadge/></summary>

Local users can have a [role assigned](./03_roles.md).

<nav class="custom-breadcrumb">
Expand All @@ -78,20 +95,29 @@ Local users can have a [role assigned](./03_roles.md).
</nav>

![add user details](/images/v2_users2.png)
</details>

<details>
<summary>**Delete a local user from the Dashboard** <OnlyAdminsBadge/></summary>

### Delete a local user from the Dashboard <OnlyAdminsBadge/>
Local users can be distinguished as they have a personal role assigned.

![delete local user](/images/delete-local-user.PNG)
</details>

<details>
<summary>**Edit a local user's role in the Dashboard** <OnlyAdminsBadge/></summary>

### Edit a local user's role in the Dashboard <OnlyAdminsBadge/>
Local users can have a [role assigned](./03_roles.md).

![edit local user](/images/edit-local-user.PNG)

![edit user role](/images/v2_users3.png)
</details>

<details>
<summary>**Configure forgot password procedure** <OnlyAdminsBadge/></summary>

### Configure forgot password procedure <OnlyAdminsBadge/>
For local users to allow them to run the 'Forgot password' procedure, the following details have to be configured to use to correct email server.

<nav class="custom-breadcrumb">
Expand All @@ -106,13 +132,15 @@ For local users to allow them to run the 'Forgot password' procedure, the follow

![forgotpassword](/images/dashboard/ForgotPassword/ForgotPassword_7.jpg)

| Forgot password setting | Description |
| ------------------------ | ----------- |
| Forgot password setting | Description |
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Host` | The host address of the email server from which the sender account originates. For instance, if it's a Gmail email account, the host should be "smtp.gmail.com". |
| `Port number` | The port number for the email server from which the sender accounts originates, default is `587`. |
| `Email key vault key` | The Azure Key Vault secret name where the sender email address is stored (points to the Key Vault resource accompanied with the Invictus installation). |
| `Password key vault key` | The Azure Key Vault secret name where the sender email password is stored (points to the Key Vault resource accompanied with the Invictus installation). |
| `SSL Enabled` | It's recommended to enable SSL, as major email providers often require this setting. |

| `Port number` | The port number for the email server from which the sender accounts originates, default is `587`. |
| `Email key vault key` | The Azure Key Vault secret name where the sender email address is stored (points to the Key Vault resource accompanied with the Invictus installation). |
| `Password key vault key` | The Azure Key Vault secret name where the sender email password is stored (points to the Key Vault resource accompanied with the Invictus installation). |
| `SSL Enabled` | It's recommended to enable SSL, as major email providers often require this setting. |

</details>

</TabItem>
</Tabs>
Loading