organizationalBrandingProperties 资源类型
命名空间：microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。
一种抽象类型，用于公开用于配置组织品牌的属性。
组织可以自定义其Microsoft Entra登录页面，这些页面在用户登录到其组织的特定于租户的应用时显示，或者Microsoft Entra ID从其用户名标识用户的租户时显示。 开发人员还可以读取公司的品牌信息并自定义其应用体验，以使用公司品牌专门为已登录用户定制它。
无法更改 组织品牌 对象所表示的原始配置的语言。 但是，公司可以根据区域设置添加不同的品牌。 有关特定于语言的品牌打造，请参阅 organizationalBrandingLocalization 对象。
注意
添加自定义品牌需要为Office 365应用) 许可证Microsoft Entra ID P1 或 P2、Premium 2 或 Office 365 (。 有关许可和版本的详细信息，请参阅注册 Microsoft Entra ID P1 或 P2。
Microsoft Entra ID P1 或 P2 版本可供使用全球Microsoft Entra ID实例的中国客户使用。 Microsoft Entra ID世纪互联在中国运营的 Azure 服务中目前不支持 P1 或 P2 版本。 有关详细信息，请使用Microsoft Entra论坛与我们联系。
方法
无。
属性
| 属性 | 类型 | 说明 |
|---|---|---|
| backgroundColor | String | 在低带宽连接中代替背景图像显示的颜色。 建议使用横幅徽标或组织颜色的主要颜色。 以十六进制格式指定此项，例如，白色 为 #FFFFFF。 |
| backgroundImage | Stream | 显示为登录页背景的图像。 允许的类型为不小于 300 KB 且不大于 1920 × 1080 像素的 PNG 或 JPEG。 较小的映像可降低带宽要求，并加快页面加载速度。 |
| backgroundImageRelativeUrl | String | backgroundImage 属性的相对 URL，它与 cdnList 中的 CDN 基 URL 相结合，以提供 CDN 提供的版本。 此为只读属性。 |
| bannerLogo | Stream | 登录页上显示的公司徽标的横幅版本。 允许的类型为不大于 36 × 245 像素的 PNG 或 JPEG。 建议使用徽标周围没有填充的透明图像。 |
| bannerLogoRelativeUrl | String | bannerLogo 属性的相对 URL，它与 cdnList 中的 CDN 基 URL 相结合，以提供 CDN 提供的只读版本。 此为只读属性。 |
| cdnList | 字符串集合 | 为当前资源的资产提供服务的所有可用 CDN 提供程序的基 URL 列表。 同时使用多个 CDN 提供程序实现读取请求的高可用性。 此为只读属性。 |
| contentCustomization | contentCustomization | 表示要在整个租户身份验证流中自定义的内容选项。 注意：仅受客户租户Microsoft Entra ID支持。 |
| customAccountResetCredentialsUrl | String | 用于重置帐户凭据的自定义 URL。 此 URL 必须采用 ASCII 格式，或者非 ASCII 字符必须经过 URL 编码，且不超过 128 个字符。 |
| customCannotAccessYourAccountText | String | 一个字符串，用于替换登录页上的默认“无法访问帐户？”自助服务密码重置 (SSPR) 超链接文本。 此文本必须采用 Unicode 格式，且不超过 256 个字符。 |
| customCannotAccessYourAccountUrl | String | 用于替换自助密码重置的默认 URL 的自定义 URL， (SSPR) 登录页上的“无法访问你的帐户？”超链接。 此 URL 必须采用 ASCII 格式，或者非 ASCII 字符必须经过 URL 编码，且不超过 128 个字符。 请勿使用。 请改用 customAccountResetCredentialsUrl 。 |
| customCSS | Stream | 登录页上显示的 CSS 样式。 允许的格式仅为 .css 格式，不大于 25 KB。 |
| customCSSRelativeUrl | String | customCSS 属性的相对 URL，该属性与 cdnList 中的 CDN 基 URL 组合在一起，以提供 CDN 提供的版本。 此为只读属性。 |
| customForgotMyPasswordText | String | 用于替换登录表单上默认的“忘记密码”超链接文本的字符串。 此文本必须采用 Unicode 格式，且不超过 256 个字符。 |
| customPrivacyAndCookiesText | String | 用于替换页脚中默认的“隐私和 Cookie”超链接文本的字符串。 此文本必须采用 Unicode 格式，且不超过 256 个字符。 |
| customPrivacyAndCookiesUrl | String | 用于替换页脚中“隐私和 Cookie”超链接的默认 URL 的自定义 URL。 此 URL 必须采用 ASCII 格式，或者非 ASCII 字符必须经过 URL 编码，且不超过 128 个字符。 |
| customResetItNowText | String | 用于替换登录表单上默认的“立即重置”超链接文本的字符串。 此文本必须采用 Unicode 格式，且不超过 256 个字符。 请勿使用： 目前不支持自定义“立即重置”超链接文本。 |
| customTermsOfUseText | String | 用于替换页脚中默认的“使用条款”超链接文本的字符串。 此文本必须采用 Unicode 格式，且不超过 256 个字符。 |
| customTermsOfUseUrl | String | 用于替换页脚中“使用条款”超链接的默认 URL 的自定义 URL。 此 URL 必须采用 ASCII 格式，或者非 ASCII 字符必须经过 URL 编码，且不超过 128 个字符。 |
| favicon | Stream | 自定义图标 (favicon) 替换Microsoft Entra租户上的默认 Microsoft 产品 favicon。 |
| faviconRelativeUrl | String | 上述 favicon 的相对 URL，它与 cdnList 中的 CDN 基 URL 组合在一起，以提供 CDN 提供的版本。 此为只读属性。 |
| headerBackgroundColor | String | 要应用于自定义标头颜色的 RGB 颜色。 |
| headerLogo | Stream | 显示在登录页标题中的公司徽标。 允许的类型为不大于 36 × 245 像素的 PNG 或 JPEG。 建议使用徽标周围没有填充的透明图像。 |
| headerLogoRelativeUrl | String | headerLogo 属性的相对 URL，它与 cdnList 中的 CDN 基 URL 相结合，以提供 CDN 提供的只读版本。 只读。 |
| id | String | 一个标识符，表示使用区域性名称指定的区域设置。 区域性名称遵循 RFC 1766 标准，格式为“languagecode2-country/regioncode2”，其中“languagecode2”是派生自 ISO 639-1 的小写双字母代码，“country/regioncode2”是派生自 ISO 3166 的大写双字母代码。 例如，美国英语为 en-US。 默认 /branding 的 ID 始终为 String 类型 0 或 default。 此为只读属性。 注意： 目前不支持单个区域设置的多个品牌。 |
| loginPageLayoutConfiguration | loginPageLayoutConfiguration | 表示要显示在租户登录页上的布局配置。 |
| loginPageTextVisibilitySettings | loginPageTextVisibilitySettings | 表示可在租户的登录页上隐藏的各种文本。 |
| signInPageText | String | 登录框底部显示的文本。 使用它来传达其他信息，例如电话号码到技术支持或法律声明。 此文本必须采用 Unicode 格式，且不超过 1024 个字符。 |
| squareLogo | Stream | (OOBE) 以及启用 Windows Autopilot 进行部署时，Windows 10现成体验中显示的公司徽标的方形版本。 允许的类型为不大于 240 x 240 像素且大小不超过 10 KB 的 PNG 或 JPEG。 建议使用徽标周围没有填充的透明图像。 |
| squareLogoRelativeUrl | String | squareLogo 属性的相对 URL，它与 cdnList 中的 CDN 基 URL 组合在一起，以提供 CDN 提供的版本。 此为只读属性。 |
| squareLogoDark | Stream | (OOBE) 以及启用 Windows Autopilot 进行部署时，Windows 10现成体验中显示的公司徽标的方形深色版本。 允许的类型为不大于 240 x 240 像素且大小不超过 10 KB 的 PNG 或 JPEG。 建议使用徽标周围没有填充的透明图像。 |
| squareLogoDarkRelativeUrl | String | squareLogoDark 属性的相对 URL，与 cdnList 中的 CDN 基 URL 相结合，以提供 CDN 提供的版本。 此为只读属性。 |
| usernameHintText | String | 在登录屏幕的“用户名”文本框中显示为提示的字符串。 此文本必须是 Unicode，没有链接或代码，并且不能超过 64 个字符。 |
关系
无。
JSON 表示形式
以下 JSON 表示形式显示了资源类型。
{
"@odata.type": "#microsoft.graph.organizationalBrandingProperties",
"id": "String (identifier)",
"backgroundColor": "String",
"backgroundImage": "Stream",
"backgroundImageRelativeUrl": "String",
"bannerLogo": "Stream",
"bannerLogoRelativeUrl": "String",
"cdnList": [
"String"
],
"signInPageText": "String",
"squareLogo": "Stream",
"squareLogoRelativeUrl": "String",
"squareLogoDark": "Stream",
"squareLogoDarkRelativeUrl": "String",
"usernameHintText": "String",
"contentCustomization": {
"@odata.type": "microsoft.graph.contentCustomization"
},
"customAccountResetCredentialsUrl": "String",
"customCannotAccessYourAccountText": "String",
"customCannotAccessYourAccountUrl": "String",
"customCSS": "Stream",
"customCSSRelativeUrl": "String",
"customForgotMyPasswordText": "String",
"customPrivacyAndCookiesText": "String",
"customPrivacyAndCookiesUrl": "String",
"customResetItNowText": "String",
"customTermsOfUseText": "String",
"customTermsOfUseUrl": "String",
"favicon": "Stream",
"faviconRelativeUrl": "String",
"headerBackgroundColor": "String",
"headerLogo": "Stream",
"headerLogoRelativeUrl": "String",
"loginPageLayoutConfiguration": {
"@odata.type": "microsoft.graph.loginPageLayoutConfiguration"
},
"loginPageTextVisibilitySettings": {
"@odata.type": "microsoft.graph.loginPageTextVisibilitySettings"
}
}