Тип ресурса организационного бренда
Пространство имен: microsoft.graph
Важно!
API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Содержит сведения о фирменной символики организации по умолчанию. Наследует от организационных свойств.
Организации могут настраивать страницы входа в Microsoft Entra, которые отображаются при входе пользователей в приложения своей организации, зависящих от клиента, или когда идентификатор Microsoft Entra идентифицирует клиент пользователя по имени пользователя. Разработчик также может прочитать сведения о фирменной символике компании и настроить интерфейс приложения, чтобы адаптировать его специально для пользователя, выполнившего вход, используя фирменную символику своей компании.
Вы не можете изменить язык исходной конфигурации. Однако компании могут добавлять различные фирменные символы в зависимости от языкового стандарта. Фирменная символика для конкретного языка см. в объекте organizationalBrandingLocalization .
Примечание.
Для добавления пользовательской фирменной символики требуется наличие лицензий 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 в настоящее время не поддерживаются в службе Azure, управляемой компанией 21Vianet в Китае. Дополнительные сведения см. на форуме Microsoft Entra.
Методы
| Метод | Тип возвращаемых данных | Описание |
|---|---|---|
| Получение | organizationalBranding | Чтение свойств и связей объекта organizationalBranding . |
| Обновление | Нет | Обновите свойства объекта organizationalBranding . |
Свойства
| Свойство | Тип | Описание |
|---|---|---|
| backgroundColor | String | Цвет, который отображается вместо фонового изображения в подключениях с низкой пропускной способностью. Рекомендуется использовать основной цвет логотипа баннера или цвет организации. Укажите его в шестнадцатеричном формате, например белый — #FFFFFF. Наследуется от организационных свойствBrandingProperties. |
| backgroundImage | Поток | Изображение, отображающееся в качестве фона страницы входа. Допустимые типы: PNG или JPEG размером не менее 300 КБ и размером не более 1920 × 1080 пикселей. Изображение меньшего размера снизит требования к пропускной способности и ускорит загрузку страницы. Наследуется от организационных свойствBrandingProperties. |
| backgroundImageRelativeUrl | String | Относительный URL-адрес свойства backgroundImage , который в сочетании с базовым URL-адресом CDN из cdnList предоставляет версию, обслуживаемую CDN. Только для чтения. Наследуется от организационных свойствBrandingProperties. |
| bannerLogo | Поток | Баннерная версия логотипа вашей компании, которая отображается на странице входа. Допустимые типы: PNG или JPEG размером не более 245 x 36 пикселей. Рекомендуется использовать прозрачное изображение без набивки вокруг логотипа. Наследуется от организационных свойствBrandingProperties. |
| bannerLogoRelativeUrl | String | Относительный URL-адрес свойства bannerLogo , который в сочетании с базовым URL-адресом CDN из cdnList предоставляет версию только для чтения, обслуживаемую CDN. Только для чтения. Наследуется от организационных свойствBrandingProperties. |
| cdnList | Коллекция строк | Список базовых URL-адресов для всех доступных поставщиков CDN, обслуживающих ресурсы текущего ресурса. Несколько поставщиков CDN используются одновременно для высокого уровня доступности запросов на чтение. Только для чтения. Наследуется от организационных свойствBrandingProperties. |
| contentНастройка | contentНастройка | Представляет различные параметры содержимого, которые необходимо настроить в потоке проверки подлинности для клиента. ЗАМЕТКА: Поддерживается идентификатором Microsoft Entra только для клиентов. Наследуется от организационных свойствBrandingProperties. |
| customAccountResetCredentialsUrl | String | Настраиваемый URL-адрес для сброса учетных данных учетной записи. Этот URL-адрес должен быть в формате ASCII или символы, отличные от ASCII, должны быть закодированы и не должны превышать 128 символов. Наследуется от организационных свойствBrandingProperties. |
| customCannotAccessYourAccountText | String | Строка, заменяющая текст гиперссылки по умолчанию "Не удается получить доступ к учетной записи?" для самостоятельного сброса пароля (SSPR) на странице входа. Этот текст должен быть в формате Юникода и не превышать 256 символов. Наследуется от организационных свойствBrandingProperties. |
| customCannotAccessYourAccountUrl | String | Настраиваемый URL-адрес, заменяющий URL-адрес по умолчанию для гиперссылки самостоятельного сброса пароля (SSPR) "Не удается получить доступ к учетной записи?" на странице входа. Этот URL-адрес должен быть в формате ASCII или символы, отличные от ASCII, должны быть закодированы и не должны превышать 128 символов. НЕ ИСПОЛЬЗУЙТЕ. Вместо этого используйте customAccountResetCredentialsUrl . Наследуется от организационных свойствBrandingProperties. |
| customCSS | Поток | Стили CSS, отображаемые на странице входа. Допустимый формат только .css и не превышает 25 КБ. Наследуется от организационных свойствBrandingProperties. |
| customCSSRelativeUrl | String | Относительный URL-адрес свойства customCSS , объединенный с базовым URL-адресом CDN из cdnList для предоставления версии, обслуживаемой CDN. Только для чтения. Наследуется от организационных свойствBrandingProperties. |
| customForgotMyPasswordText | String | Строка, заменяющая текст гиперссылки по умолчанию "Забыли пароль" в форме входа. Этот текст должен быть в формате Юникода и не превышать 256 символов. Наследуется от организационных свойствBrandingProperties. |
| customPrivacyAndCookiesText | String | Строка, заменяющая текст гиперссылки по умолчанию "Конфиденциальность и файлы cookie" в нижнем колонтитуле. Этот текст должен быть в формате Юникода и не превышать 256 символов. Наследуется от организационных свойствBrandingProperties. |
| customPrivacyAndCookiesUrl | String | Настраиваемый URL-адрес, заменяющий URL-адрес гиперссылки "Конфиденциальность и файлы cookie" по умолчанию в нижнем колонтитуле. Этот URL-адрес должен быть в формате ASCII или символы, отличные от ASCII, должны быть закодированы и не должны превышать 128 символов. Наследуется от организационных свойствBrandingProperties. |
| customResetItNowText | String | Строка для замены текста гиперссылки сброса по умолчанию в форме входа. Этот текст должен быть в формате Юникода и не превышать 256 символов. НЕ ИСПОЛЬЗУЙТЕ: Настройка текста гиперссылки "сбросить сейчас" в настоящее время не поддерживается. Наследуется от организационных свойствBrandingProperties. |
| customTermsOfUseText | String | Строка для замены текста гиперссылки "Условия использования" по умолчанию в нижнем колонтитуле. Этот текст должен быть в формате Юникода и не превышать 256 символов. Наследуется от организационных свойствBrandingProperties. |
| customTermsOfUseUrl | String | Настраиваемый URL-адрес, заменяющий URL-адрес гиперссылки "Условия использования" по умолчанию в нижнем колонтитуле. Этот URL-адрес должен иметь формат ASCII или символы, отличные от ASCII, должны быть закодированы и не должны превышать 128 символов. Наследуется от организационных свойствBrandingProperties. |
| favicon | Поток | Настраиваемый значок (favicon) для замены favicon продукта Майкрософт по умолчанию в клиенте Microsoft Entra. Наследуется от организационных свойствBrandingProperties. |
| faviconRelativeUrl | String | Относительный URL-адрес для favicon выше, который в сочетании с базовым URL-адресом CDN из cdnList предоставляет версию, обслуживаемую CDN. Только для чтения. Наследуется от организационных свойствBrandingProperties. |
| headerBackgroundColor | String | Цвет RGB, применяемый для настройки цвета заголовка. Наследуется от организационных свойствBrandingProperties. |
| headerLogo | Поток | Логотип компании, который отображается в заголовке страницы входа. Допустимые типы: PNG или JPEG размером не более 245 x 36 пикселей. Рекомендуется использовать прозрачное изображение без набивки вокруг логотипа. Наследуется от организационных свойствBrandingProperties. |
| headerLogoRelativeUrl | String | Относительный URL-адрес свойства headerLogo , который в сочетании с базовым URL-адресом CDN из cdnList предоставляет версию только для чтения, обслуживаемую CDN. Только для чтения. Наследуется от организационных свойствBrandingProperties. |
| id | String | Идентификатор, представляющий языковой стандарт, указанный с помощью имен языка и региональных параметров. Названия языка и региональных параметров соответствуют стандарту RFC 1766 в формате "languagecode2-country/regioncode2", где "languagecode2" — это строчные двухбуквенный код, производный от ISO 639-1, а "country/regioncode2" — двухбуквенный код, производный от ISO 3166. Например, английский (США) — .en-US
Идентификатором для фирменной символики по умолчанию всегда является тип 0 String или default. Только для чтения. ЗАМЕТКА: Несколько фирменных символов для одного языкового стандарта в настоящее время не поддерживаются. |
| loginPageLayoutConfiguration | loginPageLayoutConfiguration | Представляет конфигурацию макета, отображаемую на странице входа для клиента. Наследуется от организационных свойствBrandingProperties. |
| loginPageTextVisibilitySettings | loginPageTextVisibilitySettings | Представляет различные тексты, которые можно скрыть на странице входа для клиента. Наследуется от организационных свойствBrandingProperties. |
| signInPageText | String | Текст, отображаемый в нижней части поля входа. Используйте его для передачи дополнительных сведений, таких как номер телефона в службу поддержки или юридическое заявление. Текст должен быть в формате Юникода и не превышать 1024 символов. |
| squareLogo | Поток | Квадратная версия логотипа вашей компании, которая отображается в встроенных интерфейсах Windows 10 (OOBE) и при включении Windows Autopilot для развертывания. Допустимые типы: PNG или JPEG размером не более 240 x 240 пикселей и размером не более 10 КБ. Рекомендуется использовать прозрачное изображение без набивки вокруг логотипа. Наследуется от организационных свойствBrandingProperties. |
| squareLogoRelativeUrl | String | Относительный URL-адрес свойства squareLogo , который в сочетании с базовым URL-адресом CDN из cdnList предоставляет версию, обслуживаемую CDN. Только для чтения. Наследуется от организационных свойствBrandingProperties. |
| squareLogoDark | Поток | Квадратная темная версия логотипа вашей компании, которая отображается в встроенных интерфейсах Windows 10 (OOBE) и при включении Windows Autopilot для развертывания. Допустимые типы: PNG или JPEG размером не более 240 x 240 пикселей и размером не более 10 КБ. Рекомендуется использовать прозрачное изображение без набивки вокруг логотипа. Наследуется от организационных свойствBrandingProperties. |
| squareLogoDarkRelativeUrl | String | Относительный URL-адрес свойства squareLogoDark , объединенный с базовым URL-адресом CDN из cdnList для предоставления версии, обслуживаемой CDN. Только для чтения. Наследуется от организационных свойствBrandingProperties. |
| usernameHintText | String | Строка, которая отображается в виде подсказки в текстовом поле имя пользователя на экране входа. Этот текст должен быть юникодом, без ссылок или кода и не может превышать 64 символов. Наследуется от организационных свойствBrandingProperties. |
Связи
| Связь | Тип | Описание |
|---|---|---|
| Локализации | Коллекция 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"
}
}