BrandingSettingsType

Element:

BrandingSettings

Type:

BrandingSettingsType

Namespace:

http://www.vmware.com/vcloud/extension/v1.5

Description:

Information used to customize the vCloud Director Web console. Include provider-specific text and values.

Since:

1.5

Schema:

settings.xsd

Media type(s):

application/vnd.vmware.admin.brandingSettings+xml
application/vnd.vmware.admin.brandingSettings+json

Extends:

ResourceType

XML Representation:

<BrandingSettings xmlns="http://www.vmware.com/vcloud/extension/v1.5" xmlns:vcloud_v1.5="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string">
    <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string"/>
    <CompanyName> xs:string </CompanyName>
    <LoginPageCustomizationTheme> xs:hexBinary </LoginPageCustomizationTheme>
    <PreviewCustomTheme> xs:hexBinary </PreviewCustomTheme>
    <FinalCustomTheme> xs:hexBinary </FinalCustomTheme>
    <AboutCompanyUrl> xs:string </AboutCompanyUrl>
    <SupportUrl> xs:string </SupportUrl>
    <SignUpUrl> xs:string </SignUpUrl>
    <ForgotUserNameOrPasswordURL> xs:string </ForgotUserNameOrPasswordURL>
</BrandingSettings>

Attributes

Attribute	Type	Required	Modifiable	Since	Deprecated	Description
href	anyURI	No	always	1.5		The URI of the entity.
type	string	No	always	1.5		The MIME type of the entity.

Elements

Element	Type	Required	Modifiable	Since	Deprecated	Description
AboutCompanyUrl	string	No	always	1.5		A URL to a site that provides additional information about your company.
CompanyName	string	Yes	always	1.5		Text to display in the vCloud Director Web console header and footer.
FinalCustomTheme	hexBinary	No	always	5.1		The online help provides information on how you can customize the vCloud Director Web console theme.
ForgotUserNameOrPasswordURL	string	No	always	1.5		A URL to a site that allows a user of your company's vCloud Director service to recover a forgotten user name or password. This URL will be used for the Forgot Password link on the vCloud Director Web console Login page.
Link	LinkType	No	none	1.5		A reference to an entity or operation associated with this object.
LoginPageCustomizationTheme	hexBinary	No	always	5.1		Allows setting a login page custom theme. See the online help for more information.
PreviewCustomTheme	hexBinary	No	always	5.1		Allows setting a custom theme. See the online help for more information.
SignUpUrl	string	No	always	1.5		A URL to a site that allows a user to sign up for vCloud Director services provided by your company. This URL will be used for the Sign Up link on the vCloud Director Web console Login page.
SupportUrl	string	No	always	1.5		A URL to a site that provides support information from your company. This URL will be used for the Support link in the the vCloud Director Web console Help menu.
VCloudExtension	VCloudExtensionType	No	always	1.5		An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.

Operations

CRUD	Operation	Description	Since	Deprecated
read	GET /admin/extension/settings/branding	Retrieve system branding settings.	1.5
as input	PUT /admin/extension/settings/branding	Update system branding settings.	1.5