Skip to content

updated account pages, added roles and images #134

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.

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
merged 7 commits into from
Jun 25, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file added docs/Admin-and-data/Account/Cloud/Security.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Admin-and-data/Account/Cloud/add-email.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Admin-and-data/Account/Cloud/general.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Admin-and-data/Account/Cloud/members.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Admin-and-data/Account/Cloud/passkey.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 36 additions & 0 deletions docs/Admin-and-data/Account/Cloud/profile.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Profile

This section lets you manage your personal profile settings, including your profile details, email addresses, and connected accounts.


## Accessing profile settings

![!Screenshot](../../Account/Cloud/access-profile.png)

!!! tip
You can also quickly access your profile by clicking your name and avatar at the bottom left corner of the screen on the Account page.

## Profile details

In **Profile details**, you’ll see your profile photo (or initials if no image is uploaded) along with your display name. You’ll also find a list of the email addresses linked to your account.


### Updating your Profile Settings

You can update your profile settings by clicking **Update profile** in the Profile section. This brings up a panel where you can change your profile photo, first name, and last name. To update your image, click the **Upload** button—make sure your file is a square (1:1 aspect ratio) and no larger than 10MB.

Below the image, you’ll find fields for your first and last name. Make any changes as needed, then click **Save** to apply them. If you change your mind, you can click **Cancel** to exit without saving.


![!Screenshot](../../Account/Cloud/update.png)

### Updating your email address

To add another email address to your account, click the **+ Add email address** button. A field will appear where you can type in the new email you'd like to associate with your profile.

After entering the address, click **Add**. You’ll be asked to verify the new email before it’s officially added to your account. This ensures that the email belongs to you and can be used for login, notifications, or as a backup. If you change your mind, just click **Cancel** to exit without adding it.

![!Screenshot](../../Account/Cloud/add-email.png)



25 changes: 25 additions & 0 deletions docs/Admin-and-data/Account/Cloud/roles.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@

FusionReactor Cloud supports multiple member roles, each with different levels of access and responsibilities within the organization. Use this to scale or restrict access as your team evolves.

!!! note
You must be an Admin to modify other users' roles.

![!Screenshot](../../Account/Cloud/roles.png)

| **Role** | **Description** |
|-------------|-----------------|
| **Admin** | Full access, including organization settings and member management. The **Admin** role can: <ul><li>Delete users from the account</li><li>Configure alerting services</li><li>Access account billing</li><li>Disable log ingest & OpsPilot for their organization</li></ul> |
| **Manager** | The **Manager** level allows for account management, having access to all of the features of the standard User type but with the added ability to: <ul><li>Manage configured applications</li><li>Manage configured servers</li><li>Disable log ingest & OpsPilot for their organization</li></ul> |
| **User** | A **User** is the typical user level. They have access to all the features of the software with both read and write permission. |
| **Observer**| The **Observer** account type is primarily a read-only user. This user type has access to all of the main functionality albeit with a read-only status. An observer has read and write access to their own data such as user information and quick links. |
| **Business**| A **Business Contact** member is only able to view the on-premise billing and license keys for the Organization. |



### Removing members
To remove a user:

1. Click the ⋯ (Actions menu) next to their name.
2. Select **Remove member**.
3. Confirm the removal.

Binary file added docs/Admin-and-data/Account/Cloud/roles.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
45 changes: 45 additions & 0 deletions docs/Admin-and-data/Account/Cloud/security.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Security

This dedicated Security page serves as your central hub for managing and enhancing the protection of your account. Here, you can actively control various aspects of your digital safety, including setting and updating your password, configuring secure passkeys for streamlined and robust authentication, and enabling two-step verification for an added layer of defense against unauthorized access. Additionally, you'll find a clear overview of your active devices, allowing you to monitor where your account is currently logged in. This comprehensive section empowers you to maintain strong control over your account's integrity and privacy.

![!Screenshot](../../Account/Cloud/Security.png)

## Password

This section allows you to change your account password.

### Changing your Password

To set a new password, you will find two fields: **New password** and **Confirm password**. Enter your desired new password into the "New password" field, and then re-enter the exact same password into the "Confirm password" field to ensure accuracy.

Below these fields, you'll see an option to **Sign out of all other devices**. It is highly recommended to check this box. Doing so will automatically sign out any other devices that may still be logged in with your old password, enhancing your account's security.

Once you have entered and confirmed your new password and made your selection for signing out of other devices, click **Save** to apply the changes. If you decide not to change your password or wish to discard your entries, simply click **Cancel** to return to the previous page without saving.

## Passkeys

Passkeys provide a more convenient and secure way to sign in.


### Adding a Passkey

When you click **+ Add a passkey** from the Security page, a "Windows Security" pop-up window will appear, prompting you to "Choose where to save this passkey." This step allows you to select the method you prefer for storing your new passkey.

![!Screenshot](../../Account/Cloud/passkey.png)
You have the following options:

* **iPhone, iPad, or Android device:** Select this option if you wish to save your passkey to a mobile device. This typically involves using your phone's built-in security features (like Face ID, Touch ID, or screen lock) to authenticate and store the passkey securely. You might be prompted to scan a QR code or approve a notification on your mobile device.
* **Security key:** Choose this option if you have a physical security key (like a YubiKey or similar FIDO-compliant device) and want to use it to store your passkey. This method offers strong, hardware-based security.

Once you have selected your preferred method:

* Click **Next** to proceed with the passkey creation process based on your chosen storage option. You will then follow further instructions to complete the setup.
* Click **Cancel** to close the window and abort the passkey addition process without saving any new passkey.

## Two-step verification

When you opt to add two-step verification, you'll be presented with the **+ two-step verification** prompt. This method enhances your account's security by requiring a second form of verification in addition to your password. To set this up, you'll need an authenticator app on your smartphone (such as Google Authenticator, Microsoft Authenticator, or Authy).

The page displays a unique QR code that you must scan using your chosen authenticator application. Scanning this QR code will securely link the app to your account, generating time-sensitive codes that you'll use for future logins. If you are unable to scan the QR code, click the **Can't scan QR code?** link for alternative setup instructions, typically involving a manual key entry.

Once the QR code is scanned and the app is linked, click **Continue** to finalize the setup, or **Cancel** to abort the process.
Binary file added docs/Admin-and-data/Account/Cloud/update.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
115 changes: 61 additions & 54 deletions docs/Admin-and-data/Account/Cloud/users.md
Original file line number Diff line number Diff line change
@@ -1,100 +1,107 @@
# Account & user management
# Account & member management

## User types
## Organizational settings

🔎**Find it**: **FusionReactor** > **Account** > **Users**
### General

FusionReactor Cloud has five types of user:
This section covers the basic organization-level settings accessible under the **General** tab in FusionReactor Cloud.

* [Account Admin](/Admin-and-data/Account/Cloud/users/#account-admin)
* [Account Manager](/Admin-and-data/Account/Cloud/users/#account-manager)
* [Account User](/Admin-and-data/Account/Cloud/users/#account-user)
* [Account Observer](/Admin-and-data/Account/Cloud/users/#account-observer)
* [Business Contact](/Admin-and-data/Account/Cloud/users/#business-contact)
![!Screenshot](../../Account/Cloud/general.png)

The account types have a hierarchical structure and each level above **Observer** inherits from the level below.

### Account Admin
#### Organization Profile

The **Admin** account type is the most powerful user type and has access to all of the features of the cloud including the ability to close the account and control the billing settings. As well as all of the features of **Manager**, the **Admin** level also allows users to:
The Organization Profile section lets you view and update your organization's name and logo, which are shown to all members across the interface.

* Delete users from the account
* Configure alerting services
* Access account billing
#### Leave organization

Typically, this user is seen as the account owner and billing contact and would be responsible for managing their FusionReactor Cloud account.
The **Leave organization** option lets any member (except the last admin) remove themselves from the org, which immediately revokes access to all org data and requires a new admin invitation to rejoin.

### Account Manager
!!! note
If you're the last admin in the organization, you **cannot leave** — you must either promote another member to admin or delete the organization instead.

The **Manager** level allows for account management, having access to all of the features of the standard User type but with the added ability to:

* Add or update users on the account
* Manage configured applications
* Manage configured servers

### Account User
#### Delete organization

A **User** is the typical user level. They have access to all the features of the software with both read and write permission.
Only admins can delete the organization, which permanently removes all members, data, and settings — this action cannot be undone.

### Account Observer

The **Observer** account type is primarily a read only user. This user type has access to all of the main functionality albeit with a read only status. An observer has read and write access to their own data such as user information and quick links.
### Members

### Business Contact
The **Members** tab in FusionReactor Cloud allows you to manage all users associated with your organization. You can view member details, assign roles, invite new members, and control access.

A **Business Contact** account type is able to view the license keys for the account.
![!Screenshot](../../Account/Cloud/members.png)

## Manage existing users
#### Viewing members

Administrators can create, edit, and remove users.
Each row in the Members list includes:

### Add new user
* **Name & Email** – Display name and primary email address.
* **Joined** – Date the user was added to the organization.
* **Role** – The current permission level assigned to the member.
* **Actions** – (⋯) menu to remove a member.

🔎**Find it**: **FusionReactor** > **Account** > **Users** > **Add user**
You can also:

* Use the search bar to filter members by name or email.
* Navigate through multiple pages if your org has many users.

1) To add a user, select **Add user**.

![!Screenshot](../../Images/adduser.png)
#### Inviting members

2) The following screen is displayed:
Click the **Invite** button in the top-right to add new users:

![!Screenshot](../../Images/user.png)
1. Enter the email address of the invitee.
2. Assign a default role.

3) Complete the input boxes for **Email**, **First name** and **Last name**.
!!! info
Users are notified by email when invited to an organization.

4) Use the **Role** dropdown to select the account type.

5) When all details are completed, select **Add user** at the bottom of the screen.
#### Role management
Use the dropdown under Role to instantly change a member’s permission level.

### Edit existing users
!!! info "Learn more"
[Roles](/Admin-and-data/Account/Cloud/roles/)

1) To edit existing users, click on the three vertical dots to the right of the user name.

### API Keys

![!Screenshot](../../Images/edituser1.png)
The **API Keys** page allows you to manage access credentials used by services or agents to communicate with FusionReactor Cloud.

2) Select the **Edit** icon.
#### Viewing & managing keys

3) The **Update details** screen is displayed.
Each listed API key displays:

4) Make any changes and select **Save** at the bottom of the screen.
- **Name** – A user-defined label.
- **Description** – A short explanation of the key’s purpose.
- **Status toggle** – Temporarily enable or disable a key.
- **Copy icon** – Instantly copies the key to your clipboard (if visible).
- **Actions menu (⋯)** – Click to:
- **Edit** – Change the key’s name or description.
- **Remove** – Permanently delete the key.

!!! note
Deleting a key immediately revokes access for anything using it.

### Remove user

1) To delete a user, click on the three vertical dots to the right of the user name.

![!Screenshot](../../Images/edituser1.png)
#### Creating a new key

2) Select the **Delete** icon.
Click **+ Generate** to create a key. You’ll enter:

- **Name** (required)
- **Description** (optional)

### Billing

The Billing section provides access to your organization's subscription details, invoices, and payment methods.

!!! info "Learn more"
[Billing](/Admin-and-data/Billing/Cloud/overview/)

3) The following warning is displayed:

![!Screenshot](../../Images/deletewarning.png)

3) Select **Ok** to delete user.

___

!!! question "Need more help?"
Contact support in the chat bubble and let us know how we can assist.
10 changes: 8 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -425,8 +425,14 @@ nav:
- Data-insights/Extras/Plugins/FusionReactor-System-Monitor-Plugin.md
- Data-insights/Extras/Plugins/FusionReactor-Transaction-Logger-Plugin.md
- ADMIN & DATA:
- Account & user management:
- Cloud: Admin-and-data/Account/Cloud/users.md
- Account & member management:
- Cloud:
- Account:
- Organization: Admin-and-data/Account/Cloud/users.md
- Roles: Admin-and-data/Account/Cloud/roles.md
- Profile Settings:
- Profile: Admin-and-data/Account/Cloud/profile.md
- Security: Admin-and-data/Account/Cloud/security.md
- On-Premise: Admin-and-data/Account/On-Premise/OPusers.md
- Billing:
- Cloud: Admin-and-data/Billing/Cloud/overview.md
Expand Down