vRealize Automation Branding Service API

Branding Service

This document describes how to use the Branding Service REST API.

What Is the Branding Service?

The Branding service enables the user to customize the VRA UI header and footer. The configurable properties include logo image, company name, product name, background color, text color, copyright notice, privacy policy link, and contact link.

There are three levels of branding configuration -- default, system, and tenant. The default branding is used when no system or tenant branding object has been created and enabled.

The system administrator or tenant administrator can create system-level and tenant-level brandings. The effective branding is the branding that the user sees, and it is determined according the following precedence: tenant, system, default.

Typical Use Cases

You can use the Branding REST API to:

  • Create/update/delete a branding object.

  • Retrieve the default branding object.

  • Retrieve the system-level branding object as a system administrator.

  • Retrieve a tenant-level branding object as a tenant administrator.

  • Retrieve the effective branding object for a user.

Key Concepts

Branding object

An object that encapsulate all the branding properties, such as logo image, company name, product name, background color, text color, copyright notice, privacy policy link, and contact link.

Default Branding

The factory default branding object. This branding is used if neither system branding nor tenant branding is enabled.

System Branding

The system-level branding object. This branding is used when tenant branding is not enabled.

Tenant Branding

The tenant-level branding object. This branding is used if it is enabled.

 

Related Documentation

Related Sample Code

  • vRealize Automation - Branding

    Contributor VMware

    vRealize Automation - Branding The Branding service enables the user to customize the VRA UI header and footer. The configurable properties include logo image, company name, product name, background c ...
    api_vra_branding vRealize Automation POSTMAN Collection
    Download

    0 Comments

    Updated 6 months ago

;