Get organizationalBrandingLocalization
命名空间:microsoft.graph
重要
Microsoft Graph /beta
版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
读取 organizationalBrandingLocalization 对象的属性和关系。 若要检索本地化品牌对象,请在 URL 中指定 ID 值。
此 API 可用于以下国家级云部署。
全局服务 | 美国政府 L4 | 美国政府 L5 (DOD) | 由世纪互联运营的中国 |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
权限
为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
权限类型 | 最低特权权限 | 更高特权权限 |
---|---|---|
委派(工作或学校帐户) | User.Read | Organization.Read.All、Organization.ReadWrite.All、OrganizationBranding.Read.All、OrganizationBranding.ReadWrite.All、User.Read.All |
委派(个人 Microsoft 帐户) | 不支持。 | 不支持。 |
应用程序 | OrganizationalBranding.Read.All | Organization.Read.All、Organization.ReadWrite.All、OrganizationBranding.ReadWrite.All |
重要
在具有工作或学校帐户的委托方案中,必须为登录用户分配受支持的Microsoft Entra角色或具有支持的角色权限的自定义角色。 全局读取者 或 组织品牌管理员 是此操作支持的最低特权角色。
HTTP 请求
GET /organization/{organizationId}/branding/localizations/{organizationalBrandingLocalizationId}
请求标头
名称 | 说明 |
---|---|
Authorization | 持有者 {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
以下示例返回默认区域设置的 bannerLogo 对象。 可以在请求 URL 中将 ID 指定为 default
或 0
。 如果未设置对象,请求将返回空响应。
请求
以下示例显示了一个请求。
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:获取 fr-FR 区域设置的 bannerLogo
以下示例返回未设置 其 bannerLogo 的区域设置的 bannerLogo 对象 fr-FR
。
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/beta/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/default/bannerLogo
响应
以下示例显示了相应的响应。
HTTP/1.1 200 OK
{}