afv-library/skills/getting-metadata-api-context/data/metadata_api/NetworkBranding.json

{
  "sections": [
    "title",
    "description",
    "file_information",
    "directory_location",
    "fields",
    "wsdl_segment",
    "declarative_metadata_sample_definition"
  ],
  "title": "NetworkBranding - Metadata API",
  "description": "Represents the branding and color scheme applied to the login pages of an Experience Cloud site. (Experience Cloud sites are represented by the Network component.)",
  "file_information": ".networkBranding",
  "directory_location": "networkBranding",
  "fields_columns": [
    "type",
    "description"
  ],
  "fields": {
    "loginBackgroundImageUrl": {
      "type": "string",
      "description": "The path to the image URL that appears as the background on the Experience Cloud site’s login page. This URL can be fixed, dynamic, or an uploaded image. A dynamic URL contains the experience ID parameter, {expid}, and is resolved dynamically at runtime."
    },
    "loginFooterText": {
      "type": "string",
      "description": "The text that appears in the footer of the Experience Cloud site login page."
    },
    "loginLogo": {
      "type": "string",
      "description": "The logo that appears on the Experience Cloud site login page for external users."
    },
    "loginLogoName": {
      "type": "string",
      "description": "The name of the logo that appears on the Experience Cloud site login page for external users."
    },
    "loginPrimaryColor": {
      "type": "string",
      "description": "The background color of the Login button. Available in API version 42.0 and later."
    },
    "loginQuaternaryColor": {
      "type": "string",
      "description": "The background color for the Experience Cloud site’s login page."
    },
    "loginRightFrameUrl": {
      "type": "string",
      "description": "The path to the content of the right frame of the Experience Cloud site login page. This URL can be either fixed or dynamic. A dynamic URL contains the experience ID parameter, {expid}. If the URL contains {expid}, the URL is resolved dynamically at runtime depending on the parameter's value."
    },
    "network": {
      "type": "string",
      "description": "The name of the Experience Cloud site associated with the branding."
    },
    "pageFooter": {
      "type": "string",
      "description": "An image that appears on the footer of the Experience Cloud site pages. Must be an.html file."
    },
    "pageHeader": {
      "type": "string",
      "description": "An image that appears on the header of the Experience Cloud site pages. Can be an.html,.gif,.jpg, or.png file."
    },
    "primaryColor": {
      "type": "string",
      "description": "The color used for the active tab.",
      "required": true
    },
    "primaryComplementColor": {
      "type": "string",
      "description": "Font color used with primaryColor.",
      "required": true
    },
    "quaternaryColor": {
      "type": "string",
      "description": "The background color for pages in the Experience Cloud site.",
      "required": true
    },
    "quaternaryComplementColor": {
      "type": "string",
      "description": "Font color used with quaternaryColor.",
      "required": true
    },
    "secondaryColor": {
      "type": "string",
      "description": "The color used for the top borders of lists and tables.",
      "required": true
    },
    "staticLogoImageUrl": {
      "type": "string",
      "description": "The path to the logo that appears on the Experience Cloud site’s login page. This URL can be fixed, dynamic, or an uploaded image. A dynamic URL contains the experience ID parameter, {expid}. If the URL contains {expid}, the URL is resolved dynamically at runtime depending on the parameter's value."
    },
    "tertiaryColor": {
      "type": "string",
      "description": "The background color for section headers on edit and detail pages.",
      "required": true
    },
    "tertiaryComplementColor": {
      "type": "string",
      "description": "Font color used with tertiaryColor.",
      "required": true
    },
    "zeronaryColor": {
      "type": "string",
      "description": "The background color for the header.",
      "required": true
    },
    "zeronaryComplementColor": {
      "type": "string",
      "description": "Font color used with zeronaryColor.",
      "required": true
    }
  },
  "wsdl_segment": "```xml\n<xsd:complexType name=\"Metadata\">\n  <xsd:sequence>\n    <xsd:element name=\"fullName\" minOccurs=\"0\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"MetadataWithContent\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"content\" minOccurs=\"0\" type=\"xsd:base64Binary\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"NetworkBranding\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:MetadataWithContent\">\n      <xsd:sequence>\n        <xsd:element name=\"loginBackgroundImageUrl\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"loginFooterText\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"loginLogo\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"loginLogoName\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"loginPrimaryColor\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"loginQuaternaryColor\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"loginRightFrameUrl\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"network\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"pageFooter\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"pageHeader\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"primaryColor\" type=\"xsd:string\"/>\n        <xsd:element name=\"primaryComplementColor\" type=\"xsd:string\"/>\n        <xsd:element name=\"quaternaryColor\" type=\"xsd:string\"/>\n        <xsd:element name=\"quaternaryComplementColor\" type=\"xsd:string\"/>\n        <xsd:element name=\"secondaryColor\" type=\"xsd:string\"/>\n        <xsd:element name=\"staticLogoImageUrl\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"tertiaryColor\" type=\"xsd:string\"/>\n        <xsd:element name=\"tertiaryComplementColor\" type=\"xsd:string\"/>\n        <xsd:element name=\"zeronaryColor\" type=\"xsd:string\"/>\n        <xsd:element name=\"zeronaryComplementColor\" type=\"xsd:string\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n```",
  "declarative_metadata_sample_definition": [
    {
      "description": "A sample XML definition of network branding.",
      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<NetworkBranding xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n    <loginFooterText>salesforce.com</loginFooterText>\n    <loginLogo>Communities_Shared_Document_Folder/header2_png.png</loginLogo>\n    <loginLogoName>header2.png</loginLogoName>\n    <loginBackgroundImageUrl>http://identitycms.herokuapp.com/promo-background.jpg</loginBackgroundImageUrl>\n    <loginQuaternaryColor>#B1BAC1</loginQuaternaryColor>\n    <loginRightFrameUrl>https://www.example.com/test</loginRightFrameUrl>\n    <network>Network 1</network>\n    <pageFooter>Branding/footer_html.html</pageFooter>\n    <pageHeader>Branding/header_Image.jpg</pageHeader>\n    <primaryColor>#AF5800</primaryColor>\n    <primaryComplementColor>#FFFFFF</primaryComplementColor>\n    <quaternaryColor>#286FB8</quaternaryColor>\n    <quaternaryComplementColor>#FFFFFF</quaternaryComplementColor>\n    <secondaryColor>#000000</secondaryColor>\n    <tertiaryColor>#FFFFFF</tertiaryColor>\n    <tertiaryComplementColor>#222222</tertiaryComplementColor>\n    <zeronaryColor>#0A3764</zeronaryColor>\n    <zeronaryComplementColor>#FFFFFF</zeronaryComplementColor>\n</NetworkBranding>"
    }
  ]
}