Поделиться через


Обновление organizationalBrandingLocalization

Пространство имен: microsoft.graph

Обновите свойства объекта organizationalBrandingLocalization для конкретной локализации.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба Правительство США L4 Правительство США L5 (DOD) Китай управляется 21Vianet

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения Разрешения с наименьшими привилегиями Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись) OrganizationalBranding.ReadWrite.All Organization.ReadWrite.All
Делегированные (личная учетная запись Майкрософт) Не поддерживается. Не поддерживается.
Приложение OrganizationalBranding.ReadWrite.All Organization.ReadWrite.All

Важно!

В делегированных сценариях с рабочими или учебными учетными записями вошедшему пользователю должна быть назначена поддерживаемая роль Microsoft Entra или настраиваемая роль с разрешением поддерживаемой роли. Администратор фирменной символики организации — это наименее привилегированная роль, поддерживаемая для этой операции.

HTTP-запрос

Чтобы обновить типы данных String, такие как signInPageText и usernameHintText, используйте метод PATCH. Для обновления Stream типов данных, таких как backgroundLogo и backgroundImage, используйте метод PUT. Вы не можете обновить типы Stream с другими типами данных в том же запросе.

PATCH /organization/{organizationId}/branding/localizations/{organizationalBrandingLocalizationId}

PUT /organization/{organizationId}/branding/localizations/{organizationalBrandingLocalizationId}/{Stream object type such as backgroundImage}

Заголовки запросов

Имя Описание
Авторизация Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.
Content-Type application/json. Обязательно.

Текст запроса

Укажите в тексте запроса только значения обновляемых свойств. Предыдущие значения существующих свойств, не включенных в текст запроса, будут сохранены или вычислены повторно с учетом изменений, внесенных в значения других свойств.

В следующей таблице указаны свойства, которые можно обновить.

Свойство Тип Описание
backgroundColor String Цвет, который будет отображаться вместо фонового изображения в подключениях с низкой пропускной способностью. Рекомендуется использовать основной цвет логотипа баннера или цвет организации. Укажите его в шестнадцатеричном формате, например белый — #FFFFFF.
backgroundImage Поток Изображение, отображающееся в качестве фона страницы входа. Допустимые типы: PNG или JPEG размером не менее 300 КБ и размером не более 1920 × 1080 пикселей. Изображение меньшего размера снизит требования к пропускной способности и ускорит загрузку страницы.
bannerLogo Поток Баннерная версия логотипа вашей компании, которая отображается на странице входа. Допустимые типы: PNG или JPEG размером не более 36 × 245 пикселей. Рекомендуется использовать прозрачное изображение без набивки вокруг логотипа.
signInPageText String Текст, отображаемый в нижней части поля входа. Его можно использовать для передачи дополнительных сведений, таких как номер телефона в службу поддержки или юридическое заявление. Этот текст должен содержать юникод и не превышать 1024 символов.
squareLogo Поток Квадратная версия логотипа вашей компании, которая отображается в Windows 10 встроенных интерфейсов (OOBE) и при включении Windows Autopilot для развертывания. Допустимые типы: PNG или JPEG размером не более 240 x 240 пикселей и размером не более 10 КБ. Рекомендуется использовать прозрачное изображение без набивки вокруг логотипа.
usernameHintText String Строка, которая отображается в виде подсказки в текстовом поле имя пользователя на экране входа. Этот текст должен быть юникодом, без ссылок или кода и не может превышать 64 символов.

Отклик

В случае успешного выполнения этот метод возвращает код отклика 204 No Content.

Примеры

Пример 1. Настройка bannerLogo для локализации fr-FR с помощью PUT

Следующий запрос обновляет логотип баннера для локализации fr-FR.

Запрос

Ниже показан пример запроса.

PUT https://graph.microsoft.com/v1.0/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/fr-FR/bannerLogo
Content-Type: image/jpeg

<Image>

Отклик

HTTP/1.1 204 NO CONTENT

Пример 2. Обновление backgroundColor и signInPageText для локализации fr-FR с помощью PATCH

Следующий запрос обновляет логотип баннера для локализации fr-FR .

Запрос

Ниже показан пример запроса.

PATCH https://graph.microsoft.com/v1.0/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/fr-FR
Content-Type: application/json

{
    "backgroundColor":"#00000F",
    "signInPageText": "Welcome to Contoso France"
}

Отклик

HTTP/1.1 204 No Content

Пример 3. Переопределение значения фирменной символики по умолчанию пустой строкой

Запрос

Ниже показан пример запроса.

PATCH https://graph.microsoft.com/v1.0/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/fr-FR
Content-Type: application/json

{
    "signInPageText": "Welcome to Contoso France.",
    "usernameHintText":" "
}

Отклик

HTTP/1.1 204 No Content

После этого запроса usernameHintText для fr-FR локализации будет пустым вместо наследования значения от объекта фирменной символики по умолчанию.