Skip to content

Commit

Permalink
Access management updates (#260)
Browse files Browse the repository at this point in the history
* Update access management docs.

* Fix broken links

---------

Co-authored-by: Heather Blake <hblake@smatechnologies.com>
  • Loading branch information
hblake316 and Heather Blake authored Dec 18, 2023
1 parent 21c6c38 commit 30ef40e
Show file tree
Hide file tree
Showing 33 changed files with 305 additions and 111 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,18 @@ viewport: width=device-width, initial-scale=1.0

# Access Management

The **Access Management** page is found in _Library > Access Management_, and provides the views to manage User Accounts, Privileges, and Roles.
The **Access Management** page is found in _Library > Access Management_, and provides the views to manage user accounts, privileges, and roles.

::: note
:::note
The **Access Management** page is only available to users with the **System Administrator** role or **All Function Privileges** or **All Administrative Privileges** function privileges.
:::

Select the **Roles** tab to see a list of all the roles that have been created in the system. Select a role to view or modify the details of that role. See [Managing Roles and Privileges](Roles/Managing-Roles-And-Privileges.md) for more information.

Select the **Users** tab to see a list of all the users that have been created in the system. Select a user to view or modify the details of that user. See [Managing Users](Users/Managing-Users.md) for more information.

---

For conceptual help, see:

- [Privileges](../../../../../administration/privileges.md)
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
lang: en-us
title: Adding Roles
viewport: width=device-width, initial-scale=1.0
---

# Adding Roles

## Required Privileges

In order to add a role, you must have at least one of the following privileges:

- System Admistrator
- All Function Privileges
- All Adminstrative Functions

---

## Adding a Role

The **Access Management** page is found in _Library > Access Management_, and provides the views to manage user accounts, privileges, and roles.

To add a new role:

1. Select the context menu button ![Context Menu Button](../../../../../../Resources/Images/SM/Library/AccessManagement/context-menu.png 'Context Menu Button').
2. Select **Create a new role**.
3. Enter the role information in the **Role Details** dialog.
4. Select **Save** to add the role or **Cancel** to dismiss the dialog.

![Role Details](../../../../../../Resources/Images/SM/Library/AccessManagement/role-details-dialog.png 'Role Details')
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
lang: en-us
title: Copying Roles
viewport: width=device-width, initial-scale=1.0
---

# Copying Roles

## Required Privileges

In order to copy a role, you must have at least one of the following privileges:

- System Admistrator
- All Function Privileges
- All Adminstrative Functions

---

## Copying a Role

The **Access Management** page is found in _Library > Access Management_, and provides the views to manage user accounts, privileges, and roles.

Select the **Roles** tab to see a list of all the roles that have been created in the system.

:::note
The Role_ocadm role cannot be copied.
:::

To copy a role:

1. Select the role to copy from the roles list.
2. Select the context menu button ![Context Menu Button](../../../../../../Resources/Images/SM/Library/AccessManagement/context-menu.png 'Context Menu Button').
3. Select **Copy the selected role**.
4. Enter the name of the target role in the **Copy Role** dialog.
5. Select **Save** to add the role or **Cancel** to dismiss the dialog.

![Copy Role](../../../../../../Resources/Images/SM/Library/AccessManagement/copy-role.png 'Copy Role')
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
lang: en-us
title: Deleting Roles
viewport: width=device-width, initial-scale=1.0
---

# Deleting Roles

## Required Privileges

In order to copy a role, you must have at least one of the following privileges:

- System Admistrator
- All Function Privileges
- All Adminstrative Functions

---

## Deleting a Role

The **Access Management** page is found in _Library > Access Management_, and provides the views to manage user accounts, privileges, and roles.

Select the **Roles** tab to see a list of all the roles that have been created in the system.

:::note
The Role_ocadm role cannot be deleted.
:::

To delete a role:

1. Select the role to delete from the roles list.
2. Select the context menu button ![Context Menu Button](../../../../../../Resources/Images/SM/Library/AccessManagement/context-menu.png 'Context Menu Button').
3. Select **Delete the selected role**.
4. A confirmation dialog is displayed. Select **Yes** to delete the role or **No** to dismiss the dialog without deleting the role.
Original file line number Diff line number Diff line change
@@ -1,31 +1,33 @@
---
lang: en-us
title: Managing Roles
title: Managing Roles and Privileges
viewport: width=device-width, initial-scale=1.0
---

# Managing Roles and Privileges

The Roles page is found in _Library > Access Management > Roles_, and provides the views to manage Roles and Privileges. A list of all Roles that have been created in the system and a series of tabs is displayed on the Roles page. Select the name of a Role to view the details of that Role.
The **Roles** page is found in _Library > Access Management > Roles_, and provides the views to manage roles and privileges. A list of all roles that have been created in the system and a series of tabs is displayed on the roles page. Select the name of a role to view the details of that role.

![Roles](../../../../../../Resources/Images/SM/Library/AccessManagement/roles-page.png 'Roles')

A series of tabs is displayed on the Roles page:
To sort the roles, select the sort icon ![Sort Icon](../../../../../../Resources/Images/SM/Library/AccessManagement/sort-icon.png 'Sort Icon').

- [General](Role-General.md)
- [Activities](Role-Activities.md)
- [Batch Users](Role-Batch-Users.md)
- [Department Activities](Role-Department-Activities.md)
- [Resources](Role-Resources.md)
- [Users](Role-Users.md)
Selecting a role displays a series of tabs that allow you to view and modify the details of the selected role. The tabs are:

To delete a Role, click the context menu button and select **Delete the selected role**. A confirmation dialog is displayed. Click **Yes** to delete the Role.
- [General](Modifying-Roles-And-Privileges/General.md)
- [Activities](Modifying-Roles-And-Privileges/Activities.md)
- [Batch Users](Modifying-Roles-And-Privileges/Batch-Users.md)
- [Department Activities](Modifying-Roles-And-Privileges/Department-Activities.md)
- [Resources](Modifying-Roles-And-Privileges/Resources.md)
- [Users](Modifying-Roles-And-Privileges/Users.md)

![Delete Role](../../../../../../Resources/Images/SM/Library/AccessManagement/delete-role.png 'Delete Role')
To add, copy, or delete a role, use the context menu button ![Context Menu Button](../../../../../../Resources/Images/SM/Library/AccessManagement/context-menu.png 'Context Menu Button'). See the following sections for more information:

::: note
You cannot delete a Role_ocadm.
:::
- [Adding Roles](Adding-Roles.md)
- [Deleting Roles](Deleting-Roles.md)
- [Copying Roles](Copying-Roles.md)

---

For conceptual help, see:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,16 @@ A series of tabs is displayed on the Roles page. The Activities tab displays the

To modify the activities granted to a role, edit the preferred fields and click **Save**.

![Roles Activities](../../../../../../Resources/Images/SM/Library/AccessManagement/roles-activities-tab.png 'Roles Activities')
![Roles Activities](../../../../../../../Resources/Images/SM/Library/AccessManagement/roles-activities-tab.png 'Roles Activities')

---

For more information see:

- [Managing Roles](Managing-Roles-And-Privileges.md)
- [Managing Roles](../Managing-Roles-And-Privileges.md)

For conceptual help, see:

- [Privileges](../../../../../../administration/privileges.md)
- [Roles](../../../../../../administration/roles.md)
- [Users](../../../../../../administration/user-accounts.md)
- [Privileges](../../../../../../../administration/privileges.md)
- [Roles](../../../../../../../administration/roles.md)
- [Users](../../../../../../../administration/user-accounts.md)
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,16 @@ A series of tabs is displayed on the Roles page. The Batch Users tab displays th

To modify the batch users assigned to a role, edit the preferred fields and click **Save**.

![Role Batch Users](../../../../../../Resources/Images/SM/Library/AccessManagement/roles-batchusers-tab.png 'Role Batch Users')
![Role Batch Users](../../../../../../../Resources/Images/SM/Library/AccessManagement/roles-batchusers-tab.png 'Role Batch Users')

---

For more information see:

- [Managing Roles](Managing-Roles-And-Privileges.md)
- [Managing Roles](../Managing-Roles-And-Privileges.md)

For conceptual help, see:

- [Privileges](../../../../../../administration/privileges.md)
- [Roles](../../../../../../administration/roles.md)
- [Users](../../../../../../administration/user-accounts.md)
- [Privileges](../../../../../../../administration/privileges.md)
- [Roles](../../../../../../../administration/roles.md)
- [Users](../../../../../../../administration/user-accounts.md)
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,16 @@ A series of tabs is displayed on the Roles page. The Departments tab displays th

To modify the department activities assigned to a role, edit the preferred fields and click **Save**.

![Role Department Activities](../../../../../../Resources/Images/SM/Library/AccessManagement/roles-departments-tab.png 'Role Department Activities')
![Role Department Activities](../../../../../../../Resources/Images/SM/Library/AccessManagement/roles-departments-tab.png 'Role Department Activities')

---

For more information see:

- [Managing Roles](Managing-Roles-And-Privileges.md)
- [Managing Roles](../Managing-Roles-And-Privileges.md)

For conceptual help, see:

- [Privileges](../../../../../../administration/privileges.md)
- [Roles](../../../../../../administration/roles.md)
- [Users](../../../../../../administration/user-accounts.md)
- [Privileges](../../../../../../../administration/privileges.md)
- [Roles](../../../../../../../administration/roles.md)
- [Users](../../../../../../../administration/user-accounts.md)
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,19 @@ A series of tabs is displayed on the Roles page. The General tab displays the na
To modify a role, edit the preferred fields and click **Save**.

:::note
If a Role has the **Inherit all** privileges for Machines, Machine Groups, Schedules, or Scripts selected on the **General** tab, the **Resources** tab will display information noting as such and does not allow granting or revoking privileges for specific resources. For information on this checkbox, refer to [Roles](../../../../../../administration/roles.md) in the **Concepts** online help.
If a Role has the **Inherit all** privileges for Machines, Machine Groups, Schedules, or Scripts selected on the **General** tab, the **Resources** tab will display information noting as such and does not allow granting or revoking privileges for specific resources. For information on this checkbox, refer to [Roles](../../../../../../../administration/roles.md) in the **Concepts** online help.
:::

![Role General](../../../../../../Resources/Images/SM/Library/AccessManagement/roles-general-tab.png 'Role General')
![Role General](../../../../../../../Resources/Images/SM/Library/AccessManagement/roles-general-tab.png 'Role General')

---

For more information see:

- [Managing Roles](Managing-Roles-And-Privileges.md)
- [Managing Roles](../Managing-Roles-And-Privileges.md)

For conceptual help, see:

- [Privileges](../../../../../../administration/privileges.md)
- [Roles](../../../../../../administration/roles.md)
- [Users](../../../../../../administration/user-accounts.md)
- [Privileges](../../../../../../../administration/privileges.md)
- [Roles](../../../../../../../administration/roles.md)
- [Users](../../../../../../../administration/user-accounts.md)
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,19 @@ A series of tabs is displayed on the Roles page. The Resources tab displays the
To modify the resources granted to a role, edit the preferred fields and click **Save**.

:::note
If a Role has the **Inherit all** privileges for Machines, Machine Groups, Schedules, or Scripts selected on the **General** tab, the **Resources** tab will display information noting as such and does not allow granting or revoking privileges for specific resources. For information on this checkbox, refer to [Roles](../../../../../../administration/roles.md) in the **Concepts** online help.
If a Role has the **Inherit all** privileges for Machines, Machine Groups, Schedules, or Scripts selected on the **General** tab, the **Resources** tab will display information noting as such and does not allow granting or revoking privileges for specific resources. For information on this checkbox, refer to [Roles](../../../../../../../administration/roles.md) in the **Concepts** online help.
:::

![Role Resources](../../../../../../Resources/Images/SM/Library/AccessManagement/roles-resources-tab.png 'Role Resources')
![Role Resources](../../../../../../../Resources/Images/SM/Library/AccessManagement/roles-resources-tab.png 'Role Resources')

---

For more information see:

- [Managing Roles](Managing-Roles-And-Privileges.md)
- [Managing Roles](../Managing-Roles-And-Privileges.md)

For conceptual help, see:

- [Privileges](../../../../../../administration/privileges.md)
- [Roles](../../../../../../administration/roles.md)
- [Users](../../../../../../administration/user-accounts.md)
- [Privileges](../../../../../../../administration/privileges.md)
- [Roles](../../../../../../../administration/roles.md)
- [Users](../../../../../../../administration/user-accounts.md)
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,16 @@ A series of tabs is displayed on the Roles page. The Users tab indicates the use

To modify the users granted to a role, edit the preferred fields and click **Save**.

![Role Users](../../../../../../Resources/Images/SM/Library/AccessManagement/roles-users-tab.png 'Role Users')
![Role Users](../../../../../../../Resources/Images/SM/Library/AccessManagement/roles-users-tab.png 'Role Users')

---

For more information see:

- [Managing Roles](Managing-Roles-And-Privileges.md)
- [Managing Roles](../Managing-Roles-And-Privileges.md)

For conceptual help, see:

- [Privileges](../../../../../../administration/privileges.md)
- [Roles](../../../../../../administration/roles.md)
- [Users](../../../../../../administration/user-accounts.md)
- [Privileges](../../../../../../../administration/privileges.md)
- [Roles](../../../../../../../administration/roles.md)
- [Users](../../../../../../../administration/user-accounts.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
lang: en-us
title: Adding Users
viewport: width=device-width, initial-scale=1.0
---

# Adding Users

## Required Privileges

In order to add a Users, you must have at least one of the following privileges:

- System Admistrator
- All Function Privileges
- All Adminstrative Functions

---

## Adding a User

The **Access Management** page is found in _Library > Access Management_, and provides the views to manage user accounts, privileges, and roles.

To add a new user:

1. Select the context menu button ![Context Menu Button](../../../../../../Resources/Images/SM/Library/AccessManagement/context-menu.png 'Context Menu Button').
2. Select **Create a new user**.
3. Enter the role information in the **User Details** dialog.
4. Select **Save** to add the role or **Cancel** to dismiss the dialog.

![User Details](../../../../../../Resources/Images/SM/Library/AccessManagement/user-details.png 'User Details')
Loading

0 comments on commit 30ef40e

Please sign in to comment.