Obter organizationalBrandingLocalization
Namespace: microsoft.graph
Importante
As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.
Leia as propriedades e relações de um objeto organizationalBrandingLocalization . Para obter um objeto de imagem corporativa de localização, especifique o valor do ID no URL.
Esta API está disponível nas seguintes implementações de cloud nacionais.
| Serviço global | US Government L4 | US Government L5 (DOD) | China operada pela 21Vianet |
|---|---|---|---|
| ✅ | ✅ | ✅ | ✅ |
Permissões
Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.
| Tipo de permissão | Permissões com menos privilégios | Permissões com privilégios superiores |
|---|---|---|
| Delegado (conta corporativa ou de estudante) | User.Read | Organization.Read.All, Organization.ReadWrite.All, OrganizationalBranding.Read.All, OrganizationalBranding.ReadWrite.All, User.Read.All |
| Delegado (conta pessoal da Microsoft) | Sem suporte. | Sem suporte. |
| Application | OrganizationalBranding.Read.All | Organization.Read.All, Organization.ReadWrite.All, OrganizationalBranding.ReadWrite.All |
Importante
Em cenários delegados com contas escolares ou profissionais, o utilizador com sessão iniciada tem de ter uma função de Microsoft Entra suportada ou uma função personalizada com uma permissão de função suportada. O Leitor Global ou o Administrador de Imagem Corporativa Organizacional são as funções com menos privilégios suportadas para esta operação.
Solicitação HTTP
GET /organization/{organizationId}/branding/localizations/{organizationalBrandingLocalizationId}
Cabeçalhos de solicitação
| Nome | Descrição |
|---|---|
| Autorização | {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização. |
Corpo da solicitação
Não forneça um corpo de solicitação para esse método.
Resposta
Se for bem-sucedido, este método devolve um 200 OK código de resposta e um objeto organizationalBrandingLocalization no corpo da resposta.
Exemplos
Exemplo 1: Obter a imagem corporativa localizada para uma região específica (fr-FR)
Solicitação
O exemplo a seguir mostra uma solicitação.
GET https://graph.microsoft.com/beta/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/fr-FR
Resposta
O exemplo a seguir mostra a resposta.
Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.
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
}
}
Exemplo 2: Obter o valor de signInPageText para uma região específica
Solicitação
O exemplo a seguir mostra uma solicitação.
GET https://graph.microsoft.com/beta/organization/99b24e1b-abec-4598-9d63-a2baf0a3cea1/branding/localizations/fr-FR/signInPageText
Resposta
O exemplo a seguir mostra a resposta.
Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.
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"
}
Exemplo 3: Obter o bannerLogo para a região predefinida
O exemplo seguinte devolve o objeto bannerLogo para a região predefinida. Pode especificar o ID como default ou 0 no URL do pedido. Se o objeto não estiver definido, o pedido devolve uma resposta vazia.
Solicitação
O exemplo a seguir mostra uma solicitação.
GET https://graph.microsoft.com/beta/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/default/bannerLogo
Resposta
O exemplo a seguir mostra a resposta.
HTTP/1.1 200 OK
Content-Type: image/*
<Image>
Exemplo 4: Obter o bannerLogo para a região fr-FR
O exemplo seguinte devolve o objeto bannerLogo para a fr-FR região cuja faixaLogo não está definida.
Solicitação
O exemplo a seguir mostra uma solicitação.
GET https://graph.microsoft.com/beta/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/default/bannerLogo
Resposta
O exemplo a seguir mostra a resposta.
HTTP/1.1 200 OK
{}