Method: moduleSettings.rebrandingSettings

Full name: projects.locations.instances.moduleSettings.rebrandingSettings

The method returns the rebranding settings. E.g. company logo, icon, etc.

HTTP request


Path parameters

Parameters
parent

string

Required. The parent resource where the module settings are located. Format: projects/{project}/locations/{location}/instances/{instance}/moduleSettings/{module}

Request body

The request body must be empty.

Response body

Response message for rebrandingSettings.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "imageBase64": string,
  "faviconBase64": string,
  "changeFavicon": boolean,
  "useInLoginScreen": boolean,
  "useInHeader": boolean
}
Fields
imageBase64

string

Optional. The base64 encoded image of the company logo.
faviconBase64

string

Optional. The base64 encoded image of the company favicon.
changeFavicon

boolean

Whether to change the favicon.
useInLoginScreen

boolean

Whether to use the company logo in the login screen.
useInHeader

boolean

Whether to use the company logo in the header.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • chronicle.moduleSettings.rebranding

For more information, see the IAM documentation.