mirror of
https://github.com/zulip/zulip.git
synced 2025-10-23 16:14:02 +00:00
ldap: Improve doc on AUTH_LDAP_ADVANCED_REALM_ACCESS_CONTROL.
This fixes the explanation of the setting's syntax to be more precise (which doesn't mean "easily understandable" - because the setting is a bit tricky) as well as an example to illustrate it.
This commit is contained in:
committed by
Tim Abbott
parent
be179b2b6b
commit
6ef745675c
@@ -374,10 +374,35 @@ More complex access control rules are possible via the
|
|||||||
2. If `org_membership` is not set or does not allow access,
|
2. If `org_membership` is not set or does not allow access,
|
||||||
`AUTH_LDAP_ADVANCED_REALM_ACCESS_CONTROL` will control access.
|
`AUTH_LDAP_ADVANCED_REALM_ACCESS_CONTROL` will control access.
|
||||||
|
|
||||||
This contains a map keyed by the organization's subdomain. The
|
`AUTH_LDAP_ADVANCED_REALM_ACCESS_CONTROL` is a dictionary keyed by the
|
||||||
organization list with multiple maps, that contain a map with an attribute, and a required
|
organization's subdomain. The corresponding value is a list of
|
||||||
value for that attribute. If for any of the attribute maps, all user's
|
`attribute: value` pair sets such that a user is permitted to access
|
||||||
LDAP attributes match what is configured, access is granted.
|
the organization if and only if the `attribute: value` pairs in at
|
||||||
|
least one of these sets match the user's LDAP attributes. If this
|
||||||
|
setting is enabled, organizations not explicitly configured in this
|
||||||
|
setting will not be accessible via ldap authentication at all.
|
||||||
|
|
||||||
|
This is better illustrated with an example:
|
||||||
|
|
||||||
|
```
|
||||||
|
AUTH_LDAP_ADVANCED_REALM_ACCESS_CONTROL = {
|
||||||
|
"zulip": [
|
||||||
|
{
|
||||||
|
"department": "main",
|
||||||
|
"employeeType": "staff"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"office": "Dallas"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
This means that the organization `"zulip"` will be accessible via ldap
|
||||||
|
authentication only for users whose ldap attributes either contain
|
||||||
|
both `department: main` `employeeType: staff` or just `office:
|
||||||
|
Dallas`. LDAP authentication will always fail for all other
|
||||||
|
organizations in this configuration.
|
||||||
|
|
||||||
:::{warning}
|
:::{warning}
|
||||||
Restricting access using these mechanisms only affects authentication via LDAP,
|
Restricting access using these mechanisms only affects authentication via LDAP,
|
||||||
|
Reference in New Issue
Block a user