Changing Default IdP URL

The set-default-idp operation is used to change the default IdP URL (given to Plesk after its registration in IdP). For instance, the operation is used when the IdP site name is changed.

Note: The operation does not force Plesk to re-register in the IdP specified by a new default IdP URL.

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 
Request Packet Structure

A request XML packet changing the default IdP URL includes the set-default-idp operation node:

<packet version="1.5.2.0">
<sso>
   <set-default-idp>
...
   </set-default-idp>
</sso>
</packet>

 

The set-default-idp node is presented by type SSOSetDefaultRelayInput (sso.xsd), and its graphical representation is as follows:

  • The idp-url node is required. It specifies URL of the default IdP. Data type: base64.
 
Response Packet Structure

The set-default-idp node of the output XML packet is presented by type SSOSetDefaultRelayOutput (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 operation. Data type: string. Allowed values: ok | error.
  • The errcode node is optional. Is returns the error code if the operation fails. Data type: integer.
  • The errtext node is optional. It returns the error message if the operation fails. Data type: string.

 

 
Samples

The packet that changes the default IdP URL to http://sso.example.com:1180/ can look as follows:

<packet version="1.5.2.0">
<sso>
   <set-default-idp>
		<idp-url>aHR0cDovL3Nzby5leGFtcGxlLmNvbToxMTgwLw==</idp-url>
   </set-default-idp>
</sso>
</packet>

Response:

<packet version="1.5.2.0">
<sso>
   <set-default-idp>
      <result>
          <status>ok</status>
      </result>
   </set-default-idp>
</sso>
</packet>

 

 

Leave your comments on this page

Leave your feedback or question on this documentation topic below. For technical assistance, contact your hosting service provider or submit a request to Plesk support. Suggest new features for Plesk here. Discuss general questions on the Plesk forum. All offtopic comments will be removed.