deploy: 1035663833

develop/jwt.html

@@ -200,8 +200,9 @@ follows:</p>
 will be removed in a future version of Synapse.</p>
 <p>The <code>token</code> field should include the JSON web token with the following claims:</p>
 <ul>
-<li>The <code>sub</code> (subject) claim is required and should encode the local part of the
+<li>A claim that encodes the local part of the user ID is required. By default,
-user ID.</li>
+the <code>sub</code> (subject) claim is used, or a custom claim can be set in the
+configuration file.</li>
 <li>The expiration time (<code>exp</code>), not before time (<code>nbf</code>), and issued at (<code>iat</code>)
 claims are optional, but validated if present.</li>
 <li>The issuer (<code>iss</code>) claim is optional, but required and validated if configured.</li>

develop/print.html

@@ -5107,6 +5107,12 @@ sso:
     #
     #algorithm: "provided-by-your-issuer"
 
+    # Name of the claim containing a unique identifier for the user.
+    #
+    # Optional, defaults to `sub`.
+    #
+    #subject_claim: "sub"
+
     # The issuer to validate the "iss" claim against.
     #
     # Optional, if provided the "iss" claim will be required and
@@ -7137,8 +7143,9 @@ follows:</p>
 will be removed in a future version of Synapse.</p>
 <p>The <code>token</code> field should include the JSON web token with the following claims:</p>
 <ul>
-<li>The <code>sub</code> (subject) claim is required and should encode the local part of the
+<li>A claim that encodes the local part of the user ID is required. By default,
-user ID.</li>
+the <code>sub</code> (subject) claim is used, or a custom claim can be set in the
+configuration file.</li>
 <li>The expiration time (<code>exp</code>), not before time (<code>nbf</code>), and issued at (<code>iat</code>)
 claims are optional, but validated if present.</li>
 <li>The issuer (<code>iss</code>) claim is optional, but required and validated if configured.</li>

develop/sample_config.yaml

@@ -2039,6 +2039,12 @@ sso:
     #
     #algorithm: "provided-by-your-issuer"
 
+    # Name of the claim containing a unique identifier for the user.
+    #
+    # Optional, defaults to `sub`.
+    #
+    #subject_claim: "sub"
+
     # The issuer to validate the "iss" claim against.
     #
     # Optional, if provided the "iss" claim will be required and

develop/usage/configuration/homeserver_sample_config.html

@@ -2231,6 +2231,12 @@ sso:
     #
     #algorithm: "provided-by-your-issuer"
 
+    # Name of the claim containing a unique identifier for the user.
+    #
+    # Optional, defaults to `sub`.
+    #
+    #subject_claim: "sub"
+
     # The issuer to validate the "iss" claim against.
     #
     # Optional, if provided the "iss" claim will be required and