--- title: "POST /userSettings" method: POST path: "/userSettings" --- # POST /userSettings `POST /userSettings` Creates a user settings resource that can be associated with a web portal. Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices. ## Request body - object - `copyAllowed` 'Disabled' | 'Enabled', required — Specifies whether the user can copy text from the streaming session to the local device. - `pasteAllowed` 'Disabled' | 'Enabled', required — Specifies whether the user can paste text from the local device to the streaming session. - `downloadAllowed` 'Disabled' | 'Enabled', required — Specifies whether the user can download files from the streaming session to the local device. - `uploadAllowed` 'Disabled' | 'Enabled', required — Specifies whether the user can upload files from the local device to the streaming session. - `printAllowed` 'Disabled' | 'Enabled', required — Specifies whether the user can print to the local device. - `tags` Tag[] — The tags to add to the user settings resource. A tag is a key-value pair. - `Key` string, password, required — The key of the tag. - `Value` string, password, required — The value of the tag - `disconnectTimeoutInMinutes` integer — The amount of time that a streaming session remains active after users disconnect. - `idleDisconnectTimeoutInMinutes` integer — The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins. - `clientToken` string —

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

- `cookieSynchronizationConfiguration` object — The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser. - `allowlist` CookieSpecification[] — The list of cookie specifications that are allowed to be synchronized to the remote browser. - `domain` string, password, required — The domain of the cookie. - `name` string, password — The name of the cookie. - `path` string, password — The path of the cookie. - `blocklist` CookieSpecification[] — The list of cookie specifications that are blocked from being synchronized to the remote browser. - `domain` string, password, required — The domain of the cookie. - `name` string, password — The name of the cookie. - `path` string, password — The path of the cookie. - `customerManagedKey` string — The customer managed key used to encrypt sensitive information in the user settings. - `additionalEncryptionContext` object — The additional encryption context of the user settings. - `deepLinkAllowed` 'Disabled' | 'Enabled' — Specifies whether the user can use deep links that open automatically when connecting to a session. - `toolbarConfiguration` object — The configuration of the toolbar. This allows administrators to select the toolbar type and visual mode, set maximum display resolution for sessions, and choose which items are visible to end users during their sessions. If administrators do not modify these settings, end users retain control over their toolbar preferences. - `toolbarType` 'Floating' | 'Docked' — The type of toolbar displayed during the session. - `visualMode` 'Dark' | 'Light' — The visual mode of the toolbar. - `hiddenToolbarItems` ToolbarItem[] — The list of toolbar items to be hidden. - `maxDisplayResolution` 'size4096X2160' | 'size3840X2160' | 'size3440X1440' | 'size2560X1440' | 'size1920X1080' | 'size1280X720' | 'size1024X768' | 'size800X600' — The maximum display resolution that is allowed for the session. - `brandingConfigurationInput` object — The input configuration for creating branding settings. - `logo` object — The logo image for the portal. Provide either a binary image file or an S3 URI pointing to the image file. Maximum 100 KB in JPEG, PNG, or ICO format. - `blob` string — The image provided as a binary image file. - `s3Uri` string — The S3 URI pointing to the image file. The URI must use the format s3://bucket-name/key-name. You must have read access to the S3 object. - `wallpaper` object — The wallpaper image for the portal. Provide either a binary image file or an S3 URI pointing to the image file. Maximum 5 MB in JPEG or PNG format. If not provided, a default wallpaper will be used as the background image. - `blob` string — The image provided as a binary image file. - `s3Uri` string — The S3 URI pointing to the image file. The URI must use the format s3://bucket-name/key-name. You must have read access to the S3 object. - `favicon` object — The favicon image for the portal. Provide either a binary image file or an S3 URI pointing to the image file. Maximum 100 KB in JPEG, PNG, or ICO format. - `blob` string — The image provided as a binary image file. - `s3Uri` string — The S3 URI pointing to the image file. The URI must use the format s3://bucket-name/key-name. You must have read access to the S3 object. - `localizedStrings` object — A map of localized text strings for different supported languages. Each locale must provide the required fields browserTabTitle and welcomeText. - `colorTheme` 'Light' | 'Dark' — The color theme for components on the web portal. Choose Light if you upload a dark wallpaper, or Dark for a light wallpaper. - `termsOfService` string, password — The terms of service text in Markdown format. Users will be presented with the terms of service after successfully signing in. - `webAuthnAllowed` 'Disabled' | 'Enabled' — Specifies whether the user can use WebAuthn redirection for passwordless login to websites within the streaming session. ## Response `200` Success - CreateUserSettingsResponse - `userSettingsArn` string, required — The ARN of the user settings. ## Other responses - `480` — InternalServerException - `481` — ResourceNotFoundException - `482` — AccessDeniedException - `483` — ThrottlingException - `484` — ServiceQuotaExceededException - `485` — ValidationException - `486` — ConflictException --- [API](https://skmtc.net/aws/apis/workspaces-web.md) · [All operations](https://skmtc.net/aws/apis/workspaces-web/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/workspaces-web/versions/4206b0208021/schema)