Atualizar organizationalBranding

Artigo
07/04/2024

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.

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 ou `0` para a região predefinida. Obrigatório.

Corpo da solicitação

No corpo do pedido, forneça apenas os valores das propriedades a atualizar. As propriedades existentes que não estão incluídas no corpo do pedido mantêm os valores anteriores ou são recalculadas com base em 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/beta/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding
Content-Type: application/json
Accept-Language: 0

{
    "signInPageText":"Default",
    "usernameHintText":"DefaultHint"
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new OrganizationalBranding
{
	SignInPageText = "Default",
	UsernameHintText = "DefaultHint",
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Organization["{organization-id}"].Branding.PatchAsync(requestBody, (requestConfiguration) =>
{
	requestConfiguration.Headers.Add("Accept-Language", "0");
});

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não oferecem suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.



mgc-beta organization branding patch --organization-id {organization-id} --body '{\
    "signInPageText":"Default",\
    "usernameHintText":"DefaultHint"\
}\
'

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  abstractions "github.com/microsoft/kiota-abstractions-go"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  graphorganization "github.com/microsoftgraph/msgraph-beta-sdk-go/organization"
	  //other-imports
)

headers := abstractions.NewRequestHeaders()
headers.Add("Accept-Language", "0")

configuration := &graphorganization.OrganizationItemBrandingRequestBuilderPatchRequestConfiguration{
	Headers: headers,
}
requestBody := graphmodels.NewOrganizationalBranding()
signInPageText := "Default"
requestBody.SetSignInPageText(&signInPageText) 
usernameHintText := "DefaultHint"
requestBody.SetUsernameHintText(&usernameHintText) 

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
branding, err := graphClient.Organization().ByOrganizationId("organization-id").Branding().Patch(context.Background(), requestBody, configuration)

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

OrganizationalBranding organizationalBranding = new OrganizationalBranding();
organizationalBranding.setSignInPageText("Default");
organizationalBranding.setUsernameHintText("DefaultHint");
OrganizationalBranding result = graphClient.organization().byOrganizationId("{organization-id}").branding().patch(organizationalBranding, requestConfiguration -> {
	requestConfiguration.headers.add("Accept-Language", "0");
});

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


const options = {
	authProvider,
};

const client = Client.init(options);

const organizationalBranding = {
    signInPageText: 'Default',
    usernameHintText: 'DefaultHint'
};

await client.api('/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding')
	.version('beta')
	.update(organizationalBranding);

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Organization\Item\Branding\BrandingRequestBuilderPatchRequestConfiguration;
use Microsoft\Graph\Beta\Generated\Models\OrganizationalBranding;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new OrganizationalBranding();
$requestBody->setSignInPageText('Default');
$requestBody->setUsernameHintText('DefaultHint');
$requestConfiguration = new BrandingRequestBuilderPatchRequestConfiguration();
$headers = [
		'Accept-Language' => '0',
	];
$requestConfiguration->headers = $headers;


$result = $graphServiceClient->organization()->byOrganizationId('organization-id')->branding()->patch($requestBody, $requestConfiguration)->wait();

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement

$params = @{
	signInPageText = "Default"
	usernameHintText = "DefaultHint"
}

Update-MgBetaOrganizationBranding -OrganizationId $organizationId -BodyParameter $params

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.organization.item.branding.branding_request_builder import BrandingRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
from msgraph_beta.generated.models.organizational_branding import OrganizationalBranding
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = OrganizationalBranding(
	sign_in_page_text = "Default",
	username_hint_text = "DefaultHint",
)

request_configuration = RequestConfiguration()
request_configuration.headers.add("Accept-Language", "0")


result = await graph_client.organization.by_organization_id('organization-id').branding.patch(request_body, request_configuration = request_configuration)

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

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/beta/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/0/bannerLogo
Content-Type: image/jpeg

<Image>

Snippet not available

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.



mgc-beta organization branding localizations banner-logo put --organization-id {organization-id} --organizational-branding-localization-id {organizationalBrandingLocalization-id}

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Snippet not available

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Snippet not available

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


const options = {
	authProvider,
};

const client = Client.init(options);

const stream = <Image>;

await client.api('/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/0/bannerLogo')
	.version('beta')
	.put(stream);

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Snippet not available

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement

$params = Binary data for the image

Set-MgBetaOrganizationBrandingLocalizationBannerLogo -OrganizationId $organizationId -OrganizationalBrandingLocalizationId $organizationalBrandingLocalizationId -BodyParameter $params

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Snippet not available

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 204 No Content

Compartilhar via

Atualizar organizationalBranding

Permissões

Solicitação HTTP

Cabeçalhos de solicitação

Corpo da solicitação

Resposta

Exemplos

Exemplo 1: Atualizar a imagem corporativa predefinida

Solicitação

Resposta

Exemplo 2: Atualizar bannerLogo para a imagem corporativa predefinida

Solicitação

Resposta

Comentários

Recursos adicionais