Request Payload

The handoff payload is a JSON object submitted in the body of the POST request. The values below are for demonstration purposes only and should be substituted with your own:

{
  "username": "alice",
  "password": "••••••••",
  "login": "https://your-portal.example.com/login",
  "logout": "https://your-portal.example.com/logout",
  "appid": 2,
  "theme": "dark",
  "p": "key=value",
  "extra": {
    "redirectLinks": true,
    "redirectPrinter": false,
    "redirectSound": true,
    "keyboardCompMode": true,
    "keyboardLayout": "1033",
    "redirectClipboard": "3"
  }
}

Warning: Since the payload contains user credentials, it must be generated dynamically for every user and submitted over HTTPS. Never embed credentials in static pages or URLs.

Parameters

Field	Required	Description
username	Yes	User identity validated by the Gateway.
password	Yes	Credential validated by the Gateway.
login	No	Custom portal or IDP URL used on refresh or sign-in error.
logout	No	Custom portal or IDP URL used on sign out.
appid	No	Published resource ID to launch immediately. The ID is displayed in the RAS Console in the Publishing category, on the Information tab of the published resource. If omitted, the user sees all resources available to them in the User Portal.
theme	No	Theme name forwarded to the User Portal.
p	No	Additional launch parameters string.
extra	No	Optional per-session redirection settings, such as links, printer, sound, keyboard, and clipboard options.

Response handling

The Gateway returns a 3xx response, typically 302. The browser follows the redirect automatically to the User Portal destination. Your integration does not need to inspect the response body or manage JWT contents — token creation, validation, and session handling are managed by the User Portal Gateway.