Describe Client Branding

workspaces_describe_client_branding

R Documentation

Describes the specified client branding

Description

Describes the specified client branding. Client branding allows you to customize the log in page of various device types for your users. You can add your company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.

Only device types that have branding information configured will be shown in the response.

Usage

workspaces_describe_client_branding(ResourceId)

Arguments

ResourceId

[required] The directory identifier of the WorkSpace for which you want to view client branding information.

Value

A list with the following syntax:

list(
  DeviceTypeWindows = list(
    LogoUrl = "string",
    SupportEmail = "string",
    SupportLink = "string",
    ForgotPasswordLink = "string",
    LoginMessage = list(
      "string"
    )
  ),
  DeviceTypeOsx = list(
    LogoUrl = "string",
    SupportEmail = "string",
    SupportLink = "string",
    ForgotPasswordLink = "string",
    LoginMessage = list(
      "string"
    )
  ),
  DeviceTypeAndroid = list(
    LogoUrl = "string",
    SupportEmail = "string",
    SupportLink = "string",
    ForgotPasswordLink = "string",
    LoginMessage = list(
      "string"
    )
  ),
  DeviceTypeIos = list(
    LogoUrl = "string",
    Logo2xUrl = "string",
    Logo3xUrl = "string",
    SupportEmail = "string",
    SupportLink = "string",
    ForgotPasswordLink = "string",
    LoginMessage = list(
      "string"
    )
  ),
  DeviceTypeLinux = list(
    LogoUrl = "string",
    SupportEmail = "string",
    SupportLink = "string",
    ForgotPasswordLink = "string",
    LoginMessage = list(
      "string"
    )
  ),
  DeviceTypeWeb = list(
    LogoUrl = "string",
    SupportEmail = "string",
    SupportLink = "string",
    ForgotPasswordLink = "string",
    LoginMessage = list(
      "string"
    )
  )
)

Request syntax

svc$describe_client_branding(
  ResourceId = "string"
)