Skip to main content
The Username & Password API lets an external system (HR, PMS, event platform) pre-create and rotate username/password user accounts on a Sign-In Context. Use this family when your workflow hands out credentials before the guest arrives (e.g. at check-in) rather than letting them self-provision at the Captive Portal.

​
Prerequisites

  • The target Sign-In Context has the Username and Password module enabled.
  • Your integration has the Context API key (x-auth-token) and the Organization is configured with the caller’s source IP on the Administrator portal IP whitelist.
See API overview for the common auth, base URL, and status-code model.

​
Error body

A failed request in this family returns: 
{
  "error_code": "VALIDATION_ERROR",
  "error_message": "username is required",
  "request_id": "6f5e4d3c-..."
}
  • error_code — machine-readable category.
  • error_message — human-readable description of what went wrong.
  • request_id — correlation ID; include it when reporting an issue.

​
Operations

Create user

POST .../modules/up/create

Update user

PUT .../modules/up/update

Delete user

DELETE .../modules/up/delete