idps Rest API button-text property

[BJ]

When using the /rest/authconfig/1.0/idps REST API against Confluence 9.2.15, the following error occurs:

HTTP Error 400:

Unrecognized field "button-text" (class com.atlassian.plugins.authentication.sso.rest.model.IdpConfigEntity) not marked as ignorable (24 known properties: "enabled", "last-updated", "username-attribute", "authorization-endpoint", "name", "enable-remember-me", "crowd-url", "sso-url", "dip-type", "include-customer-logins", "sso-issuer", "sso-type", "id", "client-id", "jit-configuration", "buttonText", "additional-scopes", "token-endpoint", "client-secret", "certificate", "issuer-url", "user info-endpoint", "username-claim", "discovery-enabled"])

The request data does include a property of "button-text", but the message indicates it should be "buttonText". I changed the request data to use "buttonText", and it does succeed. However, in looking at examples I have found they indicate it should be "button-text". Has anything changed in the /rest/authconfig/1.0/idps REST API?

[Peter_DevSamurai · Accepted solution]

Hi @BJ , 

Yes you're right, the examples are outdated:

• Confluence 9.2.15 (Data Center) is using the private SSO REST API, and in this version the field is buttonText(camelCase), not button-text -> Hence the error message shows.

• These SSO endpoints are explicitly marked as private APIs, which means Atlassian can change them without keeping examples perfectly in sync between versions.

And for Confluence 9.2.15 you should use: "buttonText": "Log in with IdP". 

You can refer to this document: SSO REST APIs and private API note (with the old, outdated examples of button-text).

I hope everything works out well for you!

Bestest regards, 

Peter

[Tomislav Tobijas]

Hi @BJ ,

From what I've managed to find, it is, indeed, "buttonText" property and not "button-text" (kebab-case). Now, you could dig through official release notes (e.g., Confluence 9.2 upgrade notes) to see if they specifically listed this there. 👀

As for examples you've looked at, can you maybe share the link to those? Maybe this could help clarify to which version these are/were referring to. 🤔

Cheers,
Tobi