Update organizationalBranding

项目
07/18/2022

命名空间：microsoft.graph

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

权限

要调用此 API，需要以下权限之一。要了解详细信息，包括如何选择权限的信息，请参阅权限。

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

HTTP 请求

PATCH /organization/{organizationId}/branding

请求标头

名称	说明
Authorization	Bearer {token}。必需。
Content-Type	application/json. Required.
Accept-Language	有效的 ISO 639-1 区域设置。必填。

请求正文

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

下表指定可更新的属性。

属性	类型	说明
backgroundColor	String	将在低带宽连接中代替背景图像显示的颜色。建议使用横幅徽标或组织颜色的主要颜色。以十六进制格式指定此值，例如，白色为 `#FFFFFF`。
backgroundImage	Stream	显示为登录页背景的图像。允许的类型是 PNG 或 JPEG，不小于 300 KB，不大于 1920 × 1080 像素。较小的图像将减少带宽要求，并加快页面加载速度。
bannerLogo	Stream	登录页上显示的公司徽标的横幅版本。允许的类型为 PNG 或 JPEG，不超过 36 × 245 像素。建议使用不填充徽标的透明图像。
signInPageText	字符串	登录框底部显示的文本。可以使用此信息将其他信息（例如电话号码）传达给技术支持人员或法律声明。此文本必须为 Unicode，且不超过 1024 个字符。
squareLogo	Stream	Windows 10 OOBE) 以及启用 Windows Autopilot 进行部署时 (现Windows 10体验中显示的公司徽标的平方版本。允许的类型是 PNG 或 JPEG，大小不超过 240 x 240 像素，大小不超过 10 KB。建议使用不填充徽标的透明图像。
usernameHintText	String	显示为登录屏幕上用户名文本框中的提示的字符串。此文本必须是 Unicode，没有链接或代码，不能超过 64 个字符。

响应

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

示例

示例 1：更新默认品牌

请求

下面展示了示例请求。

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

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


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

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

await graphClient.Organization["{organization-id}"].Branding
    .Request()
    .Header("Accept-Language","0")
    .UpdateAsync(organizationalBranding);

有关如何将 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')
    .update(organizationalBranding);

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


MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/v1.0/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding"]]];
[urlRequest setHTTPMethod:@"PATCH"];
[urlRequest setValue:@"0" forHTTPHeaderField:@"Accept-Language"];
[urlRequest setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];

MSGraphOrganizationalBranding *organizationalBranding = [[MSGraphOrganizationalBranding alloc] init];
[organizationalBranding setSignInPageText:@"Default"];
[organizationalBranding setUsernameHintText:@"DefaultHint"];

NSError *error;
NSData *organizationalBrandingData = [organizationalBranding getSerializedDataWithError:&error];
[urlRequest setHTTPBody:organizationalBrandingData];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        //Request Completed

}];

[meDataTask execute];

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


GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

LinkedList<Option> requestOptions = new LinkedList<Option>();
requestOptions.add(new HeaderOption("Accept-Language", "0"));

OrganizationalBranding organizationalBranding = new OrganizationalBranding();
organizationalBranding.signInPageText = "Default";
organizationalBranding.usernameHintText = "DefaultHint";

graphClient.organization("d69179bf-f4a4-41a9-a9de-249c0f2efb1d").branding()
    .buildRequest( requestOptions )
    .patch(organizationalBranding);

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


//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

requestBody := msgraphsdk.NewOrganizationalBranding()
signInPageText := "Default"
requestBody.SetSignInPageText(&signInPageText)
usernameHintText := "DefaultHint"
requestBody.SetUsernameHintText(&usernameHintText)
headers := map[string]string{
    "Accept-Language": "0"
}
options := &msgraphsdk.BrandingRequestBuilderPatchRequestConfiguration{
    Headers: headers,
}
organizationId := "organization-id"
graphClient.OrganizationById(&organizationId).Branding().PatchWithRequestConfigurationAndResponseHandler(requestBody, options, nil)

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


Import-Module Microsoft.Graph.Identity.DirectoryManagement

$params = @{
    SignInPageText = "Default"
    UsernameHintText = "DefaultHint"
}

Update-MgOrganizationBranding -OrganizationId $organizationId -BodyParameter $params

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

响应

下面展示了示例响应。

HTTP/1.1 204 No Content

示例 2：更新 bannerLogo 以进行默认品牌打造

以下请求更新默认品牌的横幅徽标。

请求

下面展示了示例请求。

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

<Image>


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var stream = new System.IO.MemoryStream(Encoding.UTF8.GetBytes(@"<Image>
"));

var branding = new OrganizationalBranding();
branding.BannerLogo = stream;

await graphClient.Organization["{organization-id}"].Branding
    .Request()
    .UpdateAsync(branding);

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


const options = {
    authProvider,
};

const client = Client.init(options);

const stream = <Image>;

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

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

响应

下面展示了示例响应。

HTTP/1.1 204 No Content

Update organizationalBranding

权限

HTTP 请求

请求标头

请求正文

响应

示例

示例 1：更新默认品牌

请求

响应

示例 2：更新 bannerLogo 以进行默认品牌打造

请求

响应

反馈