Update organizationalBranding

项目
04/05/2024

命名空间：microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。不支持在生产应用程序中使用这些 API。若要确定 API 是否在 v1.0 中可用，请使用版本选择器。

更新由组织品牌资源指定的默认品牌对象的属性。

全局服务	美国政府 L4	美国政府 L5 (DOD)	由世纪互联运营的中国
✅	✅	✅	✅

权限

为此 API 选择标记为最低特权的权限。只有在应用需要它时，才使用更高的特权权限。有关委派权限和应用程序权限的详细信息，请参阅权限类型。要了解有关这些权限的详细信息，请参阅权限参考。

权限类型	最低特权权限	更高特权权限
委派（工作或学校帐户）	OrganizationalBranding.ReadWrite.All	Organization.ReadWrite.All
委派（个人 Microsoft 帐户）	不支持。	不支持。
应用程序	OrganizationalBranding.ReadWrite.All	Organization.ReadWrite.All

重要

在具有工作或学校帐户的委托方案中，必须为登录用户分配受支持的Microsoft Entra角色或具有支持的角色权限的自定义角色。 组织品牌管理员 是此操作支持的最低特权角色。

HTTP 请求

若要更新 String 数据类型（如 signInPageText 和 usernameHintText），请使用 PATCH 方法。若要更新Stream数据类型（如 backgroundLogo 和 backgroundImage），请使用 PUT 方法。不能在同一请求中使用其他数据类型更新Stream类型。

PATCH /organization/{organizationId}/branding
PUT /organization/{organizationId}/branding/localizations/{organizationalBrandingLocalizationId}/{Stream object type such as backgroundImage}

请求标头

名称	说明
Authorization	持有者 {token}。必填。详细了解身份验证和授权。
Content-Type	application/json. 必需。
Accept-Language	有效的 ISO 639-1 区域设置或 `0` 默认区域设置。必填。

请求正文

在请求正文中，仅提供要更新的属性的值。请求正文中未包含的现有属性会保留其以前的值，或者根据对其他属性值的更改重新计算。

下表指定可更新的属性。

属性	类型	说明
backgroundColor	String	在低带宽连接中代替背景图像显示的颜色。建议使用横幅徽标或组织颜色的主要颜色。以十六进制格式指定此项，例如，白色为 `#FFFFFF`。
backgroundImage	Stream	显示为登录页背景的图像。允许的类型为不小于 300 KB 且不大于 1920 × 1080 像素的 PNG 或 JPEG。较小的映像将降低带宽要求，并加快页面加载速度。
bannerLogo	Stream	登录页上显示的公司徽标的横幅版本。允许的类型为不大于 245 x 36 像素的 PNG 或 JPEG。建议使用徽标周围没有填充的透明图像。
contentCustomization	contentCustomization	表示要在整个租户身份验证流中自定义的各种内容选项。注意：仅受客户租户Microsoft Entra ID支持。
customAccountResetCredentialsUrl	String	用于重置帐户凭据的自定义 URL。此 URL 必须采用 ASCII 格式，或者非 ASCII 字符必须经过 URL 编码，且不超过 128 个字符。
customCannotAccessYourAccountText	String	一个字符串，用于替换登录页上的默认“无法访问帐户？”自助服务密码重置 (SSPR) 超链接文本。此文本必须采用 Unicode 格式，且不超过 256 个字符。
customCSS	Stream	登录页上显示的 CSS 样式。允许的格式仅.css格式，且不大于 25KB。
customForgotMyPasswordText	String	用于替换登录表单上默认的“忘记密码”超链接文本的字符串。此文本必须采用 Unicode 格式，且不超过 256 个字符。
customPrivacyAndCookiesText	String	用于替换页脚中默认的“隐私和 Cookie”超链接文本的字符串。此文本必须采用 Unicode 格式，且不超过 256 个字符。
customPrivacyAndCookiesUrl	String	用于替换页脚中“隐私和 Cookie”超链接的默认 URL 的自定义 URL。此 URL 必须采用 ASCII 格式，或者非 ASCII 字符必须经过 URL 编码，且不超过 128 个字符。
customTermsOfUseText	String	用于替换页脚中默认的“使用条款”超链接文本的字符串。此文本必须采用 Unicode 格式，且不超过 256 个字符。
customTermsOfUseUrl	String	用于替换页脚中“使用条款”超链接的默认 URL 的自定义 URL。此 URL 必须采用 ASCII 格式，或者非 ASCII 字符必须经过 URL 编码，且不超过 128 个字符。
favicon	Stream	自定义图标 (favicon) 替换Microsoft Entra租户上的默认Microsoft产品 favicon。
headerBackgroundColor	String	要应用于自定义标头颜色的 RGB 颜色。
headerLogo	Stream	显示在登录页标题中的公司徽标。允许的类型为不大于 245 x 36 像素的 PNG 或 JPEG。建议使用徽标周围没有填充的透明图像。
loginPageLayoutConfiguration	loginPageLayoutConfiguration	表示要显示在租户登录页上的布局配置。
loginPageTextVisibilitySettings	loginPageTextVisibilitySettings	表示可在租户的登录页上隐藏的各种文本。可以更新所有属性。
signInPageText	String	登录框底部显示的文本。使用它来传达其他信息，例如电话号码到技术支持或法律声明。此文本必须采用 Unicode 格式，且不超过 1024 个字符。
squareLogo	Stream	(OOBE) 以及启用 Windows Autopilot 进行部署时，Windows 10现成体验中显示的公司徽标的方形版本。允许的类型为不大于 240 x 240 像素且大小不超过 10 KB 的 PNG 或 JPEG。建议使用徽标周围没有填充的透明图像。
squareLogoDark	Stream	(OOBE) 以及启用 Windows Autopilot 进行部署时，Windows 10现成体验中显示的公司徽标的方形深色版本。允许的类型为不大于 240 x 240 像素且大小不超过 10 KB 的 PNG 或 JPEG。建议使用徽标周围没有填充的透明图像。
usernameHintText	String	在登录屏幕的“用户名”文本框中显示为提示的字符串。此文本必须是 Unicode，没有链接或代码，并且不能超过 64 个字符。

响应

如果成功，此方法返回 204 No Content 响应代码。

示例

示例 1：更新默认品牌

请求

以下示例显示了一个请求。

PATCH https://graph.microsoft.com/beta/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding
Content-Type: application/json
Accept-Language: 0

{
    "signInPageText":"Default",
    "usernameHintText":"DefaultHint"
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new OrganizationalBranding
{
	SignInPageText = "Default",
	UsernameHintText = "DefaultHint",
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Organization["{organization-id}"].Branding.PatchAsync(requestBody, (requestConfiguration) =>
{
	requestConfiguration.Headers.Add("Accept-Language", "0");
});

重要

Microsoft Graph SDK 默认使用 v1.0 版本的 API，并且不支持 beta 版本中提供的所有类型、属性和 API。有关使用 SDK 访问 beta API 的详细信息，请参阅将 Microsoft Graph SDK 与 beta API 配合使用。

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。



mgc-beta organization branding patch --organization-id {organization-id} --body '{\
    "signInPageText":"Default",\
    "usernameHintText":"DefaultHint"\
}\
'

重要

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  abstractions "github.com/microsoft/kiota-abstractions-go"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  graphorganization "github.com/microsoftgraph/msgraph-beta-sdk-go/organization"
	  //other-imports
)

headers := abstractions.NewRequestHeaders()
headers.Add("Accept-Language", "0")

configuration := &graphorganization.ItemBrandingRequestBuilderPatchRequestConfiguration{
	Headers: headers,
}
requestBody := graphmodels.NewOrganizationalBranding()
signInPageText := "Default"
requestBody.SetSignInPageText(&signInPageText) 
usernameHintText := "DefaultHint"
requestBody.SetUsernameHintText(&usernameHintText) 

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
branding, err := graphClient.Organization().ByOrganizationId("organization-id").Branding().Patch(context.Background(), requestBody, configuration)

重要

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

OrganizationalBranding organizationalBranding = new OrganizationalBranding();
organizationalBranding.setSignInPageText("Default");
organizationalBranding.setUsernameHintText("DefaultHint");
OrganizationalBranding result = graphClient.organization().byOrganizationId("{organization-id}").branding().patch(organizationalBranding, requestConfiguration -> {
	requestConfiguration.headers.add("Accept-Language", "0");
});

重要

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。


const options = {
	authProvider,
};

const client = Client.init(options);

const organizationalBranding = {
    signInPageText: 'Default',
    usernameHintText: 'DefaultHint'
};

await client.api('/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding')
	.version('beta')
	.update(organizationalBranding);

重要

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Organization\Item\Branding\BrandingRequestBuilderPatchRequestConfiguration;
use Microsoft\Graph\Beta\Generated\Models\OrganizationalBranding;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new OrganizationalBranding();
$requestBody->setSignInPageText('Default');
$requestBody->setUsernameHintText('DefaultHint');
$requestConfiguration = new BrandingRequestBuilderPatchRequestConfiguration();
$headers = [
		'Accept-Language' => '0',
	];
$requestConfiguration->headers = $headers;


$result = $graphServiceClient->organization()->byOrganizationId('organization-id')->branding()->patch($requestBody, $requestConfiguration)->wait();

重要

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。


Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement

$params = @{
	signInPageText = "Default"
	usernameHintText = "DefaultHint"
}

Update-MgBetaOrganizationBranding -OrganizationId $organizationId -BodyParameter $params

重要

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.organization.item.branding.branding_request_builder import BrandingRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
from msgraph_beta.generated.models.organizational_branding import OrganizationalBranding
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = OrganizationalBranding(
	sign_in_page_text = "Default",
	username_hint_text = "DefaultHint",
)

request_configuration = RequestConfiguration()
request_configuration.headers.add("Accept-Language", "0")


result = await graph_client.organization.by_organization_id('organization-id').branding.patch(request_body, request_configuration = request_configuration)

重要

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

响应

以下示例显示了相应的响应。

HTTP/1.1 204 No Content

示例 2：更新默认品牌打造的 bannerLogo

以下请求更新默认品牌打造的横幅徽标。若要更新Stream对象类型，请使用 PUT HTTP 方法，并在 URL 路径中包含区域设置 ID。

请求

以下示例显示了一个请求。

PUT https://graph.microsoft.com/beta/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/0/bannerLogo
Content-Type: image/jpeg

<Image>

Snippet not available

重要

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。



mgc-beta organization branding localizations banner-logo put --organization-id {organization-id} --organizational-branding-localization-id {organizationalBrandingLocalization-id}

重要

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

Snippet not available

重要

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

Snippet not available

重要

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。


const options = {
	authProvider,
};

const client = Client.init(options);

const stream = <Image>;

await client.api('/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/0/bannerLogo')
	.version('beta')
	.put(stream);

重要

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

Snippet not available

重要

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。


Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement

$params = Binary data for the image

Set-MgBetaOrganizationBrandingLocalizationBannerLogo -OrganizationId $organizationId -OrganizationalBrandingLocalizationId $organizationalBrandingLocalizationId -BodyParameter $params

重要

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

Snippet not available

重要

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

响应

以下示例显示了相应的响应。

HTTP/1.1 204 No Content

通过

Update organizationalBranding

权限

HTTP 请求

请求标头

请求正文

响应

示例

示例 1：更新默认品牌

请求

响应

示例 2：更新默认品牌打造的 bannerLogo

请求

响应

反馈

其他资源