Skip to content

Commit

Permalink
Revert "Revert "Default roles to Asgardeo"" (#4875)
Browse files Browse the repository at this point in the history
  • Loading branch information
piraveena authored Nov 21, 2024
1 parent fb649ce commit 4c7a2f5
Show file tree
Hide file tree
Showing 2 changed files with 245 additions and 156 deletions.
70 changes: 27 additions & 43 deletions en/asgardeo/docs/guides/users/manage-administrators.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,83 +3,68 @@
This guide walks you through the steps of managing an administrator account. If you are the owner or an existing administrator in the organization, you can onboard new administrators or delete existing administrator accounts.

!!! note
You cannot manage the user profiles of other administrators or update their passwords from the Asgardeo Console. Administrators must [manage their own profiles and passwords]({{base_path}}/guides/your-asgardeo/asgardeo-self-service/#change-password) using the **My Account** portal.
You cannot manage the user profiles of other administrators or update their passwords from the Asgardeo Console. Administrators must manage their own profiles and passwords using the [My Account portal]({{base_path}}/guides/your-asgardeo/asgardeo-self-service/).

## Onboard an administrator

There are two ways to onboard an administrator:

- An administrator can onboard new administrators by [sending an email invitation](#invite-an-external-administrator).
- An administrator can [assign existing users administrative privileges](#assign-admin-privileges-to-users).
- An administrator can [assign administrative privileges to existing users](#assign-admin-privileges-to-users).

### Invite an external administrator
Let's look at how administrators can onboard another administrator by sending an email invitation.

To onboard an administrator:
Existing administrators can onboard other administrators by sending them email invitations to join the organization. To do so,

1. On the Asgardeo Console, go to **Console Settings** > **Administrators**.

2. Click **Add Administrator** and provide the required details.
2. Click **Add Administrator** and provide the following details.

!!! note
Note that if your organization allows you to [assign admin privileges to business users](#assign-admin-privileges-to-users), you will see the following options when you click **Add Administrator**.

![Add administrator dropdown]({{base_path}}/assets/img/guides/users/add-administrator-dropdown.png){: width="600" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}

You need to select **Invite admins to Asgardeo** from this list to proceed with inviting an external admin.

![Add administrator user]({{base_path}}/assets/img/guides/users/add-administrator.png){: width="600" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
If you have enabled the option to [assign admin privileges to users](#assign-admin-privileges-to-users), you may proceed to invite external admins by clicking *Add Administrator* > *Invite Admins to Asgardeo*.

<table>
<tr>
<th>Field name</th>
<th>Description</th>
</tr>
<tr>
<th>Email Address</th>
<td>Provide the email address to which the invitation email should be sent. <br>This email address will be used as the admin's username in Asgardeo. Note that a username is always unique to the organization, and you can't change it once it is created.</td>
<th>Email Address</th>
<td>The invitation will be sent to this email address. Additionally, this email address will be used as the username of this administrator.
Usernames are always unique to an organization. Once created, they cannot be modified.
</td>
</tr>
<tr>
<th>Role</th>
<td>The <b>Administrator</b> role is assigned by default. <br>For details on the available user roles and the permissions assigned to them, see [Asgardeo User Roles]({{base_path}}/references/user-management/user-roles/).</td>
<th>Role</th>
<td>Users can be assigned one or more default roles. For details on the available user roles and the permissions assigned to them, see [Asgardeo User Roles]({{base_path}}/references/user-management/user-roles/).</td>
</tr>
</table>

3. Click **Invite** to send the invitation.


The administrator can access the Asgardeo Console by accepting the invitation and setting a password for the new administrator account.
The external administrator can join the organization by accepting the invitation and setting a password for the new administrator account.

### Assign admin privileges to users

You can assign admin privileges to existing business users only if it is allowed in your organization. Follow the instructions given below.
This option has to be enabled for the organization. If enabled, administrators can assign the administrator role to existing non-privileged users.

First, configure administrator settings for the organization:
To enable this option,

1. On the Asgardeo Console, go to **Console Settings** > **Administrators**.

2. Click the settings icon next to **+ Add Administrator** to open the **Administrator Settings** page.

3. Switch on the **Enable users to manage the organization** toggle.
2. Click the settings icon next to **Add Administrator** to open the **Administrator Settings** page.

![Assign an existing user as an admin]({{base_path}}/assets/img/guides/users/enable-users-to-manage-organizations.png){: width="600" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
3. Turn on the **Enable users to manage the organization** toggle.

4. Go back to the **Administrators** tab and see that the **+ Add Administrator** list is updated as follows:
4. Go back to the **Administrators** tab and click **Add Administrator** to see a list with two options as follows:

![Add administrator dropdown]({{base_path}}/assets/img/guides/users/add-administrator-dropdown.png){: width="600" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
![Add administrator dropdown]({{base_path}}/assets/img/guides/users/add-administrator-dropdown.png){: width="700" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}

Now, let's assign admin privileges to a user:
To assign users the administrator role,

1. On the **Console Settings** > **Administrator** page, click **+Add Administrator > Assign admins from users**.
2. Select the user you want to add as an administrator and click **Add**.
1. On the **Console Settings** > **Administrators** page, click **+Add Administrator > Add Existing User**.
2. Select the user's username and the **Administrator** role and click **Add**.

The new administrator can now access the Asgardeo Console using the following URL:

!!! note
Be sure to replace `{org_name}` with the relevant organization name.

```
https://console.asgardeo.io/t/{org_name}
https://console.asgardeo.io/t/{organization_name}
```

!!! note
Expand All @@ -88,26 +73,25 @@ https://console.asgardeo.io/t/{org_name}
## View administrators
To view the administrators of your organization:

On the Asgardeo Console, go to **Administrators**. You will see the list of administrators presented in two tabs as follow.
On the Asgardeo Console, go to **Console Settings > Administrators**. You will see the list of administrators presented in two tabs as follow.

<table>
<tr>
<th>Asgardeo</th>
<td>This includes administrators whose identity is managed by Asgardeo.</td>
</tr>
<tr>
<th>{org_name} organization</th>
<th><i>{organization_name}</i> organization</th>
<td>This includes administrators whose identity is managed by the <code>{org_name}</code> organization.</td>
</tr>
</table>

## Delete an administrator

!!! warning Before you begin
Note the following:
!!! warning "Before you begin"

- If the administrator you delete is a business user with admin privileges, you will only be revoking the administrator privileges from the user. Deleting this administrator does not delete the user account.
- If the administrator is not a business user, you will be deleting the user account from the organization. This action is irreversible.
- If you delete an exiting user who was assigned to the administrator role, you will only be revoking the administrator privileges from that user. Deleting this administrator does not delete the user account.
- If you delete other administrators, you will be deleting the user account from the organization. This action is irreversible.

To delete an administrator:

Expand Down
Loading

0 comments on commit 4c7a2f5

Please sign in to comment.