New command: spo brandcenter colors list

[mkm17]

Usage

spo brandcenter colors list

Description

Lists the brand center colors

Options

None

Examples

List all brand center colors

m365 spo brandcenter colors list

Default properties

ColorCode
Title
IsVisible

Additional Info

As I noticed, the brand colors are stored in a SharePoint list in the Brand Center.
We can get all the information about the Brand Center site and the colors list ID using the same approach as in the spo brandcenter settings list.

I also noticed that the following call is used to ensure that the list exists:
https://tenant.sharepoint.com/sites/brandcenter/_api/BrandCenter/EnsureBrandColorsListFeature

The list contains three columns that we can use as output: Data__SPColorTitle, OData__SPColorCode, and OData__SPColorVisible.

Is it worth creating a full set of commands such as add and edit (since editing is essentially just modifying list items)?
Maybe this feature should simply be an extension of spo brandcenter settings list?

Let me know what you think.

[mkm17]

When accepted as a command, can be part of #6652

[Jwaegebaert]

@mkm17 the specs look clear to me. One small suggestion though: we might want to add a safeguard.

If the colors list doesn't exist yet, we should simply return an empty array. We could technically call the ensure endpoint, but this command shouldn’t create the list. If it’s not there yet, it likely just means no colors have been defined in the Brand Center, so returning an empty result makes the most sense.

If we want to support adding or updating colors later, we can introduce dedicated commands for that. Those would fit better as their own commands rather than under the settings group.