Manage2 API Function - Create a Nova Cloud SSO link

Last modified: 2026 May 15


Description

This function creates a Single Sign-On (SSO) link for Nova Cloud users. When a user clicks the provided link, the system logs them in without a username or password.

Important:

This function only applies to Nova Cloud licenses.

Examples

XML

https://manage2.cpanel.net/XMLsso.cgi?liscid=6527118

JSON

https://manage2.cpanel.net/XMLsso.cgi?output=json&liscid=6527118

YAML

https://manage2.cpanel.net/XMLsso.cgi?output=yaml&liscid=6527118

<XMLsso expiresAt="2026-05-14T12:55:39+00:00" reason="OK" ssoUrl="https://us-south-tx1b-cpanelnova-0001.host.webpros.cloud:2083/cpsess3198745310/login/?session=cpn50596429%3arH4pWDTqFmvDlHAK%3acreate_user_session%2c44085c8281da96b84ce264f969275ed4" status="1" />

1
2
3
4
5
6
{
  "ssoUrl":"https://us-south-tx1b-cpanelnova-0001.host.webpros.cloud:2083/cpsess9613888405/login/?session=cpn22347192%3afgmBFrL5VnEI0G0j%3acreate_user_session%2c1499235c72e2fcf0b900731ca573e6a0",
  "status":1,
  "reason":"OK",
  "expiresAt":"2026-05-14T13:31:00+00:00"
}

1
2
3
4
5
---
expiresAt: 2026-05-14T13:32:35+00:00
reason: OK
ssoUrl: https://us-south-tx1b-cpanelnova-0001.host.webpros.cloud:2083/cpsess2238105773/login/?session=cpn62778462%3avQq7N5NfoNyViOnR%3acreate_user_session%2c0404df93b916466b692573f914c504e0
status: 1

Parameters

This function accepts the following parameter:

Parameter Type Description Example
liscid integer Required
The Nova Cloud license ID.
6527118

Returns

This function returns the following values:

Return Type Description Example
ssoUrl string The Single Sign-On (SSO) link for Nova Cloud users. https://9975f696-fd22-11f0-8ce4-0a06a0357f77.host.webpros-dev1.cloud:2083/cpsess3402569696/login/?session=cpn32919038%3a45E0AoUzbsRzH2dH%3acreate_user_session%2cccc65f17c62c067a2c983bd3a3710b99
expiresAt string Timestamp indicating when the link will no longer be active. 2026-02-26T18:04:56+00:00

Additional Documentation