Table of Contents

Class HelpSettings

Namespace
Meraki.Api.Data
Assembly
Meraki.Api.dll

Settings for describing the modifications to various Help page features. Each property in this object accepts one of 'default or inherit' (do not modify functionality), 'hide' (remove the section from Dashboard), or 'show' (always show the section on Dashboard). Some properties in this object also accept custom HTML used to replace the section on Dashboard; see the documentation for each property to see the allowed values. Each property defaults to 'default or inherit' when not provided.

[DataContract]
public class HelpSettings
Inheritance
HelpSettings
Inherited Members

Properties

ApiDocsSubtab

Gets or Sets ApiDocsSubtab

[ApiAccess(ApiAccess.ReadWrite)]
[DataMember(Name = "apiDocsSubtab")]
public BrandingPolicyHelpSetting? ApiDocsSubtab { get; set; }

Property Value

BrandingPolicyHelpSetting?

Remarks

The 'Help -> API docs' subtab where a detailed description of the Dashboard API is listed. Can be one of 'default or inherit', 'hide' or 'show'.

CasesSubtab

Gets or Sets CasesSubtab

[ApiAccess(ApiAccess.ReadWrite)]
[DataMember(Name = "casesSubtab")]
public BrandingPolicyHelpSetting? CasesSubtab { get; set; }

Property Value

BrandingPolicyHelpSetting?

Remarks

The 'Help -> Cases' Dashboard subtab on which Cisco Meraki support cases for this organization can be managed. Can be one of 'default or inherit', 'hide' or 'show'.

CiscoMerakiProductDocumentation

The 'Product Manuals' section of the 'Help -> Get Help' subtab. Can be one of 'default or inherit', 'hide', 'show', or a replacement custom HTML string.

[ApiAccess(ApiAccess.ReadWrite)]
[DataMember(Name = "ciscoMerakiProductDocumentation")]
public string? CiscoMerakiProductDocumentation { get; set; }

Property Value

string

CommunitySubtab

Gets or Sets CommunitySubtab

[ApiAccess(ApiAccess.ReadWrite)]
[DataMember(Name = "communitySubtab")]
public BrandingPolicyHelpSetting? CommunitySubtab { get; set; }

Property Value

BrandingPolicyHelpSetting?

Remarks

The 'Help -> Community' subtab which provides a link to Meraki Community. Can be one of 'default or inherit', 'hide' or 'show'.

DataProtectionRequestsSubtab

Gets or Sets DataProtectionRequestsSubtab

[ApiAccess(ApiAccess.ReadWrite)]
[DataMember(Name = "dataProtectionRequestsSubtab")]
public BrandingPolicyHelpSetting? DataProtectionRequestsSubtab { get; set; }

Property Value

BrandingPolicyHelpSetting?

Remarks

The 'Help -> Data protection requests' Dashboard subtab on which requests to delete, restrict, or export end-user data can be audited. Can be one of 'default or inherit', 'hide' or 'show'.

FirewallInfoSubtab

Gets or Sets FirewallInfoSubtab

[ApiAccess(ApiAccess.ReadWrite)]
[DataMember(Name = "firewallInfoSubtab")]
public BrandingPolicyHelpSetting? FirewallInfoSubtab { get; set; }

Property Value

BrandingPolicyHelpSetting?

Remarks

The 'Help -> Firewall info' subtab where necessary upstream firewall rules for communication to the Cisco Meraki cloud are listed. Can be one of 'default or inherit', 'hide' or 'show'.

GetHelpSubtab

Gets or Sets GetHelpSubtab

[ApiAccess(ApiAccess.ReadWrite)]
[DataMember(Name = "getHelpSubtab")]
public BrandingPolicyHelpSetting? GetHelpSubtab { get; set; }

Property Value

BrandingPolicyHelpSetting?

Remarks

The 'Help -> Get Help' subtab on which Cisco Meraki KB, Product Manuals, and Support/Case Information are displayed. Note that if this subtab is hidden, branding customizations for the KB on 'Get help', Cisco Meraki product documentation, and support contact info will not be visible. Can be one of 'default or inherit', 'hide' or 'show'.

GetHelpSubtabKnowledgeBaseSearch

The KB search box which appears on the Help page. Can be one of 'default or inherit', 'hide', 'show', or a replacement custom HTML string.

[ApiAccess(ApiAccess.ReadWrite)]
[DataMember(Name = "getHelpSubtabKnowledgeBaseSearch")]
public string? GetHelpSubtabKnowledgeBaseSearch { get; set; }

Property Value

string

HardwareReplacementsSubtab

Gets or Sets HardwareReplacementsSubtab

[ApiAccess(ApiAccess.ReadWrite)]
[DataMember(Name = "hardwareReplacementsSubtab")]
public BrandingPolicyHelpSetting? HardwareReplacementsSubtab { get; set; }

Property Value

BrandingPolicyHelpSetting?

Remarks

The 'Help -> Replacement info' subtab where important information regarding device replacements is detailed. Can be one of 'default or inherit', 'hide' or 'show'.

HelpTab

Gets or Sets HelpTab

[ApiAccess(ApiAccess.ReadWrite)]
[DataMember(Name = "helpTab")]
public BrandingPolicyHelpSetting? HelpTab { get; set; }

Property Value

BrandingPolicyHelpSetting?

Remarks

The Help tab, under which all support information resides. If this tab is hidden, no other 'Help' branding customizations will be visible. Can be one of 'default or inherit', 'hide' or 'show'.

HelpWidget

Gets or Sets HelpWidget

[ApiAccess(ApiAccess.ReadWrite)]
[DataMember(Name = "helpWidget")]
public BrandingPolicyHelpSetting? HelpWidget { get; set; }

Property Value

BrandingPolicyHelpSetting?

Remarks

The 'Help Widget' is a support widget which provides access to live chat, documentation links, Sales contact info, and other contact avenues to reach Meraki Support.Can be one of 'default or inherit', 'hide' or 'show'.

NewFeaturesSubtab

Gets or Sets NewFeaturesSubtab

[ApiAccess(ApiAccess.ReadWrite)]
[DataMember(Name = "newFeaturesSubtab")]
public BrandingPolicyHelpSetting? NewFeaturesSubtab { get; set; }

Property Value

BrandingPolicyHelpSetting?

Remarks

The 'Help -> New features' subtab where new Dashboard features are detailed.Can be one of 'default or inherit', 'hide' or 'show'.

SmForums

Gets or Sets SmForums

[ApiAccess(ApiAccess.ReadWrite)]
[DataMember(Name = "smForums")]
public BrandingPolicyHelpSetting? SmForums { get; set; }

Property Value

BrandingPolicyHelpSetting?

Remarks

The 'SM Forums' subtab which links to community-based support for Cisco Meraki Systems Manager. Only configurable for organizations that contain Systems Manager networks. Can be one of 'default or inherit', 'hide' or 'show'.

SupportContactInfo

The 'Contact Meraki Support' section of the 'Help -> Get Help' subtab. Can be one of 'default or inherit', 'hide', 'show', or a replacement custom HTML string.

[ApiAccess(ApiAccess.ReadWrite)]
[DataMember(Name = "supportContactInfo")]
public string? SupportContactInfo { get; set; }

Property Value

string

UniversalSearchKnowledgeBaseSearch

Gets or Sets UniversalSearchKnowledgeBaseSearch

[ApiAccess(ApiAccess.ReadWrite)]
[DataMember(Name = "universalSearchKnowledgeBaseSearch")]
public BrandingPolicyHelpSetting? UniversalSearchKnowledgeBaseSearch { get; set; }

Property Value

BrandingPolicyHelpSetting?

Remarks

The universal search box always visible on Dashboard will, by default, present results from the Meraki KB. This configures whether these Meraki KB results should be returned. Can be one of 'default or inherit', 'hide' or 'show'.

Edit this page