summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/docsite/rst/userguide/users.rst34
1 files changed, 14 insertions, 20 deletions
diff --git a/docs/docsite/rst/userguide/users.rst b/docs/docsite/rst/userguide/users.rst
index 44d016437c..1132cbfb00 100644
--- a/docs/docsite/rst/userguide/users.rst
+++ b/docs/docsite/rst/userguide/users.rst
@@ -1,11 +1,10 @@
- .. _ug_users:
+.. _ug_users:
Users
-----
.. index::
single: users
-
A :term:`User` is someone who has access to AWX with associated permissions and credentials. Access the Users page by clicking **Users** from the left navigation bar. The User list may be sorted and searched by **Username**, **First Name**, or **Last Name** and click the headers to toggle your sorting preference.
@@ -14,7 +13,6 @@ A :term:`User` is someone who has access to AWX with associated permissions and
You can easily view permissions and user type information by looking beside their user name in the User overview screen.
-
.. _ug_users_create:
Create a User
@@ -63,10 +61,12 @@ The same window opens whether you click on the user's name, or the Edit (|edit-b
If the user is not a newly-created user, the user's details screen displays the last login activity of that user.
.. image:: ../common/images/users-last-login-info.png
+ :alt: User details with last login information
When you log in as yourself, and view the details of your own user profile, you can manage tokens from your user profile. See :ref:`ug_users_tokens` for more detail.
.. image:: ../common/images/user-with-token-button.png
+ :alt: User details with Tokens tab highlighted
.. _ug_users_delete:
@@ -80,10 +80,10 @@ Before you can delete a user, you must have user permissions. When you delete a
2. Select the check box(es) for the user(s) that you want to remove and click **Delete**.
.. image:: ../common/images/users-home-users-checked-delete.png
+ :alt: Users list view with two users checked
3. Click **Delete** in the confirmation warning message to permanently delete the user.
-
Users - Organizations
~~~~~~~~~~~~~~~~~~~~~
@@ -93,9 +93,8 @@ Users - Organizations
This displays the list of organizations of which that user is a member. This list may be searched by Organization Name or Description.
Organization membership cannot be modified from this display panel.
-|Users - Organizations list for example user|
-
-.. |Users - Organizations list for example user| image:: ../common/images/users-organizations-list-for-example-user.png
+|Users - Organizations list for example user| image:: ../common/images/users-organizations-list-for-example-user.png
+ :alt: Users - Organizations list for example user
Users - Teams
~~~~~~~~~~~~~
@@ -107,10 +106,8 @@ This displays the list of teams of which that user is a member. This list may be
Until a Team has been created and the user has been assigned to that team, the assigned Teams Details for the User appears blank.
-|Users - teams list for example user|
-
-.. |Users - teams list for example user| image:: ../common/images/users-teams-list-for-example-user.png
-
+|Users - teams list for example user| image:: ../common/images/users-teams-list-for-example-user.png
+ :alt: Users - teams list for example user - empty
.. _ug_users_roles:
@@ -121,7 +118,6 @@ Users - Roles
pair: users; permissions
pair: users; roles
-
The set of permissions assigned to this user (role-based access controls) that provide the ability to read, modify, and administer projects, inventories, job templates, and other AWX elements are Roles.
.. note::
@@ -130,9 +126,8 @@ The set of permissions assigned to this user (role-based access controls) that p
This screen displays a list of the roles that are currently assigned to the selected User and can be sorted and searched by **Name**, **Type**, or **Role**.
-|Users - permissions list for example user|
-
-.. |Users - permissions list for example user| image:: ../common/images/users-permissions-list-for-example-user.png
+|Users - permissions list for example user| image:: ../common/images/users-permissions-list-for-example-user.png
+ :alt: Users - permissions list for example user
.. _ug_users_permissions:
@@ -144,31 +139,31 @@ To add permissions to a particular user:
1. Click the **Add** button, which opens the Add Permissions Wizard.
.. image:: ../common/images/users-add-permissions-form.png
- :alt: Add Permissions Form
+ :alt: Add User Permissions Form, first step, Add resource type
2. Click to select the object for which the user will have access and click **Next**.
3. Click to select the resource to assign team roles and click **Next**.
.. image:: ../common/images/users-permissions-IG-select.png
+ :alt: Add User Permissions Form, second step, Select items from list - instance group checked
4. Click the checkbox beside the role to assign that role to your chosen type of resource. Different resources have different options available.
.. image:: ../common/images/users-permissions-IG-roles.png
-
+ :alt: Add User Permissions Form, final step, Select roles to apply - "Use" role checked
5. Click **Save** when done, and the Add Permissions Wizard closes to display the updated profile for the user with the roles assigned for each selected resource.
.. image:: ../common/images/users-permissions-sample-roles.png
+ :alt: Users - Permissions Sample Roles
To remove Permissions for a particular resource, click the disassociate (x) button next to its resource. This launches a confirmation dialog, asking you to confirm the disassociation.
-
.. note::
You can also add teams, individual, or multiple users and assign them permissions at the object level (templates, credentials, inventories, projects, organizations, or instance groups) as well. This feature reduces the time for an organization to onboard many users at one time.
-
.. _ug_users_tokens:
Users - Tokens
@@ -179,4 +174,3 @@ The **Tokens** tab will only be present for your user (yourself). Before you add
1. If not already selected, click on your user from the Users list view to configure your OAuth 2 tokens.
.. include:: ../common/add-token.rst
-