Skip to content

Commit 6eda97b

Browse files
authored
Adding remove_auditors to 2.4 controller user guide (#2845)
* Adding remove_auditors to 2.4 controller user guide AAP 2.4 missing remove_auditors documentation https://issues.redhat.com/browse/AAP-38836 Affects `controller-user-guide` * remove_auditors updates
1 parent f190205 commit 6eda97b

File tree

1 file changed

+43
-1
lines changed

1 file changed

+43
-1
lines changed

downstream/modules/platform/ref-controller-organization-mapping.adoc

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,4 +52,46 @@ SOCIAL_AUTH_GITHUB_ORGANIZATION_MAP = {}
5252
SOCIAL_AUTH_GITHUB_ORG_ORGANIZATION_MAP = {}
5353
SOCIAL_AUTH_GITHUB_TEAM_ORGANIZATION_MAP = {}
5454
SOCIAL_AUTH_SAML_ORGANIZATION_MAP = {}
55-
----
55+
----
56+
57+
.remove_auditors
58+
59+
Before {PlatformNameShort} {PlatformVers}, *System Auditor* rights were revoked when logging in using Single Sign-On (SSO).
60+
The user system auditor role was reset at login for SAML users when added in the {PlatformNameShort} user interface.
61+
62+
In {PlatformNameShort} {PlatformVers}, you can set a new special user flag to not remove system auditors when logging in, if you added the role in the user interface.
63+
64+
To enable this functionality:
65+
66+
. From the navigation panel, select {MenuAEAdminSettings}.
67+
. Select *SAML settings* from the list of *Authentication* options.
68+
. Click btn:[Edit] and update the *SAML Organization Attribute Mapping* to `{"remove_auditors": false}`.
69+
+
70+
.Example
71+
+
72+
[literal, options="nowrap" subs="+attributes"]
73+
+
74+
----
75+
{ "remove": true, "remove_admins": false,
76+
"remove_auditors": false, "saml_admin_attr":
77+
"admin-of", "saml_attr": "organizations" }
78+
----
79+
80+
.Verification
81+
82+
. Enable debugging in {ControllerName}.
83+
** From the navigation panel, select {MenuAEAdminSettings}.
84+
** Select *Logging settings* from the list of *System* options.
85+
** Click btn:[Edit] and select *Debug* in the *Logging Aggregator Level Threshold* drop-down menu.
86+
. Use SSO to log in to an account with *System Auditor* privileges.
87+
. Verify the results in `/var/log/tower/tower.log`.
88+
Or if you are running {PlatformNameShort} on {OCPShort}, review the web pod logs and look for the following, which occurs when a system auditor logs in, whose role was removed when logging in:
89+
+
90+
[literal, options="nowrap" subs="+attributes"]
91+
+
92+
----
93+
2025-01-17 14:19:36,624 DEBUG
94+
[7d3cf3b24d4e4d0e9edd5e2606d6ceba] awx.sso.common
95+
SAML adapter removing user auditor1 permission of
96+
auditor_role from organization Default
97+
----

0 commit comments

Comments
 (0)