wapsso — WAP API
Create a WAP administrator login link through the WAP root administrator API, with request fields, response details, errors and cURL/Python/PHP examples.
/api/v1/wapsso/Also accepts GETGenerates a signed quick-login URL for the WAP administrator. The user field must be the literal root; it is separate from the API username in the authentication header. The returned URL targets the server hostname on WAP HTTPS port 5555 with a 30-minute token expiry. It grants administrator access: keep the entire link private and do not log it, include it in analytics or follow it automatically in a backend test.
Request
| Property | Value |
|---|---|
| Methods | GET, POST |
| Versioned path | /api/v1/wapsso/ |
| Default path | /api/wapsso/ |
| Authentication | WAP root administrator API credentials. |
| Header | Required value |
|---|---|
X-API-USER | Your WAP API username. |
X-API-PASSWORD | Its API password. |
Parameters
| Field | Required | Type and behavior |
|---|---|---|
user | Yes | String. The literal root. Other values are rejected. |
POST reads the JSON/form body; GET reads query parameters. The examples use form-encoded POST. Although GET is supported, use POST for account changes and login-link generation so action fields are not placed in URLs. Authentication remains in the two headers. Undeclared fields are not additional API options.
Replace server.example.com, billing_api and YOUR_API_PASSWORD in each standalone example. Replace operation sample values with your actual target and an existing package where required. Python needs Requests; PHP needs the cURL extension. These examples make real calls when run.
Success response
HTTP 200. Illustrative values; account records and server values vary. Stored account examples show only selected fields.
{
"data": {
"url": "https://server.example.com:5555/quick/EXAMPLE_TOKEN"
},
"info": "SSO Login Url of Admin",
"status": 200
}| Field | Type | Meaning |
|---|---|---|
status | integer | 200 on the documented success branch. |
info | string | Operation description. |
data | object | Operation data described below. |
data.url | string | Signed quick-login URL; its token is a credential. |
Errors and demo mode
| Condition | Actual HTTP status | Response behavior |
|---|---|---|
| Missing credentials with no other authenticated identity | 403 | detail: Authentication credentials were not provided. |
| Rejected password or source IP | 403 | detail: Invalid API credentials |
| Demo server | 400 | error: Demo server; info: Api Operations not available in demo server; JSON status: 403. |
| Invalid/missing operation fields or invalid target state | 400 | Field errors in error; JSON status: 400. |
| Backend reports failure | 400 | Operation error in error; JSON status: 500. |
| Unsupported method | 405 after authentication | Method-not-allowed response. |
Validation failure description: Unable to retrieve quick login url. The data is invalid.
Check both the HTTP status and JSON shape. Authentication failures do not use the operation envelope. Unexpected uncaught server errors are not guaranteed to return the documented JSON shape. Do not automatically retry account creation, password changes, deletions or SSO generation after a timeout: confirm the actual state first.