Get Organization Branding Policy - Meraki Dashboard API v1 - Cisco Meraki Developer Hub

{"type":"api","title":"Get Organization Branding Policy","meta":{"id":"/apps/pubhub/media/Meraki-Dashboard-API-v1-Documentation/4a73587b50c21afbda73cffb32f23c0279bf8383/5c63a5d4-9452-397a-85eb-8b6fec45147e","info":{"title":"Meraki Dashboard API","description":"A RESTful API to programmatically manage and monitor Cisco Meraki networks at scale.\n\n\u003e Date: 04 December, 2024\n\u003e\n\u003e [Recent Updates](https://meraki.io/whats-new/)\n\n---\n\n[API Documentation](https://meraki.io/api)\n\n[Community Support](https://meraki.io/community)\n\n[Meraki Homepage](https://www.meraki.com)\n","contact":{"name":"Meraki Developer Community","url":"https://meraki.io/community"},"version":"1.53.0"},"security":[{"meraki_api_key":[]},{"bearerAuth":[]}],"tags":[{"name":"organizations"},{"name":"networks"},{"name":"devices"},{"name":"insight"},{"name":"wireless"},{"name":"camera"},{"name":"appliance"},{"name":"switch"},{"name":"cellularGateway"},{"name":"sm"},{"name":"sensor"},{"name":"administered"},{"name":"wirelessController"},{"name":"accessControlLists"},{"name":"accessPolicies"},{"name":"accounts"},{"name":"acls"},{"name":"actionBatches"},{"name":"adaptivePolicy"},{"name":"addresses"},{"name":"admins"},{"name":"airMarshal"},{"name":"alertTypes"},{"name":"alerts"},{"name":"alternateManagementInterface"},{"name":"analytics"},{"name":"api"},{"name":"apiRequests"},{"name":"apnsCert"},{"name":"appliances"},{"name":"applicationCategories"},{"name":"applicationUsage"},{"name":"applications"},{"name":"areas"},{"name":"arpInspection"},{"name":"arpTable"},{"name":"artifacts"},{"name":"assets"},{"name":"assignments"},{"name":"authenticationToken"},{"name":"autoLocate"},{"name":"autoRf"},{"name":"availabilities"},{"name":"bandwidthUsageHistory"},{"name":"bgp"},{"name":"billing"},{"name":"blink"},{"name":"bluetooth"},{"name":"bluetoothClients"},{"name":"bonjourForwarding"},{"name":"boundaries"},{"name":"brandingPolicies"},{"name":"bulk"},{"name":"bulkUpdate"},{"name":"byBoundary"},{"name":"byClient"},{"name":"byDevice"},{"name":"byEnergyUsage"},{"name":"byInterval"},{"name":"byMetric"},{"name":"byModel"},{"name":"byNetwork"},{"name":"byStatus"},{"name":"bySwitch"},{"name":"byType"},{"name":"byUsage"},{"name":"byUtilization"},{"name":"bypassActivationLockAttempts"},{"name":"cableTest"},{"name":"callbacks"},{"name":"categories"},{"name":"cellular"},{"name":"cellularFirewallRules"},{"name":"cellularUsageHistory"},{"name":"certs"},{"name":"changeHistory"},{"name":"channelUtilization"},{"name":"channelUtilizationHistory"},{"name":"channels"},{"name":"claim"},{"name":"claimKey"},{"name":"clientCountHistory"},{"name":"clients"},{"name":"cloudMonitoring"},{"name":"commands"},{"name":"communicationPlans"},{"name":"compliance"},{"name":"configTemplates"},{"name":"configurationChanges"},{"name":"configure"},{"name":"configuredDevices"},{"name":"connectionStats"},{"name":"connections"},{"name":"connectivity"},{"name":"connectivityEvents"},{"name":"connectivityMonitoringDestinations"},{"name":"contentFiltering"},{"name":"coterm"},{"name":"current"},{"name":"customAnalytics"},{"name":"customPerformanceClasses"},{"name":"dataRateHistory"},{"name":"delegated"},{"name":"desktopLogs"},{"name":"details"},{"name":"detections"},{"name":"deviceCommandLogs"},{"name":"deviceProfiles"},{"name":"deviceTypeGroupPolicies"},{"name":"dhcp"},{"name":"dhcpServerPolicy"},{"name":"discovery"},{"name":"dscpTaggingOptions"},{"name":"dscpToCosMappings"},{"name":"eapOverride"},{"name":"earlyAccess"},{"name":"electronicShelfLabel"},{"name":"entitlements"},{"name":"esims"},{"name":"ethernet"},{"name":"eventTypes"},{"name":"events"},{"name":"exportEvents"},{"name":"failedConnections"},{"name":"failover"},{"name":"features"},{"name":"fields"},{"name":"firewall"},{"name":"firewalledServices"},{"name":"firmware"},{"name":"firmwareUpgrades"},{"name":"floorPlans"},{"name":"groupPolicies"},{"name":"groups"},{"name":"health"},{"name":"healthByTime"},{"name":"historical"},{"name":"history"},{"name":"hotspot20"},{"name":"httpServers"},{"name":"identities"},{"name":"identityPsks"},{"name":"idps"},{"name":"imports"},{"name":"inboundCellularFirewallRules"},{"name":"inboundFirewallRules"},{"name":"interfaces"},{"name":"internetPolicies"},{"name":"intrusion"},{"name":"inventory"},{"name":"ipv6"},{"name":"jobs"},{"name":"keys"},{"name":"l2"},{"name":"l3"},{"name":"l3FirewallRules"},{"name":"l7FirewallRules"},{"name":"lan"},{"name":"latencyHistory"},{"name":"latencyStats"},{"name":"latest"},{"name":"leds"},{"name":"licenses"},{"name":"licensing"},{"name":"lines"},{"name":"linkAggregations"},{"name":"linkLayer"},{"name":"live"},{"name":"liveTools"},{"name":"lldpCdp"},{"name":"loginSecurity"},{"name":"logs"},{"name":"lossAndLatencyHistory"},{"name":"malware"},{"name":"managementInterface"},{"name":"manufacturers"},{"name":"me"},{"name":"merakiAuthUsers"},{"name":"meshStatuses"},{"name":"models"},{"name":"monitor"},{"name":"monitoredMediaServers"},{"name":"mqttBrokers"},{"name":"mtu"},{"name":"multicast"},{"name":"netflow"},{"name":"networkAdapters"},{"name":"networkHealth"},{"name":"objectDetectionModels"},{"name":"onboarding"},{"name":"oneToManyNatRules"},{"name":"oneToOneNatRules"},{"name":"openapiSpec"},{"name":"optIns"},{"name":"order"},{"name":"ospf"},{"name":"overview"},{"name":"packetLoss"},{"name":"packets"},{"name":"payloadTemplates"},{"name":"performance"},{"name":"performanceHistory"},{"name":"permissions"},{"name":"pii"},{"name":"piiKeys"},{"name":"ping"},{"name":"pingDevice"},{"name":"policies"},{"name":"policy"},{"name":"policyObjects"},{"name":"portForwardingRules"},{"name":"portSchedules"},{"name":"ports"},{"name":"power"},{"name":"powerModules"},{"name":"prefixes"},{"name":"prepare"},{"name":"priorities"},{"name":"profiles"},{"name":"provisioning"},{"name":"qosRules"},{"name":"qualityAndRetention"},{"name":"qualityRetentionProfiles"},{"name":"radio"},{"name":"ratePlans"},{"name":"readings"},{"name":"recent"},{"name":"redundancy"},{"name":"relationships"},{"name":"rendezvousPoints"},{"name":"requests"},{"name":"responseCodes"},{"name":"restrictions"},{"name":"rfProfiles"},{"name":"roles"},{"name":"rollbacks"},{"name":"routing"},{"name":"rules"},{"name":"saml"},{"name":"samlRoles"},{"name":"schedules"},{"name":"sdwan"},{"name":"search"},{"name":"security"},{"name":"securityCenters"},{"name":"seen"},{"name":"sense"},{"name":"sentry"},{"name":"servers"},{"name":"serviceProviders"},{"name":"settings"},{"name":"signalQualityHistory"},{"name":"sims"},{"name":"singleLan"},{"name":"siteToSiteVpn"},{"name":"smDevicesForKey"},{"name":"smOwnersForKey"},{"name":"snmp"},{"name":"softwares"},{"name":"splash"},{"name":"splashAuthorizationStatus"},{"name":"splashLoginAttempts"},{"name":"ssids"},{"name":"stacks"},{"name":"staged"},{"name":"stages"},{"name":"staticRoutes"},{"name":"statics"},{"name":"stats"},{"name":"status"},{"name":"statuses"},{"name":"stormControl"},{"name":"stp"},{"name":"subnetPool"},{"name":"subnets"},{"name":"subscription"},{"name":"subscriptions"},{"name":"summary"},{"name":"swap"},{"name":"swaps"},{"name":"switches"},{"name":"syslogServers"},{"name":"system"},{"name":"targetGroups"},{"name":"themes"},{"name":"thirdPartyVPNPeers"},{"name":"throughputTest"},{"name":"top"},{"name":"topology"},{"name":"traffic"},{"name":"trafficAnalysis"},{"name":"trafficHistory"},{"name":"trafficShaping"},{"name":"trustedAccessConfigs"},{"name":"trustedServers"},{"name":"upgrades"},{"name":"uplink"},{"name":"uplinkBandwidth"},{"name":"uplinkSelection"},{"name":"uplinks"},{"name":"uplinksLossAndLatency"},{"name":"usage"},{"name":"usageHistories"},{"name":"usageHistory"},{"name":"userAccessDevices"},{"name":"utilization"},{"name":"v4"},{"name":"video"},{"name":"videoLink"},{"name":"vlanAssignments"},{"name":"vlanProfiles"},{"name":"vlans"},{"name":"vmx"},{"name":"vpn"},{"name":"vpnExclusions"},{"name":"vpnFirewallRules"},{"name":"vppAccounts"},{"name":"wakeOnLan"},{"name":"warmSpare"},{"name":"warnings"},{"name":"webhookTests"},{"name":"webhooks"},{"name":"wirelessControllers"},{"name":"wirelessProfiles"},{"name":"wlanLists"},{"name":"zones"}],"x-parser-conf":{"overview":{"markdownPath":"docs/overview.md"},"theme":"meraki","serverConfig":true,"meta":{"useProxy":true},"httpBearer":{"bearerToken":"75dd5334bef4d2bc96f26138c163c0a3fa0b5ca6"},"labelConfig":{"endpoint":{"field":"operationId","format":"startCase"}},"groupBy":{"$remoteModule":"config/group_platform.js"},"sortBy":{"$remoteModule":"config/sort_by.js"},"exampleAsDefault":true,"expand":3,"sampleCode":{"python":{"folder":"meraki/sdk/python","name":"Meraki Python Library","highlight":"python"}},"variables":{"organizationId":"1215707","networkId":"N_784752235069315754","serial":"QBSB-VQ3J-XZ54"}},"openapi":"3.0.1","servers":[{"url":"https://api.meraki.com/{basePath}","variables":{"basePath":{"default":"api/v1"}}}],"securitySchemes":{"meraki_api_key":{"type":"apiKey","name":"X-Cisco-Meraki-API-Key","in":"header"},"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Key"}}},"spec":{"description":"Return a branding policy","operationId":"getOrganizationBrandingPolicy","parameters":[{"name":"organizationId","in":"path","description":"Organization ID","schema":{"type":"string"},"required":true},{"name":"brandingPolicyId","in":"path","description":"Branding policy ID","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the Dashboard branding policy."},"enabled":{"type":"boolean","description":"Boolean indicating whether this policy is enabled."},"adminSettings":{"type":"object","properties":{"appliesTo":{"type":"string","enum":["All SAML admins","All admins","All admins of networks tagged...","All admins of networks...","All enterprise admins","All network admins","All organization admins","Specific admins..."],"description":"Which kinds of admins this policy applies to. Can be one of 'All organization admins', 'All enterprise admins', 'All network admins', 'All admins of networks...', 'All admins of networks tagged...', 'Specific admins...', 'All admins' or 'All SAML admins'."},"values":{"type":"array","items":{"type":"string"},"description":" If 'appliesTo' is set to one of 'Specific admins...', 'All admins of networks...' or 'All admins of networks tagged...', then you must specify this 'values' property to provide the set of\n entities to apply the branding policy to. For 'Specific admins...', specify an array of admin IDs. For 'All admins of\n networks...', specify an array of network IDs and/or configuration template IDs. For 'All admins of networks tagged...',\n specify an array of tag names.\n"}},"description":"Settings for describing which kinds of admins this policy applies to."},"helpSettings":{"type":"object","properties":{"helpTab":{"type":"string","enum":["default or inherit","hide","show"],"description":" The Help tab, under which all support information resides. If this tab is hidden, no other 'Help' branding\n customizations will be visible. Can be one of 'default or inherit', 'hide' or 'show'.\n"},"getHelpSubtab":{"type":"string","enum":["default or inherit","hide","show"],"description":" The 'Help -\u003e Get Help' subtab on which Cisco Meraki KB, Product Manuals, and Support/Case Information are displayed. Note\n that if this subtab is hidden, branding customizations for the KB on 'Get help', Cisco Meraki product documentation,\n and support contact info will not be visible. Can be one of 'default or inherit', 'hide' or 'show'.\n"},"communitySubtab":{"type":"string","enum":["default or inherit","hide","show"],"description":" The 'Help -\u003e Community' subtab which provides a link to Meraki Community. Can be one of 'default or inherit', 'hide' or 'show'.\n"},"casesSubtab":{"type":"string","enum":["default or inherit","hide","show"],"description":" The 'Help -\u003e Cases' Dashboard subtab on which Cisco Meraki support cases for this organization can be managed. Can be one\n of 'default or inherit', 'hide' or 'show'.\n"},"dataProtectionRequestsSubtab":{"type":"string","enum":["default or inherit","hide","show"],"description":" The 'Help -\u003e Data protection requests' Dashboard subtab on which requests to delete, restrict, or export end-user data can\n be audited. Can be one of 'default or inherit', 'hide' or 'show'.\n"},"getHelpSubtabKnowledgeBaseSearch":{"type":"string","description":" 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.\n"},"universalSearchKnowledgeBaseSearch":{"type":"string","enum":["default or inherit","hide","show"],"description":" The universal search box always visible on Dashboard will, by default, present results from the Meraki KB. This configures\n whether these Meraki KB results should be returned. Can be one of 'default or inherit', 'hide' or 'show'.\n"},"ciscoMerakiProductDocumentation":{"type":"string","description":" The 'Product Manuals' section of the 'Help -\u003e Get Help' subtab. Can be one of 'default or inherit', 'hide', 'show', or a replacement custom HTML string.\n"},"supportContactInfo":{"type":"string","description":" The 'Contact Meraki Support' section of the 'Help -\u003e Get Help' subtab. Can be one of 'default or inherit', 'hide', 'show', or a replacement custom HTML string.\n"},"newFeaturesSubtab":{"type":"string","enum":["default or inherit","hide","show"],"description":" The 'Help -\u003e New features' subtab where new Dashboard features are detailed. Can be one of 'default or inherit', 'hide' or 'show'.\n"},"firewallInfoSubtab":{"type":"string","enum":["default or inherit","hide","show"],"description":" The 'Help -\u003e Firewall info' subtab where necessary upstream firewall rules for communication to the Cisco Meraki cloud are\n listed. Can be one of 'default or inherit', 'hide' or 'show'.\n"},"apiDocsSubtab":{"type":"string","enum":["default or inherit","hide","show"],"description":" The 'Help -\u003e API docs' subtab where a detailed description of the Dashboard API is listed. Can be one of\n 'default or inherit', 'hide' or 'show'.\n"},"hardwareReplacementsSubtab":{"type":"string","enum":["default or inherit","hide","show"],"description":" The 'Help -\u003e Replacement info' subtab where important information regarding device replacements is detailed. Can be one of\n 'default or inherit', 'hide' or 'show'.\n"},"smForums":{"type":"string","enum":["default or inherit","hide","show"],"description":" The 'SM Forums' subtab which links to community-based support for Cisco Meraki Systems Manager. Only configurable for\n organizations that contain Systems Manager networks. Can be one of 'default or inherit', 'hide' or 'show'.\n"},"helpWidget":{"type":"string","enum":["default or inherit","hide","show"],"description":" The 'Help Widget' is a support widget which provides access to live chat, documentation links, Sales contact info,\n and other contact avenues to reach Meraki Support. Can be one of 'default or inherit', 'hide' or 'show'.\n"}},"description":" Settings for describing the modifications to various Help page features. Each property in this object accepts one of\n 'default or inherit' (do not modify functionality), 'hide' (remove the section from Dashboard), or 'show' (always show\n the section on Dashboard). Some properties in this object also accept custom HTML used to replace the section on\n Dashboard; see the documentation for each property to see the allowed values.\n"},"customLogo":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether or not there is a custom logo enabled."},"image":{"type":"object","properties":{"preview":{"type":"object","properties":{"url":{"type":"string","description":"Url of the preview image"},"expiresAt":{"type":"string","format":"date-time","description":"Timestamp of the preview image"}},"description":"Preview of the image"}},"description":"Properties of the image."}},"description":"Properties describing the custom logo attached to the branding policy."}}},"example":{"name":"My Branding Policy","enabled":true,"adminSettings":{"appliesTo":"All admins of networks...","values":["N_1234","L_5678"]},"helpSettings":{"helpTab":"show","getHelpSubtab":"default or inherit","communitySubtab":"show","casesSubtab":"hide","dataProtectionRequestsSubtab":"default or inherit","getHelpSubtabKnowledgeBaseSearch":"\u003ch1\u003eSome custom HTML content\u003c/h1\u003e","universalSearchKnowledgeBaseSearch":"hide","ciscoMerakiProductDocumentation":"show","supportContactInfo":"show","newFeaturesSubtab":"show","firewallInfoSubtab":"hide","apiDocsSubtab":"default or inherit","hardwareReplacementsSubtab":"hide","smForums":"hide","helpWidget":"hide"},"customLogo":{"enabled":true,"image":{"preview":{"url":"https://meraki-na.s3.amazonaws.com/org-assets/my-image.png","expiresAt":"2022-04-06T06:19:27-07:00"}}}}}}}},"summary":"Return a branding policy","tags":["organizations","configure","brandingPolicies"],"__originalOperationId":"getOrganizationBrandingPolicy","security":[{"meraki_api_key":[]},{"bearerAuth":[]}],"method":"get","path":"/organizations/{organizationId}/brandingPolicies/{brandingPolicyId}","sampleCode":{"Meraki Python Library":{"code":"import meraki\n\n# Defining your API key as a variable in source code is discouraged.\n# This API key is for a read-only docs-specific environment.\n# In your own code, use an environment variable as shown under the Usage section\n# @ https://github.com/meraki/dashboard-api-python/\n\nAPI_KEY = '75dd5334bef4d2bc96f26138c163c0a3fa0b5ca6'\n\ndashboard = meraki.DashboardAPI(API_KEY)\n\norganization_id = '549236'\nbranding_policy_id = ''\n\nresponse = dashboard.organizations.getOrganizationBrandingPolicy(\n organization_id, branding_policy_id\n)\n\nprint(response)","highlight":"python"}}}}