Single Sign-On Global State API

Use the Single Sign-On (SSO) Global State API to view or update the global status of SSO.

To retrieve the overall status of setting the SSO state or the status for a single component, see the Single Sign-On Status API.

URL

https://<server>/unifiedconfig/config/sso/globalstate

Operations

  • get: Returns the current global state of SSO in the database.

  • update: Updates the global state of SSO in the database.

Parameters

  • refURL: The RefURL. See Shared Parameters.

  • changeStamp: See Shared Parameters.

  • permissionInfo: Information about permissions.

    • canUpdate: Whether ssoState can be updated. True or false.

    • role: The role of the user.

  • state: Required for update. Valid values are NON_SSO (SSO is disabled for all users), SSO (SSO is enabled for all users), and HYBRID (mix of enabled and disabled).

Example Get Response

Code Snippet
Copy
<ssoState>
    <refURL>/ssostate</refURL>
    <changeStamp>227</changeStamp>
    <permissionInfo>
        <canUpdate>true</canUpdate>
        <role>Administrator</role>
    </permissionInfo>
    <state>SSO</state>
</ssoState>