Skip to content

Commit 2400f5d

Browse files
authored
Merge pull request #228 from nginx/internal/user-account-docs
docs: Add User and Account Management Docs for NGINXaaS for Google
2 parents e433fbe + 7253569 commit 2400f5d

File tree

1 file changed

+50
-7
lines changed

1 file changed

+50
-7
lines changed

content/nginxaas-google/getting-started/manage-users-accounts.md

Lines changed: 50 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,66 @@ type:
1010

1111
## Overview
1212

13-
This document explains how to manage users and accounts in F5 NGINXaaS for Google Cloud (NGINXaaS).
13+
This document explains how to manage users and accounts in F5 NGINXaaS for Google Cloud using the NGINXaaS console.
1414

15-
The following concepts are important to understand:
15+
Before you start, ensure you understand the following concepts:
1616

17-
- NGINXaaS Accounts (point to the "sign up" docs which creates an account)
18-
- Users - must tie to a Google identity
17+
- **NGINXaaS Account**: Represents a Google Cloud procurement with an active Marketplace NGINXaaS subscription, linked to a billing account. To create an account, see the signup documentation in [prerequisites]({{< ref "/nginxaas-google/getting-started/prerequisites.md" >}}).
18+
- **User**: A user is anyone who has access to an NGINXaaS Account through their Google Identity. The same Google Identity can be added to multiple NGINXaaS Accounts, but it is treated as a different user in each account.
19+
- **Authorized Domains**: The list of Google Identity domains (for example, "example.com") allowed to access an NGINXaaS Account using Google authentication.
20+
- By default, an NGINXaaS Account has an empty authorized domains field, which means that anyone can log in to the account, if added as a user.
21+
- Configuring this field allows you to control which organizations (based on their email domains) are allowed to log in to the NGINXaaS Account. This restricts access to only users from trusted companies or groups, and prevents unauthorized domains from accessing resources in the account.
22+
- When updating authorized domains, you cannot make an update if it would prevent any existing user from logging in. This ensures that no current users are accidentally locked out of the account.
1923

24+
## Add or edit a user
2025

26+
An existing NGINXaaS Account user can additional users following these steps:
2127

22-
## Add or edit a user
28+
1. Access the [NGINXaaS Console](https://console.nginxaas.net/).
29+
1. Log in to the console with your Google credentials.
30+
1. Navigate to **Users** page on the left menu, then select **Add User**.
31+
1. Enter the **Name** and **Email** for the user to be added.
32+
1. Select **Create User** to save the changes.
33+
34+
The new user will appear in the list of users on the **Users** page. Their **Google Identity Domain** will remain empty until they log in for the first time.
35+
36+
### Edit a user
37+
38+
1. Select **Users** under the **Settings** section on the left menu.
39+
1. Select the ellipsis (three dots) menu for the user you want to update.
40+
1. Select **Edit**.
41+
1. Update the user details; currently only the username can be changed.
42+
1. Select **Update** to confirm the changes.
2343

2444
## Modify account settings
2545

26-
- Authorized domains, and how they work
46+
As an authenticated user, you may modify the authorized domains and name of an NGINXaaS Account.
47+
48+
49+
### Modify Authorized Domains
50+
51+
1. Select **Account Details** under the **Settings** section on the left menu.
52+
1. Select **Edit** in the **Authorized Domains** section.
53+
1. To add a new authorized domain, select **Add Domain** and enter the new domain.
54+
1. To remove an existing authorized domain, select the Recycle Bin button next to it.
55+
1. Select **Update** to save changes.
56+
57+
### Modify the name of an accoun
58+
59+
1. Select **Account Details** under the **Settings** section on the left menu.
60+
2. Select **Edit** in the **Account Info** section.
61+
3. Enter new name in **Account Name** field, then select **Update** to save changes.
2762

2863
## Switch accounts
2964

65+
To switch to a different NGINXaaS Account, select the profile symbol in the top right corner and choose **Switch Account**. This opens a page showing the list of all the NGINXaas Accounts that your Google Identity is linked to; select the account you want to switch to.
66+
3067
## Delete a user
3168

32-
- User will no longer be able to access the NGINXaaS account. Not reversible.
69+
An authenticated user can delete other users (other than their own user account). Deletion is irreversible; the deleted user will no longer be able to access the NGINXaaS Account.
70+
71+
To delete a user in an NGINXaaS Account:
72+
73+
1. Select **Account Details** under the **Settings** section on the left menu.
74+
1. Select the ellipsis (three dots) menu next to the user you want to delete.
75+
1. Select **Delete** in the menu. The deleted user will no longer appear in the **Users** page.

0 commit comments

Comments
 (0)