From 5b484993a33d9cd0f4bb73c8638c853010716308 Mon Sep 17 00:00:00 2001
From: Hongchol Sinn <hongchol.sinn@broadcom.com>
Date: Tue, 15 Oct 2024 17:11:50 -0700
Subject: [PATCH] Deprecate SAML `assertionConsumerIndex` config property

- It only works if set to `0`, which is the default value for the optional parameter.
---
 docs/UAA-APIs.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/UAA-APIs.rst b/docs/UAA-APIs.rst
index 56079d778fe..74164a78df8 100644
--- a/docs/UAA-APIs.rst
+++ b/docs/UAA-APIs.rst
@@ -1344,7 +1344,7 @@ Fields            *Available Fields* ::
                     zoneId                   String                  Required Must match ``identityZoneId`` in the provider definition
                     metaDataLocation         String                  Required SAML Metadata - either an XML string or a URL that will deliver XML content
                     nameID                   String                  Optional The name ID to use for the username, default is "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified". Currently the UAA expects the username to be a valid email address.
-                    assertionConsumerIndex   int                     Optional SAML assertion consumer index, default is 0
+                    assertionConsumerIndex   int                     Optional SAML assertion consumer index, default is 0. (Deprecated. Does not work if set to anything but 0.)
                     metadataTrustCheck       boolean                 Optional Should metadata be validated, defaults to false
                     showSamlLink             boolean                 Optional Should the SAML login link be displayed on the login page, defaults to false
                     linkText                 String                  Optional Required if the ``showSamlLink`` is set to true.