organizationalbranding の更新

[アーティクル]
11/11/2023

名前空間: microsoft.graph

組織ブランドリソースで指定された既定のブランド化オブジェクトのプロパティを更新します。

この API は、次の国内クラウド展開で使用できます。

グローバルサービス	米国政府機関 L4	米国政府機関 L5 (DOD)	21Vianet が運営する中国
✅	✅	✅	✅

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。これらのアクセス許可の詳細については、アクセス許可のリファレンスを参照してください。

アクセス許可の種類	最小特権アクセス許可	特権の高いアクセス許可
委任 (職場または学校のアカウント)	組織ブランド.ReadWrite.All	Organization.ReadWrite.All
委任 (個人用 Microsoft アカウント)	サポートされていません。	サポートされていません。
アプリケーション	組織ブランド.ReadWrite.All	Organization.ReadWrite.All

委任されたシナリオでは、Oragnizational Branding AdministratorMicrosoft Entra ロールを持つユーザーのみがorganizationのブランド化を完全に管理できます。

HTTP 要求

signInPageText や usernameHintText などの文字列データ型を更新するには、PATCH メソッドを使用します。 backgroundLogo や backgroundImage などのStreamデータ型を更新するには、PUT メソッドを使用します。同じ要求内の他のデータ型でStream型を更新することはできません。

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

要求ヘッダー

名前	説明
Authorization	ベアラー {token}。必須です。認証と承認の詳細については、こちらをご覧ください。
Content-Type	application/json. Required.
Accept-Language	有効な ISO 639-1 ロケール。必須です。

要求本文

要求本文で、更新すべきプロパティの値のみを指定します。要求本文に含まれない既存のプロパティは、以前の値のままになるか、他のプロパティ値の変化に基づいて再計算されます。

次の表に、更新できるプロパティを示します。

プロパティ	型	説明
backgroundColor	String	低帯域幅接続で背景イメージの代わりに表示される色。バナーロゴの原色またはorganizationの色を使用することをお勧めします。これを 16 進形式で指定します。たとえば、white は `#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形式のみであり、25 KB 以下です。
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 文字を超えないようにする必要があります。
ファビコン	Stream	Microsoft Entra テナントの既定の Microsoft 製品 favicon を置き換えるカスタムアイコン (favicon)。
headerBackgroundColor	String	ヘッダーの色をカスタマイズするために適用する RGB 色。
headerLogo	Stream	サインインページのヘッダーに表示される会社のロゴ。使用できる種類は、245 x 36 ピクセル以下の PNG または JPEG です。ロゴの周囲にパディングのない透明なイメージを使用することをお勧めします。
loginPageLayoutConfiguration	loginPageLayoutConfiguration	テナントのログインページに表示されるレイアウト構成を表します。
loginPageTextVisibilitySettings	loginPageTextVisibilitySettings	テナントのログインページで非表示にできるさまざまなテキストを表します。すべてのプロパティを更新できます。
signInPageText	String	サインインボックスの下部に表示されるテキスト。電話番号などの追加情報をヘルプデスクや法的な声明に伝える場合に使用します。このテキストは Unicode 形式で、1024 文字以内にする必要があります。
squareLogo	Stream	Windows 10アウトオブボックスエクスペリエンス (OOBE) と Windows Autopilot が展開に有効になっている場合に表示される、正方形のバージョンの会社のロゴ。使用できる種類は、240 x 240 ピクセル以下で、サイズが 10 KB 以下の PNG または JPEG です。ロゴの周囲にパディングのない透明なイメージを使用することをお勧めします。
squareLogoDark	Stream	Windows 10アウトオブボックスエクスペリエンス (OOBE) と Windows Autopilot が展開に有効になっている場合に表示される会社のロゴの正方形の濃色バージョン。使用できる種類は、240 x 240 ピクセル以下で、サイズが 10 KB 以下の PNG または JPEG です。ロゴの周囲にパディングのない透明なイメージを使用することをお勧めします。
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"
}


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

// Dependencies
using Microsoft.Graph.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");
});


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc organization branding patch --organization-id {organization-id} --body '{\
    "signInPageText":"Default",\
    "usernameHintText":"DefaultHint"\
}\
'



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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


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

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

branding, err := graphClient.Organization().ByOrganizationId("organization-id").Branding().Patch(context.Background(), requestBody, configuration)


// 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");
});


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);


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Organization\Item\Branding\BrandingRequestBuilderPatchRequestConfiguration;
use Microsoft\Graph\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();


Import-Module Microsoft.Graph.Identity.DirectoryManagement

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

Update-MgOrganizationBranding -OrganizationId $organizationId -BodyParameter $params


from msgraph import GraphServiceClient
from msgraph.generated.organization.item.branding.branding_request_builder import BrandingRequestBuilder
from msgraph.generated.models.organizational_branding import OrganizationalBranding

graph_client = GraphServiceClient(credentials, scopes)

request_body = OrganizationalBranding(
	sign_in_page_text = "Default",
	username_hint_text = "DefaultHint",
)

request_configuration = BrandingRequestBuilder.BrandingRequestBuilderPatchRequestConfiguration()
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)

応答

次の例は応答を示しています。

HTTP/1.1 204 No Content

例 2: 既定のブランド化のために bannerLogo を更新する

次の要求は、既定のブランド化のバナーロゴを更新します。 Stream オブジェクトの種類を更新するには、PUT HTTP メソッドを使用し、URL パスにロケール ID を含めます。

要求