Получение organizationalBrandingLocalization
Пространство имен: microsoft.graph
Важно!
API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Чтение свойств и связей объекта organizationalBrandingLocalization . Чтобы получить объект фирменной символики локализации, укажите значение id в URL-адресе.
Этот API доступен в следующих национальных облачных развертываниях.
| Глобальная служба | Правительство США L4 | Правительство США L5 (DOD) | Китай управляется 21Vianet |
|---|---|---|---|
| ✅ | ✅ | ✅ | ✅ |
Разрешения
Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.
| Тип разрешения | Разрешения с наименьшими привилегиями | Более высокие привилегированные разрешения |
|---|---|---|
| Делегированные (рабочая или учебная учетная запись) | User.Read | Organization.Read.All, Organization.ReadWrite.All, OrganizationBranding.Read.All, OrganizationBranding.ReadWrite.All, User.Read.All |
| Делегированные (личная учетная запись Майкрософт) | Не поддерживается. | Не поддерживается. |
| Приложение | OrganizationalBranding.Read.All | Organization.Read.All, Organization.ReadWrite.All, OrganizationBranding.ReadWrite.All |
Важно!
В делегированных сценариях с рабочими или учебными учетными записями вошедшему пользователю должна быть назначена поддерживаемая роль Microsoft Entra или настраиваемая роль с разрешением поддерживаемой роли. Глобальный читатель или администратор фирменной символики организации — это наименее привилегированные роли, поддерживаемые для этой операции.
HTTP-запрос
GET /organization/{organizationId}/branding/localizations/{organizationalBrandingLocalizationId}
Заголовки запросов
| Имя | Описание |
|---|---|
| Авторизация | Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации. |
Текст запроса
Не указывайте текст запроса для этого метода.
Отклик
В случае успешного выполнения этот метод возвращает код отклика 200 OK и объект organizationalBrandingLocalization в теле отклика.
Примеры
Пример 1. Получение локализованной фирменной символики для определенного языкового стандарта (fr-FR)
Запрос
Ниже показан пример запроса.
GET https://graph.microsoft.com/beta/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/fr-FR
Отклик
Ниже показан пример отклика.
Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#organization('99b24e1b-abec-4598-9d63-a2baf0a3cea1')/branding/localizations/$entity",
"@odata.type": "#microsoft.graph.organizationalBrandingProperties",
"@odata.id": "https://graph.microsoft.com/v2/99b24e1b-abec-4598-9d63-a2baf0a3cea1/directoryObjects/$/Microsoft.DirectoryServices.Organization('99b24e1b-abec-4598-9d63-a2baf0a3cea1')//localizations('fr-FR')/fr-FR",
"id": "fr-FR",
"backgroundColor": " ",
"backgroundImageRelativeUrl": null,
"bannerLogoRelativeUrl": "c1c6b6c8-urr-dzbkz44n5kuo9kzl1kziuujjcdqonoe2owyacso/logintenantbranding/1036/bannerlogo?ts=637673868626068858",
"cdnList": [
"secure.aadcdn.microsoftonline-p.com",
"aadcdn.msftauthimages.net",
"aadcdn.msauthimages.net"
],
"contentCustomization": {
"attributeCollectionRelativeUrl": "dbd5a2dd-dt17xdjgu8kxc14xcav-rckknamct7yytiih-vm-ksm/logintenantbranding/1033/attributecollection?ts=638151133931615483",
"attributeCollection": [
{
"key": "AttributeCollection_Description",
"value": "We just need a little more information to set up your account."
},
{
"key": "AttributeCollection_Title",
"value": "Add details"
},
{
"key": "Attribute_City",
"value": "City"
},
{
"key": "Attribute_Country",
"value": "Country/Region"
},
{
"key": "Attribute_DisplayName",
"value": "Display Name"
},
{
"key": "Attribute_Email",
"value": "Email Address"
},
{
"key": "Attribute_Generic_ConfirmationLabel",
"value": "Re-enter"
},
{
"key": "Attribute_GivenName",
"value": "Given Name"
},
{
"key": "Attribute_JobTitle",
"value": "Job Title"
},
{
"key": "Attribute_Password",
"value": "Password"
},
{
"key": "Attribute_Password_MismatchErrorString",
"value": "Passwords do not match."
},
{
"key": "Attribute_PostalCode",
"value": "Postal Code"
},
{
"key": "Attribute_State",
"value": "State/Province"
},
{
"key": "Attribute_StreetAddress",
"value": "Street Address"
},
{
"key": "Attribute_Surname",
"value": "Sasha Surname"
},
{
"key": "SignIn_Description",
"value": "Sign in to access"
},
{
"key": "SignIn_Title",
"value": "Sign in"
},
{
"key": "SignUp_Description",
"value": "Sign up to access"
},
{
"key": "SignUp_Title",
"value": "Create account"
},
{
"key": "SisuOtc_Title",
"value": "Enter code"
},
{
"key": "Attribute_extension_82936c774db949fcac549215e8857017_Total_Job_Experience_Years",
"value": "Total_Job_Experience_Years"
}
]
},
"customAccountResetCredentialsUrl": null,
"customCannotAccessYourAccountText": null,
"customCannotAccessYourAccountUrl": null,
"customCSS": null,
"customCSSRelativetUrl": null,
"customForgotMyPasswordText": null,
"customPrivacyAndCookiesText": null,
"customPrivacyAndCookiesUrl": null,
"customTermsOfUseText": null,
"customTermsOfUseUrl": null,
"customResetItNowText": null,
"faviconRelativeUrl": null,
"headerBackgroundColor": null,
"headerLogoRelativeUrl": null,
"signInPageText": "Contoso",
"squareLogoRelativeUrl": "c1c6b6c8-urr-dzbkz44n5kuo9kzl1kziuujjcdqonoe2owyacso/logintenantbranding/0/tilelogo?ts=637535563832888580",
"squareLogoDarkRelativeUrl": "c1c6b6c8-urr-dzbkz44n5kuo9kzl1kziuujjcdqonoe2owyacso/logintenantbranding/0/tilelogo?ts=637535563832888580",
"usernameHintText": " ",
"loginPageLayoutConfiguration": {
"layoutTemplateType": "default",
"isHeaderShown": false,
"isFooterShown": true
},
"loginPageTextVisibilitySettings": {
"hideCannotAccessYourAccount": false,
"hideForgotMyPassword": false,
"hideResetItNow": false,
"hideTermsOfUse": true,
"hidePrivacyAndCookies": true
}
}
Пример 2. Получение значения signInPageText для определенного языкового стандарта
Запрос
Ниже показан пример запроса.
GET https://graph.microsoft.com/beta/organization/99b24e1b-abec-4598-9d63-a2baf0a3cea1/branding/localizations/fr-FR/signInPageText
Отклик
Ниже показан пример отклика.
Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#organization('99b24e1b-abec-4598-9d63-a2baf0a3cea1')/branding/localizations('fr-FR')/usernameHintText",
"value": "Welcome to Contoso France"
}
Пример 3. Получение баннерного журнала для языкового стандарта по умолчанию
В следующем примере возвращается объект bannerLogo для языкового стандарта по умолчанию. Идентификатор можно указать какdefault или 0 в URL-адресе запроса. Если объект не задан, запрос возвращает пустой ответ.
Запрос
Ниже показан пример запроса.
GET https://graph.microsoft.com/beta/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/default/bannerLogo
Отклик
Ниже показан пример отклика.
HTTP/1.1 200 OK
Content-Type: image/*
<Image>
Пример 4. Получение bannerLogo для языкового стандарта fr-FR
В следующем примере возвращается объект bannerLogo для языкового fr-FR стандарта, для которого не задано значение bannerLogo.
Запрос
Ниже показан пример запроса.
GET https://graph.microsoft.com/beta/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/default/bannerLogo
Отклик
Ниже приводится пример отклика.
HTTP/1.1 200 OK
{}