Title: Get cWatch SSO URL via the API  
PrimaryCategory: API  
Type: Procedural  
Tags: cwatch, sso, api, url, authentication, reseller  
Source UI Terms: None  
Source Reference: Get cWatch SSO URL via the API  

Prerequisites:
- Have the order ID for which you want to generate the SSO access.
- Have the reseller ID (auth-userid) for authentication.
- Have the reseller API key for authentication.

Steps:
1) Construct a GET request to the following endpoint, replacing `{orderid}`, `{auth-userid}`, and `{api-key}` with the appropriate values:  
   `https://httpapi.com/restapi/product/cwatch/order/{orderid}/sso-url?auth-userid={auth-userid}&amp;api-key={api-key}`  

2) Send the GET request to this URL.

3) Receive the response containing the Single Sign-On URL in the JSON format:  
   ```json
   {
     &quot;ssoUrl&quot;: &quot;https://cwatch.example.com/sso?token=...&quot;
   }
   ```

Summary:
You can retrieve a Single Sign-On URL via API by sending a GET request with the order ID, reseller ID, and API key; the response provides a direct login link to the cWatch dashboard for that order.

Evaluation Pairs:
Q: What parameters are required to get the cWatch SSO URL via the API?  
A: You must provide the order ID, reseller ID (auth-userid), and reseller API key.

Q: Which HTTP method do you use to request the cWatch SSO URL?  
A: Use the GET HTTP method.

Q: What does the API response contain when requesting the cWatch SSO URL?  
A: It returns a JSON object with the &quot;ssoUrl&quot; key containing the Single Sign-On URL for that order.

<div>
<div>
<div>
<div>
<div>
<div>
<h1>Description</h1>
<p>Returns a Single Sign-On (SSO) URL that logs the customer directly into the cWatch dashboard for a given order.</p>
<h2><a name="heading_0"></a>Parameters</h2>
<table style="width: 597.667px;"><tbody><tr><th colspan="1" rowspan="1">Name</th><th colspan="1" rowspan="1">Data Type</th><th colspan="1" rowspan="1">Required / Optional</th><th colspan="1" rowspan="1">Description</th></tr><tr><td colspan="1" rowspan="1">orderid</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">The ID of the order to generate SSO access for (passed in the URL path)</td></tr><tr><td colspan="1" rowspan="1">auth-userid</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Reseller ID (Authentication Parameter)</td></tr><tr><td colspan="1" rowspan="1">api-key</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Reseller API key (Authentication Parameter)</td></tr></tbody></table>
<h2><a name="heading_1"></a>HTTP Method</h2>
<p>GET</p>
<h2><a name="heading_2"></a>Example Request</h2>
<pre>GET <a href="https://httpapi.com/restapi/product/cwatch/order/666690/sso-url?auth-userid=0&amp;api-key=key" target="_blank" rel="noopener noreferrer">https://httpapi.com/restapi/product/cwatch/order/666690/sso-url?auth-userid=0&amp;api-key=key</a></pre>
<h2><a name="heading_3"></a>Response</h2>
<p>Returns a Single Sign-On URL for the specified order. Representative example:</p>
<pre>{ &quot;ssoUrl&quot;: &quot;<a href="https://cwatch.example.com/sso?token=..." target="_blank" rel="noopener noreferrer">https://cwatch.example.com/sso?token=...</a>&quot; }</pre>
</div>
</div>
</div>
</div>
</div>
</div>

Name	Data Type	Required / Optional	Description
orderid	Integer	Required	The ID of the order to generate SSO access for (passed in the URL path)
auth-userid	Integer	Required	Reseller ID (Authentication Parameter)
api-key	String	Required	Reseller API key (Authentication Parameter)