Atualizar organizationalBranding
Namespace: microsoft.graph
Atualize as propriedades do objeto de imagem corporativa predefinido especificado pelo recurso organizationalBranding .
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) | OrganizationalBranding.ReadWrite.All | Organization.ReadWrite.All |
Delegado (conta pessoal da Microsoft) | Sem suporte. | Sem suporte. |
Application | OrganizationalBranding.ReadWrite.All | Organization.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 Administrador de Imagem Corporativa Organizacional é a função com menos privilégios suportada para esta operação.
Solicitação HTTP
Para atualizar tipos de dados de Cadeia, como signInPageText e usernameHintText, utilize o método PATCH. Para atualizar Stream tipos de dados, como backgroundLogo e backgroundImage, utilize o método PUT. Não pode atualizar Stream tipos com outros tipos de dados no mesmo pedido.
PATCH /organization/{organizationId}/branding
PUT /organization/{organizationId}/branding/localizations/{organizationalBrandingLocalizationId}/{Stream object type such as backgroundImage}
Cabeçalhos de solicitação
Nome | Descrição |
---|---|
Autorização | {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização. |
Content-Type | application/json. Obrigatório. |
Accept-Language | Uma região ISO 639-1 válida. Obrigatório. |
Corpo da solicitação
No corpo da solicitação, forneça apenas os valores das propriedades que devem ser atualizadas. Propriedades existentes que não estão incluídas no corpo da solicitação terão seus valores anteriores mantidos ou serão recalculadas com base nas alterações a outros valores de propriedade.
A tabela a seguir especifica as propriedades que podem ser atualizadas.
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 . |
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. |
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. |
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 por Microsoft Entra ID apenas para inquilinos de clientes. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
favicon | Stream | Um ícone personalizado (favicon) para substituir um favicon de produto Microsoft predefinido num inquilino Microsoft Entra. |
headerBackgroundColor | Cadeia de caracteres | A cor RGB a aplicar para personalizar a cor do cabeçalho. |
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. |
loginPageLayoutConfiguration | loginPageLayoutConfiguration | Representa a configuração do esquema a apresentar na página de início de sessão de um inquilino. |
loginPageTextVisibilitySettings | loginPageTextVisibilitySettings | Representa os vários textos que podem ser ocultados na página de início de sessão de um inquilino. Todas as propriedades podem ser atualizadas. |
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 no Windows 10 experiências de configuração inicial (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. |
squareLogoDark | Stream | Uma versão escura quadrada do logótipo da sua empresa que é apresentada no Windows 10 experiências de configuração inicial (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. |
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. |
Resposta
Se tiver êxito, este método retornará um código de resposta 204 No Content
.
Exemplos
Exemplo 1: Atualizar a imagem corporativa predefinida
Solicitação
O exemplo a seguir mostra uma solicitação.
PATCH https://graph.microsoft.com/v1.0/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding
Content-Type: application/json
Accept-Language: 0
{
"signInPageText":"Default",
"usernameHintText":"DefaultHint"
}
Resposta
O exemplo a seguir mostra a resposta.
HTTP/1.1 204 No Content
Exemplo 2: Atualizar bannerLogo para a imagem corporativa predefinida
O pedido seguinte atualiza o logótipo da faixa para a imagem corporativa predefinida. Para atualizar um tipo de objeto Stream, utilize o método PUT HTTP e inclua o ID de região no caminho do URL.
Solicitação
O exemplo a seguir mostra uma solicitação.
PUT https://graph.microsoft.com/v1.0/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/0/bannerLogo
Content-Type: image/jpeg
<Image>
Resposta
O exemplo a seguir mostra a resposta.
HTTP/1.1 204 No Content