tipo de recurso organizationalBranding
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.
Contém detalhes sobre a identidade visual padrão da organização. Herda de organizationalBrandingProperties.
As organizações podem personalizar suas páginas de entrada Microsoft Entra que aparecem quando os usuários acessam os aplicativos específicos de sua organização ou quando Microsoft Entra ID identifica o locatário do usuário em seu nome de usuário. Um desenvolvedor também pode ler as informações de identidade visual da empresa e personalizar sua experiência de aplicativo para adaptá-la especificamente para o usuário conectado usando a identidade visual de sua empresa.
Você não pode alterar o idioma da configuração original. No entanto, as empresas podem adicionar uma identidade visual diferente com base na localidade. Para uma identidade visual específica do idioma, consulte o objeto organizationalBrandingLocalization .
Observação
A adição de identidade visual personalizada exige Microsoft Entra ID que você tenha licenças P1 ou P2, Premium 2 ou Office 365 (para Office 365 aplicativos). Para obter mais informações sobre licenciamento e edições, consulte Inscrever-se para Microsoft Entra ID P1 ou P2.
Microsoft Entra ID edições P1 ou P2 estão disponíveis para clientes na China usando a instância mundial de Microsoft Entra ID. Microsoft Entra ID edições P1 ou P2 não têm suporte no serviço do Azure operado pela 21Vianet na China. Para obter mais informações, fale conosco usando o Fórum Microsoft Entra.
Métodos
| Método | Tipo de retorno | Descrição |
|---|---|---|
| Obter organizationalBranding | organizationalBranding | Leia as propriedades e as relações de um objeto organizationalBranding . |
| Atualizar organizationalBranding | Nenhum | Atualize as propriedades de um objeto organizationalBranding . |
Propriedades
| Propriedade | Tipo | Descrição |
|---|---|---|
| Backgroundcolor | Cadeia de caracteres | Cor que aparece no lugar da imagem de fundo em conexões de baixa largura de banda. Recomendamos que você use a cor primária do logotipo da faixa ou da cor da organização. Especifique isso no formato hexadecimal, por exemplo, o branco é #FFFFFF. Herdado de organizationalBrandingProperties. |
| Backgroundimage | Stream | Imagem que aparece como o plano de fundo da página de entrada. Os tipos permitidos são PNG ou JPEG não menores que 300 KB e não maiores que 1920 × 1080 pixels. Uma imagem menor reduzirá os requisitos de largura de banda e tornará a carga da página mais rápida. Herdado de organizationalBrandingProperties. |
| backgroundImageRelativeUrl | Cadeia de caracteres | Uma URL relativa para a propriedade backgroundImage que é combinada com uma URL base cdn da cdnList para fornecer a versão servida por uma CDN. Somente leitura. Herdado de organizationalBrandingProperties. |
| bannerLogo | Stream | Uma versão do banner do logotipo da sua empresa que aparece na página de entrada. Os tipos permitidos são PNG ou JPEG não maiores que 245 x 36 pixels. Recomendamos usar uma imagem transparente sem preenchimento ao redor do logotipo. Herdado de organizationalBrandingProperties. |
| bannerLogoRelativeUrl | Cadeia de caracteres | Uma URL relativa para a propriedade bannerLogo que é combinada com uma URL base cdn da cdnList para fornecer a versão somente leitura servida por uma CDN. Somente leitura. Herdado de organizationalBrandingProperties. |
| cdnList | Coleção de cadeias de caracteres | Uma lista de URLs base para todos os provedores de CDN disponíveis que estão atendendo os ativos do recurso atual. Vários provedores de CDN são usados ao mesmo tempo para alta disponibilidade de solicitações de leitura. Somente leitura. Herdado de organizationalBrandingProperties. |
| contentCustomization | contentCustomization | Representa as várias opções de conteúdo a serem personalizadas durante todo o fluxo de autenticação de um locatário. NOTA: Com suporte de Microsoft Entra ID somente para locatários de clientes. Herdado de organizationalBrandingProperties. |
| customAccountResetCredentialsUrl | Cadeia de caracteres | Uma URL personalizada para redefinir credenciais de conta. Essa URL deve estar no formato ASCII ou caracteres não ASCII devem ser codificados em URL e não exceder 128 caracteres. Herdado de organizationalBrandingProperties. |
| customCannotAccessYourAccountText | Cadeia de caracteres | Uma cadeia de caracteres para substituir o texto de hiperlink padrão "Não é possível acessar sua conta?" de redefinição de senha de autoatendimento (SSPR) na página de entrada. Este texto deve estar no formato Unicode e não exceder 256 caracteres. Herdado de organizationalBrandingProperties. |
| customCannotAccessYourAccountUrl | Cadeia de caracteres | Uma URL personalizada para substituir a URL padrão do hiperlink de redefinição de senha de autoatendimento (SSPR) "Não é possível acessar sua conta?" na página de entrada. Essa URL deve estar no formato ASCII ou caracteres não ASCII devem ser codificados em URL e não exceder 128 caracteres. NÃO USE. Em vez disso , use customAccountResetCredentialsUrl . Herdado de organizationalBrandingProperties. |
| customCSS | Stream | Estilo CSS que aparece na página de entrada. O formato permitido é .css formato somente e não maior que 25KB. Herdado de organizationalBrandingProperties. |
| customCSSRelativeUrl | Cadeia de caracteres | Uma URL relativa para a propriedade customCSS que é combinada com uma URL base cdn da cdnList para fornecer a versão servida por uma CDN. Somente leitura. Herdado de organizationalBrandingProperties. |
| customForgotMyPasswordText | Cadeia de caracteres | Uma cadeia de caracteres para substituir o texto padrão de hiperlink "Esqueci minha senha" no formulário de entrada. Este texto deve estar no formato Unicode e não exceder 256 caracteres. Herdado de organizationalBrandingProperties. |
| customPrivacyAndCookiesText | Cadeia de caracteres | Uma cadeia de caracteres para substituir o texto padrão de hiperlink "Privacidade e Cookies" no rodapé. Este texto deve estar no formato Unicode e não exceder 256 caracteres. Herdado de organizationalBrandingProperties. |
| customPrivacyAndCookiesUrl | Cadeia de caracteres | Uma URL personalizada para substituir a URL padrão do hiperlink "Privacidade e Cookies" no rodapé. Essa URL deve estar no formato ASCII ou caracteres não ASCII devem ser codificados em URL e não exceder 128 caracteres. Herdado de organizationalBrandingProperties. |
| customResetItNowText | Cadeia de caracteres | Uma cadeia de caracteres para substituir o texto padrão de hiperlink "redefini-lo agora" no formulário de entrada. Este texto deve estar no formato Unicode e não exceder 256 caracteres. NÃO USE: Atualmente, não há suporte para personalização do texto de hiperlink "redefini-lo agora". Herdado de organizationalBrandingProperties. |
| customTermsOfUseText | Cadeia de caracteres | Uma cadeia de caracteres para substituir o texto padrão de hiperlink "Termos de Uso" no rodapé. Este texto deve estar no formato Unicode e não exceder 256 caracteres. Herdado de organizationalBrandingProperties. |
| customTermsOfUseUrl | Cadeia de caracteres | Uma URL personalizada para substituir a URL padrão do hiperlink "Termos de Uso" no rodapé. Essa URL deve estar no formato ASCII ou caracteres não ASCII devem ser codificados em URL e não exceder 128 caracteres. Herdado de organizationalBrandingProperties. |
| Favicon | Stream | Um ícone personalizado (favicon) para substituir um favicon de produto da Microsoft padrão em um locatário Microsoft Entra. Herdado de organizationalBrandingProperties. |
| faviconRelativeUrl | Cadeia de caracteres | Uma url relativa para o favicon acima que é combinada com uma URL de base CDN da cdnList para fornecer a versão servida por uma CDN. Somente leitura. Herdado de organizationalBrandingProperties. |
| headerBackgroundColor | Cadeia de caracteres | A cor RGB a ser aplicada para personalizar a cor do cabeçalho. Herdado de organizationalBrandingProperties. |
| headerLogo | Stream | Um logotipo da empresa que aparece no cabeçalho da página de entrada. Os tipos permitidos são PNG ou JPEG não maiores que 245 x 36 pixels. Recomendamos usar uma imagem transparente sem preenchimento ao redor do logotipo. Herdado de organizationalBrandingProperties. |
| headerLogoRelativeUrl | Cadeia de caracteres | Uma URL relativa para a propriedade headerLogo que é combinada com uma URL de base CDN da cdnList para fornecer a versão somente leitura servida por uma CDN. Somente leitura. Herdado de organizationalBrandingProperties. |
| id | Cadeia de caracteres | Um identificador que representa a localidade especificada usando nomes de cultura. Os nomes de cultura seguem o padrão RFC 1766 no formato "languagecode2-country/regioncode2", em que "languagecode2" é um código de duas letras minúscula derivado do ISO 639-1 e "country/regioncode2" é um código maiúsculo de duas letras derivado do ISO 3166. Por exemplo, o inglês dos EUA é en-US. A ID para o padrão /branding é sempre os tipos 0 string ou default. Somente leitura. NOTA: No momento, não há suporte para várias marcas para uma única localidade. |
| loginPageLayoutConfiguration | loginPageLayoutConfiguration | Representa a configuração de layout a ser exibida na página de logon de um locatário. Herdado de organizationalBrandingProperties. |
| logonPageTextVisibilitySettings | logonPageTextVisibilitySettings | Representa os vários textos que podem ser ocultos na página de logon de um locatário. Herdado de organizationalBrandingProperties. |
| signInPageText | Cadeia de caracteres | Texto que aparece na parte inferior da caixa de entrada. Use isso para comunicar informações adicionais, como o número de telefone para seu balcão de ajuda ou uma instrução legal. Este texto deve estar no formato Unicode e não exceder 1024 caracteres. |
| squareLogo | Stream | Uma versão quadrada do logotipo da sua empresa que aparece em Windows 10 experiências fora de caixa (OOBE) e quando o Windows Autopilot está habilitado para implantação. Os tipos permitidos são PNG ou JPEG não maiores que 240 x 240 pixels e não mais de 10 KB de tamanho. Recomendamos usar uma imagem transparente sem preenchimento ao redor do logotipo. Herdado de organizationalBrandingProperties. |
| squareLogoRelativeUrl | Cadeia de caracteres | Uma URL relativa para a propriedade squareLogo que é combinada com uma URL base cdn da cdnList para fornecer a versão servida por uma CDN. Somente leitura. Herdado de organizationalBrandingProperties. |
| squareLogoDark | Stream | Uma versão escura quadrada do logotipo da sua empresa que aparece em Windows 10 experiências fora de caixa (OOBE) e quando o Windows Autopilot está habilitado para implantação. Os tipos permitidos são PNG ou JPEG não maiores que 240 x 240 pixels e não mais de 10 KB de tamanho. Recomendamos usar uma imagem transparente sem preenchimento ao redor do logotipo. Herdado de organizationalBrandingProperties. |
| squareLogoDarkRelativeUrl | Cadeia de caracteres | Uma URL relativa para a propriedade squareLogoDark que é combinada com uma URL base cdn da cdnList para fornecer a versão servida por uma CDN. Somente leitura. Herdado de organizationalBrandingProperties. |
| nome de usuárioHintText | Cadeia de caracteres | Uma cadeia de caracteres que mostra como a dica na caixa de texto nome de usuário na tela de entrada. Este texto deve ser um Unicode, sem links ou código, e não pode exceder 64 caracteres. Herdado de organizationalBrandingProperties. |
Relações
| Relação | Tipo | Descrição |
|---|---|---|
| Localizações | coleção organizationalBrandingLocalization | Adicione uma identidade visual diferente com base em uma localidade. |
Representação JSON
Veja a seguir uma representação JSON do recurso.
{
"@odata.type": "#microsoft.graph.organizationalBranding",
"id": "String (identifier)",
"backgroundColor": "String",
"backgroundImage": "Stream",
"backgroundImageRelativeUrl": "String",
"bannerLogo": "Stream",
"bannerLogoRelativeUrl": "String",
"cdnList": [
"String"
],
"signInPageText": "String",
"squareLogo": "Stream",
"squareLogoRelativeUrl": "String",
"squareLogoDark": "Stream",
"squareLogoDarkRelativeUrl": "String",
"usernameHintText": "String",
"contentCustomization": {
"@odata.type": "microsoft.graph.contentCustomization"
},
"customAccountResetCredentialsUrl": "String",
"customCannotAccessYourAccountText": "String",
"customCannotAccessYourAccountUrl": "String",
"customCSS": "Stream",
"customCSSRelativeUrl": "String",
"customForgotMyPasswordText": "String",
"customPrivacyAndCookiesText": "String",
"customPrivacyAndCookiesUrl": "String",
"customResetItNowText": "String",
"customTermsOfUseText": "String",
"customTermsOfUseUrl": "String",
"favicon": "Stream",
"faviconRelativeUrl": "String",
"headerBackgroundColor": "String",
"headerLogo": "Stream",
"headerLogoRelativeUrl": "String",
"loginPageLayoutConfiguration": {
"@odata.type": "microsoft.graph.loginPageLayoutConfiguration"
},
"loginPageTextVisibilitySettings": {
"@odata.type": "microsoft.graph.loginPageTextVisibilitySettings"
}
}
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de