organizationalbranding の更新
名前空間: microsoft.graph
重要
Microsoft Graph の /beta
バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
組織ブランドリソースで指定された既定のブランド化オブジェクトのプロパティ を 更新します。
この API は、次の国内クラウド展開で使用できます。
グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
アクセス許可の種類 | 最小特権アクセス許可 | より高い特権のアクセス許可 |
---|---|---|
委任 (職場または学校のアカウント) | 組織ブランド.ReadWrite.All | Organization.ReadWrite.All |
委任 (個人用 Microsoft アカウント) | サポートされていません。 | サポートされていません。 |
アプリケーション | 組織ブランド.ReadWrite.All | Organization.ReadWrite.All |
重要
職場または学校アカウントを使用した委任されたシナリオでは、サインインしているユーザーに、サポートされているMicrosoft Entraロールまたはサポートされているロールのアクセス許可を持つカスタム ロールを割り当てる必要があります。 組織ブランド管理者 は、この操作でサポートされる最小限の特権ロールです。
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 ロケールまたは 0 。 必須です。 |
要求本文
要求本文で、更新するプロパティの値 のみを 指定します。 要求本文に含まれていない既存のプロパティは、以前の値を維持するか、他のプロパティ値の変更に基づいて再計算されます。
次の表に、更新できるプロパティを示します。
プロパティ | 型 | 説明 |
---|---|---|
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 文字を超えないようにする必要があります。 |
favicon | 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/beta/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding
Content-Type: application/json
Accept-Language: 0
{
"signInPageText":"Default",
"usernameHintText":"DefaultHint"
}
応答
次の例は応答を示しています。
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>
応答
次の例は応答を示しています。
HTTP/1.1 204 No Content