組織ブランドリソースの種類
名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
組織の既定のブランド化に関する詳細が含まれます。 organizationalBrandingProperties から継承します。
組織は、ユーザーが組織のテナント固有のアプリにサインインするとき、または 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 フォーラムを使用して当社にお問い合わせください。
メソッド
| メソッド | 戻り値の種類 | 説明 |
|---|---|---|
| Get | organizationalBranding | 組織ブランド オブジェクトのプロパティとリレーションシップ を 読み取ります。 |
| Update | なし | 組織ブランド オブジェクトのプロパティ を 更新します。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| backgroundColor | String | 低帯域幅接続で背景イメージの代わりに表示される色。 バナー ロゴの原色または組織の色を使用することをお勧めします。 これを 16 進形式で指定します(たとえば、white は #FFFFFF)。 組織から継承された ブランドプロパティ。 |
| backgroundImage | Stream | サインイン ページの背景として表示される画像。 使用できる種類は、300 KB 未満で、1920 × 1080 ピクセル以下の PNG または JPEG です。 イメージを小さくすると、帯域幅の要件が減り、ページの読み込みが速くなります。 組織から継承された ブランドプロパティ。 |
| backgroundImageRelativeUrl | String | cdnList の CDN ベース URL と組み合わせて CDN によって提供されるバージョンを提供する backgroundImage プロパティの相対 URL。 読み取り専用です。 組織から継承された ブランドプロパティ。 |
| bannerLogo | Stream | サインイン ページに表示される会社のロゴのバナー バージョン。 使用できる種類は、245 x 36 ピクセル以下の PNG または JPEG です。 ロゴの周囲にパディングのない透明なイメージを使用することをお勧めします。 組織から継承された ブランドプロパティ。 |
| bannerLogoRelativeUrl | String | cdnList の CDN ベース URL と組み合わせて CDN によって提供される読み取り専用バージョンを提供する bannerLogo プロパティの相対 URL。 読み取り専用です。 組織から継承された ブランドプロパティ。 |
| cdnList | String collection | 現在のリソースの資産を提供しているすべての利用可能な CDN プロバイダーのベース URL の一覧。 読み取り要求の高可用性のために、複数の CDN プロバイダーが同時に使用されます。 読み取り専用です。 組織から継承された ブランドプロパティ。 |
| contentCustomization | contentCustomization | テナントの認証フロー全体でカスタマイズするさまざまなコンテンツ オプションを表します。 手記： 顧客テナント専用の Microsoft Entra ID でサポートされます。 組織から継承された ブランドプロパティ。 |
| customAccountResetCredentialsUrl | String | アカウント資格情報をリセットするためのカスタム URL。 この URL は ASCII 形式であるか、ASCII 以外の文字は URL エンコードされ、128 文字を超えない必要があります。 組織から継承された ブランドプロパティ。 |
| customCannotAccessYourAccountText | String | サインイン ページの既定の "アカウントにアクセスできません" セルフサービス パスワード リセット (SSPR) ハイパーリンク テキストを置き換える文字列。 このテキストは Unicode 形式で、256 文字以内にする必要があります。 組織から継承された ブランドプロパティ。 |
| customCannotAccessYourAccountUrl | String | サインイン ページのセルフサービス パスワード リセット (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 | String | フッターの既定の "プライバシーと Cookie" ハイパーリンク テキストを置き換える文字列。 このテキストは Unicode 形式で、256 文字以内にする必要があります。 組織から継承された ブランドプロパティ。 |
| customPrivacyAndCookiesUrl | String | フッターの "プライバシーと Cookie" ハイパーリンクの既定の URL を置き換えるカスタム URL。 この URL は ASCII 形式であるか、ASCII 以外の文字は URL エンコードされ、128 文字を超えない必要があります。 組織から継承された ブランドプロパティ。 |
| customResetItNowText | String | サインイン フォームの既定の "今すぐリセット" ハイパーリンク テキストを置き換える文字列。 このテキストは Unicode 形式で、256 文字以内にする必要があります。 使用しないでください。 "今すぐリセット" ハイパーリンク テキストのカスタマイズは現在サポートされていません。 組織から継承された ブランドプロパティ。 |
| customTermsOfUseText | String | フッターの既定の "使用条件" ハイパーリンク テキストを置き換える文字列。 このテキストは Unicode 形式で、256 文字以内にする必要があります。 組織から継承された ブランドプロパティ。 |
| customTermsOfUseUrl | String | フッターの "使用条件" ハイパーリンクの既定の URL を置き換えるカスタム URL。 この URL は ASCII 形式である必要があります。または ASCII 以外の文字は URL エンコードされ、128 文字を超えないようにする必要があります。 組織から継承された ブランドプロパティ。 |
| favicon | Stream | Microsoft Entra テナントの既定の Microsoft 製品ファビコンを置き換えるカスタム アイコン (favicon)。 組織から継承された ブランドプロパティ。 |
| faviconRelativeUrl | String | 上記の favicon の相対 URL。cdnList の CDN ベース URL と組み合わせて 、CDN によって提供されるバージョンを提供します。 読み取り専用です。 組織から継承された ブランドプロパティ。 |
| headerBackgroundColor | String | ヘッダーの色をカスタマイズするために適用する RGB 色。 組織から継承された ブランドプロパティ。 |
| headerLogo | Stream | サインイン ページのヘッダーに表示される会社のロゴ。 使用できる種類は、245 x 36 ピクセル以下の 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 は、常に文字列型 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 文字を超えることはできません。 組織から継承された ブランドプロパティ。 |
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| ローカライズ | organizationalBrandingLocalizationコレクション | ロケールに基づいて異なるブランドを追加します。 |
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"@odata.type": "#microsoft.graph.organizationalBranding",
"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"
}
}