organizationalBrandingProperties リソースの種類

[アーティクル]
04/05/2024

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

organizationのブランド化を構成するためのプロパティを公開する抽象型。

組織は、ユーザーがorganizationのテナント固有のアプリにサインインするとき、またはユーザーのテナントをユーザー名から識別Microsoft Entra ID場合に表示される、Microsoft Entraサインインページをカスタマイズできます。開発者は、会社のブランド化情報を読み取り、自社のブランド化を使用してサインインユーザー専用にカスタマイズするようにアプリエクスペリエンスをカスタマイズすることもできます。

組織ブランドオブジェクトで表される元の構成の言語を変更することはできません。ただし、企業はロケールに基づいて異なるブランドを追加できます。言語固有のブランド化については、組織のブランド化Localization オブジェクトに関するページを参照してください。

注:

カスタムブランド化を追加するには、Microsoft Entra ID P1 または P2、Premium 2、または Office 365 (Office 365 アプリの場合) のライセンスが必要です。ライセンスとエディションの詳細については、「Microsoft Entra ID P1 または P2 にサインアップする」を参照してください。

Microsoft Entra ID P1 または P2 エディションは、Microsoft Entra IDの世界的なインスタンスを使用して、中国のお客様にご利用いただけます。 Microsoft Entra ID P1 または P2 エディションは、現在、中国の 21Vianet が運営する Azure サービスではサポートされていません。詳細については、Microsoft Entra フォーラムを使用して、お問い合わせください。

メソッド

なし。

プロパティ

プロパティ	型	説明
backgroundColor	String	低帯域幅接続で背景イメージの代わりに表示される色。バナーロゴの原色またはorganizationの色を使用することをお勧めします。これを 16 進形式で指定します。たとえば、white は `#FFFFFF`です。
backgroundImage	Stream	サインインページの背景として表示される画像。使用できる種類は、300 KB 未満で、1920 × 1080 ピクセル以下の PNG または JPEG です。イメージを小さくすると、帯域幅の要件が減り、ページの読み込みが速くなります。
backgroundImageRelativeUrl	String	cdnList の CDN ベース URL と組み合わせて CDN によって提供されるバージョンを提供する backgroundImage プロパティの相対 URL。読み取り専用です。
bannerLogo	Stream	サインインページに表示される会社のロゴのバナーバージョン。使用できる種類は、36 × 245 ピクセル以下の PNG または JPEG です。ロゴの周囲にパディングのない透明なイメージを使用することをお勧めします。
bannerLogoRelativeUrl	文字列	cdnList の CDN ベース URL と組み合わせて CDN によって提供される読み取り専用バージョンを提供する bannerLogo プロパティの相対 URL。読み取り専用です。
cdnList	String collection	現在のリソースの資産を提供しているすべての利用可能な CDN プロバイダーのベース URL の一覧。読み取り要求の高可用性のために、複数の CDN プロバイダーが同時に使用されます。読み取り専用。
contentCustomization	contentCustomization	テナントの認証フロー全体でカスタマイズするさまざまなコンテンツオプションを表します。メモ：顧客テナント専用のMicrosoft Entra IDでサポートされます。
customAccountResetCredentialsUrl	文字列	アカウント資格情報をリセットするためのカスタム URL。この URL は ASCII 形式であるか、ASCII 以外の文字は URL エンコードされ、128 文字を超えない必要があります。
customCannotAccessYourAccountText	文字列	サインインページの既定の "アカウントにアクセスできません" セルフサービスパスワードリセット (SSPR) ハイパーリンクテキストを置き換える文字列。このテキストは Unicode 形式で、256 文字以内にする必要があります。
customCannotAccessYourAccountUrl	文字列	サインインページのセルフサービスパスワードリセット (SSPR) の "アカウントにアクセスできません" ハイパーリンクの既定の URL を置き換えるカスタム URL。この URL は ASCII 形式であるか、ASCII 以外の文字は URL エンコードされ、128 文字を超えない必要があります。使用しないでください。代わりに customAccountResetCredentialsUrl を使用します。
customCSS	Stream	サインインページに表示される CSS スタイル。使用できる形式は `.css` フォーマットのみであり、25 KB 以下です。
customCSSRelativeUrl	String	cdnList の CDN ベース URL と組み合わせて CDN によって提供されるバージョンを提供する customCSS プロパティの相対 URL。読み取り専用。
customForgotMyPasswordText	String	サインインフォームの既定の "パスワードを忘れた場合" ハイパーリンクテキストを置き換える文字列。このテキストは Unicode 形式で、256 文字以内にする必要があります。
customPrivacyAndCookiesText	文字列	フッターの既定の "プライバシーと Cookie" ハイパーリンクテキストを置き換える文字列。このテキストは Unicode 形式で、256 文字以内にする必要があります。
customPrivacyAndCookiesUrl	文字列	フッターの "プライバシーと Cookie" ハイパーリンクの既定の URL を置き換えるカスタム URL。この URL は ASCII 形式であるか、ASCII 以外の文字は URL エンコードされ、128 文字を超えない必要があります。
customResetItNowText	文字列	サインインフォームの既定の "今すぐリセット" ハイパーリンクテキストを置き換える文字列。このテキストは Unicode 形式で、256 文字以内にする必要があります。使用しないでください。 "今すぐリセット" ハイパーリンクテキストのカスタマイズは現在サポートされていません。
customTermsOfUseText	文字列	フッターの既定の "使用条件" ハイパーリンクテキストを置き換える文字列。このテキストは Unicode 形式で、256 文字以内にする必要があります。
customTermsOfUseUrl	String	フッターの "使用条件" ハイパーリンクの既定の URL を置き換えるカスタム URL。この URL は ASCII 形式である必要があります。または ASCII 以外の文字は URL エンコードされ、128 文字を超えないようにする必要があります。
ファビコン	Stream	Microsoft Entra テナントの既定の Microsoft 製品 favicon を置き換えるカスタムアイコン (favicon)。
faviconRelativeUrl	String	上記の favicon の相対 URL。cdnList の CDN ベース URL と組み合わせて、CDN によって提供されるバージョンを提供します。読み取り専用です。
headerBackgroundColor	String	ヘッダーの色をカスタマイズするために適用する RGB 色。
headerLogo	Stream	サインインページのヘッダーに表示される会社のロゴ。使用できる種類は、36 × 245 ピクセル以下の PNG または JPEG です。ロゴの周囲にパディングのない透明なイメージを使用することをお勧めします。
headerLogoRelativeUrl	String	cdnList の CDN ベース URL と組み合わせて CDN によって提供される読み取り専用バージョンを提供する headerLogo プロパティの相対 URL。読み取り専用です。
id	String	カルチャ名を使用して指定されたロケールを表す識別子。カルチャ名は、"languagecode2-country/regioncode2" という形式の RFC 1766 標準に従います。"languagecode2" は ISO 639-1 から派生した小文字の 2 文字のコードであり、"country/regioncode2" は ISO 3166 から派生した大文字の 2 文字コードです。たとえば、米国英語はです `en-US`。既定の /branding の ID は、常に String 型 `0` またはです `default`。読み取り専用です。メモ：現在、1 つのロケールに対する複数のブランド化はサポートされていません。
loginPageLayoutConfiguration	loginPageLayoutConfiguration	テナントのログインページに表示されるレイアウト構成を表します。
loginPageTextVisibilitySettings	loginPageTextVisibilitySettings	テナントのログインページで非表示にできるさまざまなテキストを表します。
signInPageText	String	サインインボックスの下部に表示されるテキスト。電話番号などの追加情報をヘルプデスクや法的な声明に伝える場合に使用します。このテキストは Unicode 形式で、1024 文字以内にする必要があります。
squareLogo	Stream	Windows 10アウトオブボックスエクスペリエンス (OOBE) と Windows Autopilot が展開に有効になっている場合に表示される、正方形のバージョンの会社のロゴ。使用できる種類は、240 x 240 ピクセル以下で、サイズが 10 KB 以下の PNG または JPEG です。ロゴの周囲にパディングのない透明なイメージを使用することをお勧めします。
squareLogoRelativeUrl	String	cdnList の CDN ベース URL と組み合わせて CDN によって提供されるバージョンを提供する squareLogo プロパティの相対 URL。読み取り専用。
squareLogoDark	Stream	Windows 10アウトオブボックスエクスペリエンス (OOBE) と Windows Autopilot が展開に有効になっている場合に表示される会社のロゴの正方形の濃色バージョン。使用できる種類は、240 x 240 ピクセル以下で、サイズが 10 KB 以下の PNG または JPEG です。ロゴの周囲にパディングのない透明なイメージを使用することをお勧めします。
squareLogoDarkRelativeUrl	String	cdnList の CDN ベース URL と組み合わせて CDN によって提供されるバージョンを提供する squareLogoDark プロパティの相対 URL。読み取り専用です。
usernameHintText	String	サインイン画面の [ユーザー名] テキストボックスにヒントとして表示される文字列。このテキストは、リンクやコードを含まない Unicode である必要があり、64 文字を超えることはできません。

リレーションシップ

なし。

JSON 表記

リソースの JSON 表記を次に示します。

{
  "@odata.type": "#microsoft.graph.organizationalBrandingProperties",
  "id": "String (identifier)",
  "backgroundColor": "String",
  "backgroundImage": "Stream",
  "backgroundImageRelativeUrl": "String",
  "bannerLogo": "Stream",
  "bannerLogoRelativeUrl": "String",
  "cdnList": [
    "String"
  ],
  "signInPageText": "String",
  "squareLogo": "Stream",
  "squareLogoRelativeUrl": "String",
  "squareLogoDark": "Stream",
  "squareLogoDarkRelativeUrl": "String",
  "usernameHintText": "String",
  "contentCustomization": {
    "@odata.type": "microsoft.graph.contentCustomization"
  },  
  "customAccountResetCredentialsUrl": "String",
  "customCannotAccessYourAccountText": "String",
  "customCannotAccessYourAccountUrl": "String",
  "customCSS": "Stream",
  "customCSSRelativeUrl": "String",
  "customForgotMyPasswordText": "String",
  "customPrivacyAndCookiesText": "String",
  "customPrivacyAndCookiesUrl": "String",
  "customResetItNowText": "String",
  "customTermsOfUseText": "String",
  "customTermsOfUseUrl": "String",
  "favicon": "Stream",
  "faviconRelativeUrl": "String",
  "headerBackgroundColor": "String",
  "headerLogo": "Stream",
  "headerLogoRelativeUrl": "String",
  "loginPageLayoutConfiguration": {
    "@odata.type": "microsoft.graph.loginPageLayoutConfiguration"
  },
  "loginPageTextVisibilitySettings": {
    "@odata.type": "microsoft.graph.loginPageTextVisibilitySettings"
  }
}