Skip to Content
Browse documentation

uappsso — WAP API

Create a UAPP login link through the WAP root administrator API, with request fields, response details, errors and cURL/Python/PHP examples.

POST/api/v1/uappsso/Also accepts GET

Generates a signed quick-login URL for an existing, unsuspended hosting user. The API response contains a URL, not an HTTP redirect. The link targets the server hostname on UAPP HTTPS port 3333. The current token generator sets a 30-minute expiry. Treat the full URL as a login credential: deliver it only to the intended user, do not log it or put it in analytics, and do not follow it automatically from a backend test. The route is uappsso; the older quickloginurl name in source comments is not a declared route.

Request

PropertyValue
MethodsGET, POST
Versioned path/api/v1/uappsso/
Default path/api/uappsso/
AuthenticationWAP root administrator API credentials.
HeaderRequired value
X-API-USERYour WAP API username.
X-API-PASSWORDIts API password.

Parameters

FieldRequiredType and behavior
userYesString. Existing hosting username; required account state is described above.

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:3333/quick/EXAMPLE_TOKEN"
  },
  "info": "Hosting account quick login url of exampleuser",
  "status": 200
}
FieldTypeMeaning
statusinteger200 on the documented success branch.
infostringOperation description.
dataobjectOperation data described below.
data.urlstringSigned quick-login URL; its token is a credential.

Errors and demo mode

ConditionActual HTTP statusResponse behavior
Missing credentials with no other authenticated identity403detail: Authentication credentials were not provided.
Rejected password or source IP403detail: Invalid API credentials
Demo server400error: Demo server; info: Api Operations not available in demo server; JSON status: 403.
Invalid/missing operation fields or invalid target state400Field errors in error; JSON status: 400.
Backend reports failure400Operation error in error; JSON status: 500.
Unsupported method405 after authenticationMethod-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.

See WAP API authentication and connection troubleshooting.