Enabling SSO Service

Use the enable operation to enable SSO support in Plesk. You can enable the service only if it is registered in an IdP.

In this chapter:

Request Packet

Response Packet Structure

Samples

 

Request Packet

A request XML packet enabling SSO support includes the enable operation node:

<packet version="1.5.2.0">
<sso>
   <enable/>
</sso>
</packet>

 

The enable node is required. Data type: none.

 

Response Packet Structure

The enable node of the output XML packet is presented by type SSOEnableOutput (sso.xsd) and structured as follows:

  • The result node is required. It wraps the response retrieved from the server. Data type: resultType (common.xsd).
  • The status node is required. It specifies the execution status of the enable operation. Data type: string. Allowed values: ok | error.
  • The errcode node is optional. Is returns the error code if the enable operation fails. Data type: integer.
  • The errtext node is optional. It returns the error message if the enable operation fails. Data type: string.

 

 

Samples

This request packet enables the SSO support on the server.

<packet version="1.5.2.0">
<sso>
   <enable/>
</sso>
</packet>

Response:

<packet version="1.5.2.0">
<sso>
   <enable>
      <result>
          <status>ok</status>
      </result>
   </enable>
</sso>
</packet>