创建 organizationalBrandingLocalization
本文内容
命名空间:microsoft.graph
重要
Microsoft Graph /beta
版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
创建新的 organizationalBrandingLocalization 对象。 这将创建本地化品牌,同时创建默认品牌(如果不存在)。
默认品牌仅创建一次。 如果未为用户的浏览器语言配置本地化品牌,则会加载它。 若要检索默认品牌,请参阅 获取品牌 。
此 API 可用于以下国家级云部署 。
全局服务
美国政府 L4
美国政府 L5 (DOD)
由世纪互联运营的中国
✅
✅
✅
✅
权限
为此 API 选择标记为最低特权的权限。 只有在应用需要它时 ,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型 。 要了解有关这些权限的详细信息,请参阅 权限参考 。
权限类型
最低特权权限
更高特权权限
委派(工作或学校帐户)
OrganizationalBranding.ReadWrite.All
Organization.ReadWrite.All
委派(个人 Microsoft 帐户)
不支持。
不支持。
应用程序
OrganizationalBranding.ReadWrite.All
Organization.ReadWrite.All
对于委派方案,只有具有组织品牌管理员 Microsoft Entra角色 的用户才能完全管理组织的品牌。
HTTP 请求
此请求将创建新的本地化品牌和默认品牌(如果尚不存在)。
POST /organization/{organizationId}/branding/localizations
名称
说明
Authorization
持有者 {token}。 必填。 详细了解 身份验证和授权 。
Content-Type
application/json. 必需。
请求正文
下表列出了创建 organizationalBrandingLocalization 对象时所需的属性。
属性
类型
说明
id
String
一个标识符,表示使用区域性名称指定的区域设置。 区域性名称遵循 RFC 1766 标准,格式为“languagecode2-country/regioncode2”。 “languagecode2”部分是派生自 ISO 639-1 的小写双字母代码,“country/regioncode2”是派生自 ISO 3166 的大写双字母代码。 例如,美国英语为 en-US
。 无法通过将 id 的值设置为 String 类型 0
或 default
来创建默认品牌。 注意: 目前不支持单个区域设置的多个品牌。
响应
如果成功,此方法在 201 Created
响应正文中返回响应代码和 organizationalBrandingLocalization 对象。
示例
以下示例为法语 (fr-FR
) 本地化创建品牌本地化。 String 类型的任何未指定属性都继承自默认品牌对象中的 值。 例如,如果默认品牌对象中的 signInPageText 为 null
,则在此请求中创建的品牌打造的 fr-FR
signInPageText 也将是 null
。 若要替代 null
不带任何文本的值,请使用仅包含空格的字符串。
请求
以下示例显示了一个请求。
POST https://graph.microsoft.com/beta/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations
Content-Type: application/json
{
"backgroundColor":"#00000F",
"id": "fr-FR",
"signInPageText": " "
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models;
var requestBody = new OrganizationalBrandingLocalization
{
BackgroundColor = "#00000F",
Id = "fr-FR",
SignInPageText = " ",
};
// 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.Localizations.PostAsync(requestBody);
// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta organization branding localizations create --organization-id {organization-id} --body '{\
"backgroundColor":"#00000F",\
"id": "fr-FR",\
"signInPageText": " "\
}\
'
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
//other-imports
)
graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)
requestBody := graphmodels.NewOrganizationalBrandingLocalization()
backgroundColor := "#00000F"
requestBody.SetBackgroundColor(&backgroundColor)
id := "fr-FR"
requestBody.SetId(&id)
signInPageText := " "
requestBody.SetSignInPageText(&signInPageText)
localizations, err := graphClient.Organization().ByOrganizationId("organization-id").Branding().Localizations().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
OrganizationalBrandingLocalization organizationalBrandingLocalization = new OrganizationalBrandingLocalization();
organizationalBrandingLocalization.setBackgroundColor("#00000F");
organizationalBrandingLocalization.setId("fr-FR");
organizationalBrandingLocalization.setSignInPageText(" ");
OrganizationalBrandingLocalization result = graphClient.organization().byOrganizationId("{organization-id}").branding().localizations().post(organizationalBrandingLocalization);
const options = {
authProvider,
};
const client = Client.init(options);
const organizationalBrandingLocalization = {
backgroundColor: '#00000F',
id: 'fr-FR',
signInPageText: ' '
};
await client.api('/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations')
.version('beta')
.post(organizationalBrandingLocalization);
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\OrganizationalBrandingLocalization;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new OrganizationalBrandingLocalization();
$requestBody->setBackgroundColor('#00000F');
$requestBody->setId('fr-FR');
$requestBody->setSignInPageText(' ');
$result = $graphServiceClient->organization()->byOrganizationId('organization-id')->branding()->localizations()->post($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement
$params = @{
backgroundColor = "#00000F"
id = "fr-FR"
signInPageText = " "
}
New-MgBetaOrganizationBrandingLocalization -OrganizationId $organizationId -BodyParameter $params
from msgraph import GraphServiceClient
from msgraph.generated.models.organizational_branding_localization import OrganizationalBrandingLocalization
graph_client = GraphServiceClient(credentials, scopes)
request_body = OrganizationalBrandingLocalization(
background_color = "#00000F",
id = "fr-FR",
sign_in_page_text = " ",
)
result = await graph_client.organization.by_organization_id('organization-id').branding.localizations.post(request_body)
响应
以下示例显示了相应的响应。
HTTP/1.1 201 Created
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#organization('d69179bf-f4a4-41a9-a9de-249c0f2efb1d')/branding/localizations/$entity",
"@odata.id": "https://graph.microsoft.com/v2/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/directoryObjects/$/Microsoft.DirectoryServices.Organization('d69179bf-f4a4-41a9-a9de-249c0f2efb1d')//localizations/fr-FR",
"id": "fr-FR",
"backgroundColor": " ",
"backgroundImageRelativeUrl": null,
"bannerLogoRelativeUrl": null,
"cdnList": [],
"signInPageText": " ",
"squareLogoRelativeUrl": null,
"squareLogoDarkRelativeUrl": null,
"usernameHintText": " "
}