vCloud Director 9.7 Portal Custom Branding

Much awaited feature for cloud provider to match thier corporate  standards and to create a fully custom cloud experience, now with release on vCloud Director 9.7 you can set the logo and the theme for your vCloud Director Service Provider Admin Portal and also now you can customize the vCloud Director Tenant Portal of each tenants . In addition, you can modify and add custom links to the two upper right menus in the vCloud Director provider and tenant portals.

Provider Portal Branding

vCloud Director 9.7 UI can be modified for the following elements:

  • Portal name
  • Portal color
  • Portal theme (vCloud Director contains two themes – default and dark.)
  • Logo & Browser icon

Customize Portal Name ,Portal Color and Portal Theme

To configure the Cloud Provider Portal Branding , make a PUT request to vCloud Director end point as below:

  • PUThttps://<vCD Url>/cloudapi/branding
  • BODY – {
    “portalName”: “string”,
    “portalColor”: “string”,
    “selectedTheme”: {
    “themeType”: “string”,
    “name”: “string”
    },
    “customLinks”: [
    {
    “name”: “string”,
    “menuItemType”: “link”,
    “url”: “string”
    }
    ]
    }
  • Headers
    • 2.png

Here is my API call using Postman client:

1.png

Customize Logo

To change the Logo, here is the procedure for API

  • Headers
    • 4.png
  • PUT
  • Body – This is bit tricky since we need to upload an image as a body.
    • In Postman client inside “Body” click on “Binary” which will allow you to choose file as body. select your logo.
    • 5.png

Customize Icon

To customize the icon, follow this API call and procedure.

  • Headers
    • 9.png
  • PUT
  • Body – same as above section , choose a image
    • 10.png

so after running above API calls , here is what my vCloud Director provider portal looks like.

678.png

Tenant Portal Branding

As we did above similarly we can now fully customize Tenant Portal

Customize Portal Name ,Portal Color and Portal Theme

To configure the Cloud Provider Portal Branding , make a PUT request to vCloud Director end point in to tenant organisation as below: ( T1 is my org Name)

  • PUThttps://<vCD Url>/cloudapi/branding/tenant/T1
  • BODY – {
    “portalName”: “string”,
    “portalColor”: “string”,
    “selectedTheme”: {
    “themeType”: “string”,
    “name”: “string”
    },
    “customLinks”: [
    {
    “name”: “string”,
    “menuItemType”: “link”,
    “url”: “string”
    }
    ]
    }
  • Headers
    • 11.png

Here is my API call using Postman client:

12.png

Customize Logo

To change the Logo, here is the procedure for API

  • Headers
    • 4.png
  • PUT
  • Body – As said above ,this is bit tricky since we need to upload an image as a body.
    • In Postman client inside “Body” click on “Binary” which will allow you to choose file as body, select your logo.
    • 14.png

Once i have done with above API calls, this is how my Tenant portal look like for “T1” organisation.

15.png

For a particular tenant, you can selectively override any combination of the portal name, background color, logo, icon, theme, and custom links. Any value that you do not set uses the corresponding system default value.

This completes feature walk through of Provider and Tenant custom branding options available now with vCD9.7.

Advertisements

6 thoughts on “vCloud Director 9.7 Portal Custom Branding

    1. follow this , https://pubs.vmware.com/vcd-80/index.jsp?topic=%2Fcom.vmware.vcloud.api.sp.doc_90%2FGUID-1CE15CDF-7858-4BE3-8474-505EE3B7BBA1.html

      Step -1
      Make an API versions request to retrieve the list of supported API versions and the login URL for each version.

      The request has this form:

      GET http://vcloud.example.com/api/versions
      You do not need to be authenticated to make a versions request.
      Step -2
      POST a request to the login URL, supplying your credentials in the request’s Authorization header.

      These requests have the following form:

      POST https://vcloud.example.com/api/sessions
      Authorization: auth-type credentials
      Accept: application/*;version=api-version
      The value of auth-type specifies the authentication protocol you are using. Each authentication protocol has its own requirements for credentials and other attributes.

      Step -3 (very importent step)
      Examine the response to retrieve the authorization token and links to objects that you have rights to access.

      A successful request returns a Session element, which includes an x-vcloud-authorization header. You must include the x-vcloud-authorization header in each subsequent vCloud API request.

      Like

  1. I am not able to customise my tenant portal using these steps are you able to let me know for which versions this works for? The API works to customise the tenant portals after you have logged in but at the login prompt it remains matching the provider portal.

    Like

    1. By default, no org-specific branding will be shown outside of a logged in session that means it would not appear on login and logout pages.
      if you wish to allow branding outside of logged in sessions, you can use the cell management tool to execute the following command:
      manage-config -n backend.branding.requireAuthForBranding -v false

      Like

  2. Just one comment about Header “Content-type”, when you try to change the logo per-tenant, you need to put only “image/png” without “;version=32” because you receipt the error message:

    “Refused to load the image ‘unsafe:data:image…’ because it violates the following Content Security Policy directive: “img-src * data: blow: ‘unsafe-inline'”.

    then you never see changes when you tried to put a logo per-tenant. So you change that to ‘image/png’ and everything will work fine.

    Regards

    Like

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s