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 imagem corporativa predefinida da organização. Herda de organizationalBrandingProperties.
As organizações podem personalizar as respetivas páginas de início de sessão do Microsoft Entra que aparecem quando os utilizadores iniciam sessão nas aplicações específicas do inquilino da organização ou quando o Microsoft Entra ID identifica o inquilino do utilizador a partir do nome de utilizador. Um programador também pode ler as informações de imagem corporativa da empresa e personalizar a sua experiência de aplicação para personalizá-la especificamente para o utilizador com sessão iniciada através da imagem corporativa da empresa.
Não pode alterar o idioma da configuração original. No entanto, as empresas podem adicionar uma imagem corporativa diferente com base na região. Para obter uma imagem corporativa específica da linguagem, veja o objeto organizationalBrandingLocalization .
Observação
A adição de imagem corporativa personalizada requer que tenha licenças do Microsoft Entra ID P1 ou P2, Premium 2 ou Office 365 (para aplicações do Office 365). Para obter mais informações sobre licenciamento e edições, consulte Inscrever-se no Microsoft Entra ID P1 ou P2.
As edições Microsoft Entra ID P1 ou P2 estão disponíveis para clientes na China que utilizam a instância mundial do Microsoft Entra ID. As edições Microsoft Entra ID P1 ou P2 não são atualmente suportadas no serviço do Azure operado pela 21Vianet na China. Para obter mais informações, fale connosco através do Fórum do Microsoft Entra.
Métodos
| Método | Tipo de retorno | Descrição |
|---|---|---|
| Get | organizationalBranding | Leia as propriedades e relações de um objeto organizationalBranding . |
| Atualizar | Nenhum(a) | Atualize as propriedades de um objeto organizationalBranding . |
Propriedades
| Propriedade | Tipo | Descrição |
|---|---|---|
| backgroundColor | Cadeia de caracteres | Cor que aparece em vez da imagem de fundo em ligações de largura de banda baixa. Recomendamos que utilize a cor primária do logótipo da faixa ou a cor da sua organização. Especifique-o no formato hexadecimal, por exemplo, branco é #FFFFFF. Herdado de organizationalBrandingProperties. |
| backgroundImage | Stream | Imagem que aparece como o fundo da página de início de sessão. Os tipos permitidos são PNG ou JPEG não inferiores a 300 KB e não são superiores a 1920 × 1080 píxeis. Uma imagem mais pequena reduzirá os requisitos de largura de banda e tornará o carregamento da página mais rápido. Herdado de organizationalBrandingProperties. |
| backgroundImageRelativeUrl | Cadeia de caracteres | Um URL relativo para a propriedade backgroundImage que é combinado com um URL base da CDN da cdnList para fornecer a versão servida por uma CDN. Somente leitura. Herdado de organizationalBrandingProperties. |
| bannerLogo | Stream | Uma versão de faixa do logótipo da sua empresa que aparece na página de início de sessão. Os tipos permitidos são PNG ou JPEG não superiores a 245 x 36 pixels. Recomendamos que utilize uma imagem transparente sem preenchimento à volta do logótipo. Herdado de organizationalBrandingProperties. |
| bannerLogoRelativeUrl | Cadeia de caracteres | Um URL relativo para a propriedade bannerLogo que é combinado com um URL base da CDN da cdnList para fornecer a versão só de 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 fornecedores de CDN disponíveis que estão a servir os recursos do recurso atual. São utilizados vários fornecedores de CDN ao mesmo tempo para elevada disponibilidade de pedidos de leitura. Somente leitura. Herdado de organizationalBrandingProperties. |
| contentCustomization | contentCustomization | Representa as várias opções de conteúdo a personalizar ao longo do fluxo de autenticação de um inquilino. NOTA: Suportado pelo ID do Microsoft Entra apenas para inquilinos de clientes. Herdado de organizationalBrandingProperties. |
| customAccountResetCredentialsUrl | Cadeia de caracteres | Um URL personalizado para repor as credenciais da conta. Este URL tem de estar no formato ASCII ou os carateres não ASCII têm de ser codificados por URL e não exceder os 128 carateres. Herdado de organizationalBrandingProperties. |
| customCannotAccessYourAccountText | Cadeia de caracteres | Uma cadeia de carateres para substituir o texto de hiperligação predefinido "Não é possível aceder à sua conta?" de reposição personalizada de palavra-passe (SSPR) na página de início de sessão. Este texto tem de estar no formato Unicode e não exceder os 256 carateres. Herdado de organizationalBrandingProperties. |
| customCannotAccessYourAccountUrl | Cadeia de caracteres | Um URL personalizado para substituir o URL predefinido da reposição personalizada de palavra-passe (SSPR) "Não consegue aceder à sua conta?" na página de início de sessão. Este URL tem de estar no formato ASCII ou os carateres não ASCII têm de ser codificados por URL e não exceder os 128 carateres. NÃO UTILIZE. Em alternativa , utilize customAccountResetCredentialsUrl . Herdado de organizationalBrandingProperties. |
| customCSS | Stream | Estilo CSS que aparece na página de início de sessão. O formato permitido é apenas .css formato e não é superior a 25 KB. Herdado de organizationalBrandingProperties. |
| customCSSRelativeUrl | Cadeia de caracteres | Um URL relativo para a propriedade customCSS que é combinado com um URL base da CDN da cdnList para fornecer a versão servida por uma CDN. Somente leitura. Herdado de organizationalBrandingProperties. |
| customForgotMyPasswordText | Cadeia de caracteres | Uma cadeia para substituir o texto de hiperligação predefinido "Esqueci-me da palavra-passe" no formulário de início de sessão. Este texto tem de estar no formato Unicode e não exceder os 256 carateres. Herdado de organizationalBrandingProperties. |
| customPrivacyAndCookiesText | Cadeia de caracteres | Uma cadeia para substituir o texto de hiperligação predefinido "Privacidade e cookies" no rodapé. Este texto tem de estar no formato Unicode e não exceder os 256 carateres. Herdado de organizationalBrandingProperties. |
| customPrivacyAndCookiesUrl | Cadeia de caracteres | Um URL personalizado para substituir o URL predefinido da hiperligação "Privacidade e cookies" no rodapé. Este URL tem de estar no formato ASCII ou os carateres não ASCII têm de ser codificados por URL e não exceder os 128 carateres. Herdado de organizationalBrandingProperties. |
| customResetItNowText | Cadeia de caracteres | Uma cadeia para substituir o texto de hiperligação predefinido "repor agora" no formulário de início de sessão. Este texto tem de estar no formato Unicode e não exceder os 256 carateres. NÃO UTILIZAR: A personalização do texto de hiperligação "repor agora" não é atualmente suportada. Herdado de organizationalBrandingProperties. |
| customTermsOfUseText | Cadeia de caracteres | Uma cadeia para substituir o texto de hiperligação predefinido "Termos de Utilização" no rodapé. Este texto tem de estar no formato Unicode e não exceder os 256 carateres. Herdado de organizationalBrandingProperties. |
| customTermsOfUseUrl | Cadeia de caracteres | Um URL personalizado para substituir o URL predefinido da hiperligação "Termos de Utilização" no rodapé. Este URL tem de estar no formato ASCII ou os carateres não ASCII têm de ter codificação de URL e não exceder 128 carateres. Herdado de organizationalBrandingProperties. |
| favicon | Stream | Um ícone personalizado (favicon) para substituir um favicon de produto Microsoft predefinido num inquilino do Microsoft Entra. Herdado de organizationalBrandingProperties. |
| faviconRelativeUrl | Cadeia de caracteres | Um URL relativo para o favicon acima combinado com um URL base da CDN da cdnList para fornecer a versão fornecida por uma CDN. Somente leitura. Herdado de organizationalBrandingProperties. |
| headerBackgroundColor | Cadeia de caracteres | A cor RGB a aplicar para personalizar a cor do cabeçalho. Herdado de organizationalBrandingProperties. |
| headerLogo | Stream | Um logótipo da empresa que aparece no cabeçalho da página de início de sessão. Os tipos permitidos são PNG ou JPEG não superiores a 245 x 36 pixels. Recomendamos que utilize uma imagem transparente sem preenchimento à volta do logótipo. Herdado de organizationalBrandingProperties. |
| headerLogoRelativeUrl | Cadeia de caracteres | Um URL relativo para a propriedade headerLogo que é combinado com um URL base da CDN da cdnList para fornecer a versão só de leitura servida por uma CDN. Somente leitura. Herdado de organizationalBrandingProperties. |
| id | Cadeia de caracteres | Um identificador que representa a região especificada através de nomes de cultura. Os nomes de cultura seguem a norma RFC 1766 no formato "languagecode2-country/regioncode2", em que "languagecode2" é um código de duas letras em minúsculas derivado da ISO 639-1 e "country/regioncode2" é um código de duas letras em maiúscula derivado da ISO 3166. Por exemplo, inglês dos E.U.A. é en-US. O ID para a predefinição /branding é sempre os Tipos 0 de cadeia ou default. Somente leitura. NOTA: Atualmente, não são suportadas várias marcas para uma única região. |
| loginPageLayoutConfiguration | loginPageLayoutConfiguration | Representa a configuração do esquema a apresentar na página de início de sessão de um inquilino. Herdado de organizationalBrandingProperties. |
| loginPageTextVisibilitySettings | loginPageTextVisibilitySettings | Representa os vários textos que podem ser ocultados na página de início de sessão de um inquilino. Herdado de organizationalBrandingProperties. |
| signInPageText | Cadeia de caracteres | Texto que aparece na parte inferior da caixa de início de sessão. Utilize esta opção para comunicar informações adicionais, como o número de telefone ao suporte técnico ou a uma declaração legal. Este texto tem de estar no formato Unicode e não exceder 1024 carateres. |
| squareLogo | Stream | Uma versão quadrada do logótipo da sua empresa que aparece nas experiências de configuração inicial do Windows 10 (OOBE) e quando o Windows Autopilot está ativado para implementação. Os tipos permitidos são PNG ou JPEG não superiores a 240 x 240 píxeis e não têm mais de 10 KB de tamanho. Recomendamos que utilize uma imagem transparente sem preenchimento à volta do logótipo. Herdado de organizationalBrandingProperties. |
| squareLogoRelativeUrl | Cadeia de caracteres | Um URL relativo para a propriedade squareLogo que é combinado com um URL base da 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 logótipo da sua empresa que aparece nas experiências de configuração inicial (OOBE) do Windows 10 e quando o Windows Autopilot está ativado para implementação. Os tipos permitidos são PNG ou JPEG não superiores a 240 x 240 píxeis e não têm mais de 10 KB de tamanho. Recomendamos que utilize uma imagem transparente sem preenchimento à volta do logótipo. Herdado de organizationalBrandingProperties. |
| squareLogoDarkRelativeUrl | Cadeia de caracteres | Um URL relativo para a propriedade squareLogoDark que é combinado com um URL base da CDN da cdnList para fornecer a versão servida por uma CDN. Somente leitura. Herdado de organizationalBrandingProperties. |
| usernameHintText | Cadeia de caracteres | Uma cadeia que é apresentada como a sugestão na caixa de texto do nome de utilizador no ecrã de início de sessão. Este texto tem de ser um Unicode, sem ligações ou código, e não pode exceder os 64 carateres. Herdado de organizationalBrandingProperties. |
Relações
| Relação | Tipo | Descrição |
|---|---|---|
| localizações | coleção organizationalBrandingLocalization | Adicione uma imagem corporativa diferente com base numa região. |
Representação JSON
A representação JSON seguinte mostra o tipo de 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"
}
}