Обновление organizationalBranding

Статья
12/04/2023

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

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Обновите свойства объекта фирменной символики по умолчанию, заданного ресурсом организационного бренда .

Этот 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
PUT /organization/{organizationId}/branding/localizations/{organizationalBrandingLocalizationId}/{Stream object type such as backgroundImage}

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

Имя	Описание
Авторизация	Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.
Content-Type	application/json. Обязательно.
Принять-Язык	Допустимый языковой стандарт ISO 639-1 или `0` для языкового стандарта по умолчанию. Обязательно.

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

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

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

Свойство	Тип	Описание
backgroundColor	String	Цвет, который отображается вместо фонового изображения в подключениях с низкой пропускной способностью. Рекомендуется использовать основной цвет логотипа баннера или цвет организации. Укажите его в шестнадцатеричном формате, например белый — `#FFFFFF`.
backgroundImage	Поток	Изображение, отображающееся в качестве фона страницы входа. Допустимые типы: PNG или JPEG размером не менее 300 КБ и размером не более 1920 × 1080 пикселей. Изображение меньшего размера снизит требования к пропускной способности и ускорит загрузку страницы.
bannerLogo	Поток	Баннерная версия логотипа вашей компании, которая отображается на странице входа. Допустимые типы: PNG или JPEG размером не более 245 x 36 пикселей. Рекомендуется использовать прозрачное изображение без набивки вокруг логотипа.
contentНастройка	contentНастройка	Представляет различные параметры содержимого, которые необходимо настроить в потоке проверки подлинности для клиента. ЗАМЕТКА: Поддерживается Microsoft Entra ID только для клиентов.
customAccountResetCredentialsUrl	String	Настраиваемый URL-адрес для сброса учетных данных учетной записи. Этот URL-адрес должен быть в формате ASCII или символы, отличные от ASCII, должны быть закодированы и не должны превышать 128 символов.
customCannotAccessYourAccountText	String	Строка, заменяющая текст гиперссылки по умолчанию "Не удается получить доступ к учетной записи?" для самостоятельного сброса пароля (SSPR) на странице входа. Этот текст должен быть в формате Юникода и не превышать 256 символов.
customCSS	Поток	Стили CSS, отображаемые на странице входа. Допустимый формат только .css и не превышает 25 КБ.
customForgotMyPasswordText	String	Строка, заменяющая текст гиперссылки по умолчанию "Забыли пароль" в форме входа. Этот текст должен быть в формате Юникода и не превышать 256 символов.
customPrivacyAndCookiesText	String	Строка, заменяющая текст гиперссылки по умолчанию "Конфиденциальность и файлы cookie" в нижнем колонтитуле. Этот текст должен быть в формате Юникода и не превышать 256 символов.
customPrivacyAndCookiesUrl	String	Настраиваемый URL-адрес, заменяющий URL-адрес гиперссылки "Конфиденциальность и файлы cookie" по умолчанию в нижнем колонтитуле. Этот URL-адрес должен быть в формате ASCII или символы, отличные от ASCII, должны быть закодированы и не должны превышать 128 символов.
customTermsOfUseText	String	Строка для замены текста гиперссылки "Условия использования" по умолчанию в нижнем колонтитуле. Этот текст должен быть в формате Юникода и не превышать 256 символов.
customTermsOfUseUrl	String	Настраиваемый URL-адрес, заменяющий URL-адрес гиперссылки "Условия использования" по умолчанию в нижнем колонтитуле. Этот URL-адрес должен иметь формат ASCII или символы, отличные от ASCII, должны быть закодированы и не должны превышать 128 символов.
favicon	Поток	Настраиваемый значок (favicon) для замены favicon продукта Майкрософт по умолчанию в клиенте Microsoft Entra.
headerBackgroundColor	String	Цвет RGB, применяемый для настройки цвета заголовка.
headerLogo	Поток	Логотип компании, который отображается в заголовке страницы входа. Допустимые типы: PNG или JPEG размером не более 245 x 36 пикселей. Рекомендуется использовать прозрачное изображение без набивки вокруг логотипа.
loginPageLayoutConfiguration	loginPageLayoutConfiguration	Представляет конфигурацию макета, отображаемую на странице входа для клиента.
loginPageTextVisibilitySettings	loginPageTextVisibilitySettings	Представляет различные тексты, которые можно скрыть на странице входа для клиента. Все свойства можно обновить.
signInPageText	String	Текст, отображаемый в нижней части поля входа. Используйте его для передачи дополнительных сведений, таких как номер телефона в службу поддержки или юридическое заявление. Текст должен быть в формате Юникода и не превышать 1024 символов.
squareLogo	Поток	Квадратная версия логотипа вашей компании, которая отображается в Windows 10 встроенных интерфейсов (OOBE) и при включении Windows Autopilot для развертывания. Допустимые типы: PNG или JPEG размером не более 240 x 240 пикселей и размером не более 10 КБ. Рекомендуется использовать прозрачное изображение без набивки вокруг логотипа.
squareLogoDark	Поток	Квадратная темная версия логотипа компании, которая отображается в Windows 10 встроенных интерфейсов (OOBE) и при включении Windows Autopilot для развертывания. Допустимые типы: PNG или JPEG размером не более 240 x 240 пикселей и размером не более 10 КБ. Рекомендуется использовать прозрачное изображение без набивки вокруг логотипа.
usernameHintText	String	Строка, которая отображается в виде подсказки в текстовом поле имя пользователя на экране входа. Этот текст должен быть юникодом, без ссылок или кода и не может превышать 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"
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new OrganizationalBranding
{
	SignInPageText = "Default",
	UsernameHintText = "DefaultHint",
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Organization["{organization-id}"].Branding.PatchAsync(requestBody, (requestConfiguration) =>
{
	requestConfiguration.Headers.Add("Accept-Language", "0");
});

Важно!

Пакеты SDK для Microsoft Graph по умолчанию используют версию API версии 1.0 и поддерживают не все типы, свойства и API, доступные в бета-версии. Дополнительные сведения о доступе к бета-API с помощью SDK см. в статье Использование пакетов Microsoft Graph SDK с бета-API.

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.



mgc-beta organization branding patch --organization-id {organization-id} --body '{\
    "signInPageText":"Default",\
    "usernameHintText":"DefaultHint"\
}\
'

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  abstractions "github.com/microsoft/kiota-abstractions-go"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  graphorganization "github.com/microsoftgraph/msgraph-beta-sdk-go/organization"
	  //other-imports
)

headers := abstractions.NewRequestHeaders()
headers.Add("Accept-Language", "0")

configuration := &graphorganization.OrganizationItemBrandingRequestBuilderPatchRequestConfiguration{
	Headers: headers,
}
requestBody := graphmodels.NewOrganizationalBranding()
signInPageText := "Default"
requestBody.SetSignInPageText(&signInPageText) 
usernameHintText := "DefaultHint"
requestBody.SetUsernameHintText(&usernameHintText) 

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
branding, err := graphClient.Organization().ByOrganizationId("organization-id").Branding().Patch(context.Background(), requestBody, configuration)

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

OrganizationalBranding organizationalBranding = new OrganizationalBranding();
organizationalBranding.setSignInPageText("Default");
organizationalBranding.setUsernameHintText("DefaultHint");
OrganizationalBranding result = graphClient.organization().byOrganizationId("{organization-id}").branding().patch(organizationalBranding, requestConfiguration -> {
	requestConfiguration.headers.add("Accept-Language", "0");
});

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


const options = {
	authProvider,
};

const client = Client.init(options);

const organizationalBranding = {
    signInPageText: 'Default',
    usernameHintText: 'DefaultHint'
};

await client.api('/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding')
	.version('beta')
	.update(organizationalBranding);

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Organization\Item\Branding\BrandingRequestBuilderPatchRequestConfiguration;
use Microsoft\Graph\Beta\Generated\Models\OrganizationalBranding;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new OrganizationalBranding();
$requestBody->setSignInPageText('Default');
$requestBody->setUsernameHintText('DefaultHint');
$requestConfiguration = new BrandingRequestBuilderPatchRequestConfiguration();
$headers = [
		'Accept-Language' => '0',
	];
$requestConfiguration->headers = $headers;


$result = $graphServiceClient->organization()->byOrganizationId('organization-id')->branding()->patch($requestBody, $requestConfiguration)->wait();

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement

$params = @{
	signInPageText = "Default"
	usernameHintText = "DefaultHint"
}

Update-MgBetaOrganizationBranding -OrganizationId $organizationId -BodyParameter $params

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.organization.item.branding.branding_request_builder import BrandingRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
from msgraph_beta.generated.models.organizational_branding import OrganizationalBranding
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = OrganizationalBranding(
	sign_in_page_text = "Default",
	username_hint_text = "DefaultHint",
)

request_configuration = RequestConfiguration()
request_configuration.headers.add("Accept-Language", "0")


result = await graph_client.organization.by_organization_id('organization-id').branding.patch(request_body, request_configuration = request_configuration)

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Отклик

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

HTTP/1.1 204 No Content

Пример 2. Обновление bannerLogo для фирменной символики по умолчанию

Следующий запрос обновляет логотип баннера для фирменной символики по умолчанию. Чтобы обновить тип объекта Stream, используйте метод HTTP PUT и включите идентификатор языкового стандарта в URL-путь.

Запрос

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

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

<Image>

Snippet not available

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.



mgc-beta organization branding localizations banner-logo put --organization-id {organization-id} --organizational-branding-localization-id {organizationalBrandingLocalization-id}

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Snippet not available

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Snippet not available

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


const options = {
	authProvider,
};

const client = Client.init(options);

const stream = <Image>;

await client.api('/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/0/bannerLogo')
	.version('beta')
	.put(stream);

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Snippet not available

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement

$params = Binary data for the image

Set-MgBetaOrganizationBrandingLocalizationBannerLogo -OrganizationId $organizationId -OrganizationalBrandingLocalizationId $organizationalBrandingLocalizationId -BodyParameter $params

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Snippet not available

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Отклик

Ниже приводится пример отклика.

HTTP/1.1 204 No Content

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

Обновление organizationalBranding

Разрешения

HTTP-запрос

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

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

Отклик

Примеры

Пример 1. Обновление фирменной символики по умолчанию

Запрос

Отклик

Пример 2. Обновление bannerLogo для фирменной символики по умолчанию

Запрос

Отклик

Обратная связь

Дополнительные ресурсы