organizationalbranding の更新

[アーティクル]
05/12/2022

名前空間: microsoft.graph

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

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

アクセス許可の種類	アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント)	Organization.ReadWrite.All
委任 (個人用 Microsoft アカウント)	サポートされていません。
アプリケーション	サポートされていません。

HTTP 要求

PATCH /organization/{organizationId}/branding

要求ヘッダー

名前	説明
Authorization	ベアラー {token}。必須。
Content-Type	application/json. Required.
Accept-Language	有効な ISO 639-1 ロケール。必須です。

要求本文

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

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

プロパティ	種類	説明
backgroundColor	String	低帯域幅接続で背景イメージの代わりに表示される色。バナーロゴまたは組織の色の主な色を使用することをお勧めします。これを 16 進数形式で指定します。たとえば、白は `#FFFFFF`.
backgroundImage	Stream	サインインページの背景として表示される画像。許可される型は PNG または JPEG で、300 KB より小さく、1920 × 1080 ピクセル未満です。画像を小さくすると、帯域幅の要件が減り、ページの読み込みが速くなります。
bannerLogo	Stream	サインインページに表示される会社のロゴのバナーバージョン。許可される型は、36 × 245 ピクセル以下の PNG または JPEG です。ロゴを埋め込まない透明な画像を使用することをお勧めします。
signInPageText	String	サインインボックスの下部に表示されるテキスト。これを使用して、電話番号などの追加情報をヘルプデスクや法的声明に伝えることができます。このテキストは Unicode でなければならず、1024 文字を超えないようにしてください。
squareLogo	Stream	既定のエクスペリエンス (OOBE) に表示 Windows 10される会社のロゴの正方形のバージョンと、Autopilot Windows展開が有効になっている場合。使用できる型は、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"
}


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

organizationalbranding の更新

アクセス許可

HTTP 要求

要求ヘッダー

要求本文

応答

例

例 1: 既定のブランド化を更新する

要求

応答

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

要求

応答

フィードバック