> For the complete documentation index, see [llms.txt](https://docs.parallels.com/landing/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.parallels.com/landing/ras-client-integration-guide/ras-web-client-api/authentication-handoff-api/request-payload.md).

# 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:

```javascript
{
  "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"
  }
}
```

{% hint style="danger" %}
**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.
{% endhint %}

### Parameters

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

### 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.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.parallels.com/landing/ras-client-integration-guide/ras-web-client-api/authentication-handoff-api/request-payload.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.