summary refs log tree commit diff
path: root/docs/usage
diff options
context:
space:
mode:
authorAndrew Morgan <1342360+anoadragon453@users.noreply.github.com>2025-05-19 17:50:02 +0100
committerGitHub <noreply@github.com>2025-05-19 17:50:02 +0100
commit1f4ae2f9eb94808f651b683b4650092015ec39e1 (patch)
treecd2b7aa1d5e87e11ac6977a42e3c06b8f76f559a /docs/usage
parentBump docker/build-push-action from 6.16.0 to 6.17.0 (#18449) (diff)
downloadsynapse-1f4ae2f9eb94808f651b683b4650092015ec39e1.tar.xz
Allow only requiring a field be present in an SSO response, rather than specifying a required value (#18454)
Diffstat (limited to 'docs/usage')
-rw-r--r--docs/usage/configuration/config_documentation.md10
1 files changed, 8 insertions, 2 deletions
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md

index e688bc5cd8..3927b9ca14 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md
@@ -3782,17 +3782,23 @@ match particular values in the OIDC userinfo. The requirements can be listed und ```yaml attribute_requirements: - attribute: family_name - value: "Stephensson" + one_of: ["Stephensson", "Smith"] - attribute: groups value: "admin" + # If `value` or `one_of` are not specified, the attribute only needs + # to exist, regardless of value. + - attribute: picture ``` + +`attribute` is a required field, while `value` and `one_of` are optional. + All of the listed attributes must match for the login to be permitted. Additional attributes can be added to userinfo by expanding the `scopes` section of the OIDC config to retrieve additional information from the OIDC provider. If the OIDC claim is a list, then the attribute must match any value in the list. Otherwise, it must exactly match the value of the claim. Using the example -above, the `family_name` claim MUST be "Stephensson", but the `groups` +above, the `family_name` claim MUST be either "Stephensson" or "Smith", but the `groups` claim MUST contain "admin". Example configuration: