Skip to content

Update permission documentation for assigning orgs and locs #4456

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.

Sign up for GitHub

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

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
+28 −9
Open

Update permission documentation for assigning orgs and locs #4456

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
142305e
Update organization and location permissions
aneta-petrova Nov 4, 2025
78263d9
Drop addition in a planning module that is not needed
aneta-petrova Nov 4, 2025
2080c20
Turn IMPORTANT into prerequisites
aneta-petrova Nov 4, 2025
9b15ae6
Apply one sentence per line
aneta-petrova Nov 4, 2025
40ffefc
Shorten perm descriptions
aneta-petrova Nov 4, 2025
b00208a
Explain org/loc assignment for user accounts
aneta-petrova Nov 4, 2025
a452f33
Move general information to procedure intro
aneta-petrova Nov 4, 2025
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
4 changes: 4 additions & 0 deletions guides/common/modules/proc_assigning-a-host-to-a-specific-location.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
[role="_abstract"]
Use this procedure to assign a host to a specific location.

.Prerequisites
* Your user account has the `assign_locations` permission.
* You belong to the location that you want to assign to the host.

.Procedure
. In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts*.
. Select the checkbox of the host you want to change.
Expand Down
4 changes: 4 additions & 0 deletions guides/common/modules/proc_assigning-a-host-to-a-specific-organization.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ To unregister the host, run `subscription-manager unregister` on the host.
After you assign the host to a new organization, you can re-register the host.
====

.Prerequisites
* Your user account has the `assign_organizations` permission.
* You belong to the organization that you want to assign to the host.

.Procedure
. In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts*.
. Select the checkbox of the host you want to change.
Expand Down
15 changes: 8 additions & 7 deletions guides/common/modules/proc_creating-a-user.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ Use this procedure to create a user.
ifndef::rest-api[]
To use the CLI instead of the {ProjectWebUI}, see the xref:cli-creating-a-user_{context}[].

Users are strictly confined to their assigned organizations and locations.
Users can only access and assign resources within the organizations and locations they belong to.

.Procedure
. In the {ProjectWebUI}, navigate to *Administer* > *Users*.
. Click *Create User*.
Expand All @@ -19,13 +22,10 @@ The user account details that you can specify include the following:
** *INTERNAL*: to manage the user inside {ProjectServer}.
** *EXTERNAL*: to manage the user with external authentication.
For more information, see {ConfiguringUserAuthenticationDocURL}[_{ConfiguringUserAuthenticationDocTitle}_].
* On the *Organizations* tab, select an organization for the user.
* On the *Organizations* tab, select organizations for the user.
Specify the default organization {Project} selects for the user after login from the *Default on login* list.
+
[IMPORTANT]
====
If a user is not assigned to an organization, their access is limited.
====
* On the *Locations* tab, select locations for the user.
Specify the default location {Project} selects for the user after login from the *Default on login* list.

[id="cli-creating-a-user_{context}"]
.CLI procedure
Expand All @@ -38,12 +38,13 @@ $ hammer user create \
--login _My_User_Name_ \
--mail _My_User_Mail_ \
--organization-ids _My_Organization_ID_1_,_My_Organization_ID_2_ \
--location-ids _My_Location_ID_1_,_My_Location_ID_2_ \
--password _My_User_Password_
----
+
The `--auth-source-id 1` setting means that the user is authenticated internally, you can specify an external authentication source as an alternative.
Add the `--admin` option to grant administrator privileges to the user.
Specifying organization IDs is not required.
Specifying organization IDs and location IDs is not required.
Comment on lines -46 to +47
Copy link
Contributor

@adamruzicka adamruzicka Nov 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While this is technically correct, having a user which is not assigned to any organization or location is sort of pointless as the user won't be able to do anything useful.

+
You can modify the user details later by using the `hammer user update` command.

Expand Down
4 changes: 4 additions & 0 deletions guides/common/modules/proc_enabling-capsule-in-UI.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,13 @@
====
endif::[]

.Prerequisites
* Your user account has the `assign_organizations` and `assign_locations` permissions.
* You belong to the organization and location that you want to assign to the {SmartProxy}.

.Procedure

. Log into the {ProjectWebUI}.

Check failure on line 22 in guides/common/modules/proc_enabling-capsule-in-UI.adoc

View workflow job for this annotation

GitHub Actions / linter 

[vale] reported by reviewdog 🐶
[RedHat.TermsErrors] Use 'log in to' rather than 'Log into'.

Raw Output:
{"message": "[RedHat.TermsErrors] Use 'log in to' rather than 'Log into'.", "location": {"path": "guides/common/modules/proc_enabling-capsule-in-UI.adoc", "range": {"start": {"line": 22, "column": 3}}}, "severity": "ERROR"}
. From the *Organization* list in the upper-left of the screen, select *Any Organization*.
. From the *Location* list in the upper-left of the screen, select *Any Location*.
. In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts* and select {SmartProxyServer}.
Expand Down
10 changes: 8 additions & 2 deletions guides/common/modules/ref_permissions-required-to-provision-hosts.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,12 @@ ifdef::katello,orcharhino,satellite[]
|
endif::[]

|Location
.2+|Location
|view_locations
|
|assign_locations
|Required to assign locations to hosts or other resources.
You can only assign locations that you belong to.

|Medium
|view_media
Expand All @@ -79,9 +82,12 @@ endif::[]
|view_operatingsystems
|

|Organization
.2+|Organization
|view_organizations
|
|assign_organizations
|Required to assign organizations to hosts or other resources.
You can only assign organizations that you belong to.

|Parameter
|view_params, create_params, edit_params, destroy_params
Expand Down
Loading