Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ImportClientBranding

Imports client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.

After you import client branding, the default branding experience for the specified platform type is replaced with the imported experience

Note

You must specify at least one platform type when importing client branding.
You can import up to 6 MB of data with each request. If your request exceeds this limit, you can import client branding for different platform types using separate requests.
In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify only one parameter for each platform type, but not both.
Imported data can take up to a minute to appear in the WorkSpaces client.

Request Syntax


{
   "DeviceTypeAndroid": { 
      "ForgotPasswordLink": "string",
      "LoginMessage": { 
         "string" : "string" 
      },
      "Logo": blob,
      "SupportEmail": "string",
      "SupportLink": "string"
   },
   "DeviceTypeIos": { 
      "ForgotPasswordLink": "string",
      "LoginMessage": { 
         "string" : "string" 
      },
      "Logo": blob,
      "Logo2x": blob,
      "Logo3x": blob,
      "SupportEmail": "string",
      "SupportLink": "string"
   },
   "DeviceTypeLinux": { 
      "ForgotPasswordLink": "string",
      "LoginMessage": { 
         "string" : "string" 
      },
      "Logo": blob,
      "SupportEmail": "string",
      "SupportLink": "string"
   },
   "DeviceTypeOsx": { 
      "ForgotPasswordLink": "string",
      "LoginMessage": { 
         "string" : "string" 
      },
      "Logo": blob,
      "SupportEmail": "string",
      "SupportLink": "string"
   },
   "DeviceTypeWeb": { 
      "ForgotPasswordLink": "string",
      "LoginMessage": { 
         "string" : "string" 
      },
      "Logo": blob,
      "SupportEmail": "string",
      "SupportLink": "string"
   },
   "DeviceTypeWindows": { 
      "ForgotPasswordLink": "string",
      "LoginMessage": { 
         "string" : "string" 
      },
      "Logo": blob,
      "SupportEmail": "string",
      "SupportLink": "string"
   },
   "ResourceId": "string"
}

Request Parameters

The request accepts the following data in JSON format.

DeviceTypeAndroid

The branding information to import for Android devices.

Type: DefaultImportClientBrandingAttributes object

Required: No

DeviceTypeIos

The branding information to import for iOS devices.

Type: IosImportClientBrandingAttributes object

Required: No

DeviceTypeLinux

The branding information to import for Linux devices.

Type: DefaultImportClientBrandingAttributes object

Required: No

DeviceTypeOsx

The branding information to import for macOS devices.

Type: DefaultImportClientBrandingAttributes object

Required: No

DeviceTypeWeb

The branding information to import for web access.

Type: DefaultImportClientBrandingAttributes object

Required: No

DeviceTypeWindows

The branding information to import for Windows devices.

Type: DefaultImportClientBrandingAttributes object

Required: No

ResourceId

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

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"
   }
}