Get User Settings

workspacesweb_get_user_settings

R Documentation

Gets user settings

Description

Gets user settings.

Usage

workspacesweb_get_user_settings(userSettingsArn)

Arguments

userSettingsArn

[required] The ARN of the user settings.

Value

A list with the following syntax:

list(
  userSettings = list(
    userSettingsArn = "string",
    associatedPortalArns = list(
      "string"
    ),
    copyAllowed = "Disabled"|"Enabled",
    pasteAllowed = "Disabled"|"Enabled",
    downloadAllowed = "Disabled"|"Enabled",
    uploadAllowed = "Disabled"|"Enabled",
    printAllowed = "Disabled"|"Enabled",
    disconnectTimeoutInMinutes = 123,
    idleDisconnectTimeoutInMinutes = 123,
    cookieSynchronizationConfiguration = list(
      allowlist = list(
        list(
          domain = "string",
          name = "string",
          path = "string"
        )
      ),
      blocklist = list(
        list(
          domain = "string",
          name = "string",
          path = "string"
        )
      )
    ),
    customerManagedKey = "string",
    additionalEncryptionContext = list(
      "string"
    ),
    deepLinkAllowed = "Disabled"|"Enabled",
    toolbarConfiguration = list(
      toolbarType = "Floating"|"Docked",
      visualMode = "Dark"|"Light",
      hiddenToolbarItems = list(
        "Windows"|"DualMonitor"|"FullScreen"|"Webcam"|"Microphone"
      ),
      maxDisplayResolution = "size4096X2160"|"size3840X2160"|"size3440X1440"|"size2560X1440"|"size1920X1080"|"size1280X720"|"size1024X768"|"size800X600"
    ),
    brandingConfiguration = list(
      logo = list(
        mimeType = "image/png"|"image/jpeg"|"image/x-icon",
        fileExtension = "string",
        lastUploadTimestamp = as.POSIXct(
          "2015-01-01"
        )
      ),
      wallpaper = list(
        mimeType = "image/png"|"image/jpeg"|"image/x-icon",
        fileExtension = "string",
        lastUploadTimestamp = as.POSIXct(
          "2015-01-01"
        )
      ),
      favicon = list(
        mimeType = "image/png"|"image/jpeg"|"image/x-icon",
        fileExtension = "string",
        lastUploadTimestamp = as.POSIXct(
          "2015-01-01"
        )
      ),
      localizedStrings = list(
        list(
          browserTabTitle = "string",
          welcomeText = "string",
          loginTitle = "string",
          loginDescription = "string",
          loginButtonText = "string",
          contactLink = "string",
          contactButtonText = "string",
          loadingText = "string"
        )
      ),
      colorTheme = "Light"|"Dark",
      termsOfService = "string"
    ),
    webAuthnAllowed = "Disabled"|"Enabled"
  )
)

Request syntax

svc$get_user_settings(
  userSettingsArn = "string"
)