DescribeClientBranding

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.

Note

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

Request Syntax


{
   "ResourceId": "string"
}

Request Parameters

The request accepts the following data in JSON format.

ResourceId

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

Type: String

Length Constraints: Minimum length of 10. Maximum length of 65.

Pattern: ^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)

Required: Yes

Response Syntax


{
   "DeviceTypeAndroid": { 
      "ForgotPasswordLink": "string",
      "LoginMessage": { 
         "string" : "string" 
      },
      "LogoUrl": "string",
      "SupportEmail": "string",
      "SupportLink": "string"
   },
   "DeviceTypeIos": { 
      "ForgotPasswordLink": "string",
      "LoginMessage": { 
         "string" : "string" 
      },
      "Logo2xUrl": "string",
      "Logo3xUrl": "string",
      "LogoUrl": "string",
      "SupportEmail": "string",
      "SupportLink": "string"
   },
   "DeviceTypeLinux": { 
      "ForgotPasswordLink": "string",
      "LoginMessage": { 
         "string" : "string" 
      },
      "LogoUrl": "string",
      "SupportEmail": "string",
      "SupportLink": "string"
   },
   "DeviceTypeOsx": { 
      "ForgotPasswordLink": "string",
      "LoginMessage": { 
         "string" : "string" 
      },
      "LogoUrl": "string",
      "SupportEmail": "string",
      "SupportLink": "string"
   },
   "DeviceTypeWeb": { 
      "ForgotPasswordLink": "string",
      "LoginMessage": { 
         "string" : "string" 
      },
      "LogoUrl": "string",
      "SupportEmail": "string",
      "SupportLink": "string"
   },
   "DeviceTypeWindows": { 
      "ForgotPasswordLink": "string",
      "LoginMessage": { 
         "string" : "string" 
      },
      "LogoUrl": "string",
      "SupportEmail": "string",
      "SupportLink": "string"
   }
}