Actualizar organizationalBranding

Artículo
07/16/2024

Espacio de nombres: microsoft.graph

Actualice las propiedades del objeto de personalización de marca predeterminado especificado por el recurso organizationalBranding .

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global	Gobierno de EE. UU. L4	Us Government L5 (DOD)	China operada por 21Vianet
✅	✅	✅	✅

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso	Permisos con privilegios mínimos	Permisos con privilegios más altos
Delegado (cuenta profesional o educativa)	OrganizationalBranding.ReadWrite.All	Organization.ReadWrite.All
Delegado (cuenta personal de Microsoft)	No admitida.	No admitida.
Aplicación	OrganizationalBranding.ReadWrite.All	Organization.ReadWrite.All

Importante

En escenarios delegados con cuentas profesionales o educativas, al usuario que ha iniciado sesión se le debe asignar un rol de Microsoft Entra compatible o un rol personalizado con un permiso de rol admitido. El administrador de personalización de marca de la organización es el rol con privilegios mínimos admitido para esta operación.

Solicitud HTTP

Para actualizar los tipos de datos String, como signInPageText y usernameHintText, use el método PATCH. Para actualizar Stream tipos de datos, como backgroundLogo y backgroundImage, use el método PUT. No puede actualizar Stream tipos con otros tipos de datos en la misma solicitud.

PATCH /organization/{organizationId}/branding
PUT /organization/{organizationId}/branding/localizations/{organizationalBrandingLocalizationId}/{Stream object type such as backgroundImage}

Encabezados de solicitud

Nombre	Descripción
Authorization	{token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.
Content-Type	application/json. Obligatorio.
Accept-Language	Configuración regional ISO 639-1 válida. Obligatorio.

Cuerpo de la solicitud

En el cuerpo de la solicitud, únicamente proporcione los valores de las propiedades que deben actualizarse. Las propiedades existentes que no se incluyan en el cuerpo de la solicitud mantendrán los valores anteriores o se recalcularán según los cambios efectuados en otros valores de propiedad.

En la tabla siguiente se especifican las propiedades que se pueden actualizar.

Propiedad	Tipo	Descripción
backgroundColor	Cadena	Color que aparece en lugar de la imagen de fondo en conexiones de ancho de banda bajo. Se recomienda usar el color principal del logotipo de banner o el color de la organización. Especifique esto en formato hexadecimal, por ejemplo, white es `#FFFFFF`.
backgroundImage	Stream	Imagen que aparece como fondo de la página de inicio de sesión. Los tipos permitidos son PNG o JPEG no menores que 300 KB y no mayores que 1920 × 1080 píxeles. Una imagen más pequeña reducirá los requisitos de ancho de banda y hará que la carga de la página sea más rápida.
bannerLogo	Stream	Una versión de banner del logotipo de la empresa que aparece en la página de inicio de sesión. Los tipos permitidos son PNG o JPEG que no superan los 245 x 36 píxeles. Se recomienda usar una imagen transparente sin relleno alrededor del logotipo.
contentCustomization	contentCustomization	Representa las distintas opciones de contenido que se deben personalizar en todo el flujo de autenticación de un inquilino. NOTA: Solo es compatible con Microsoft Entra ID para los inquilinos de clientes.
customAccountResetCredentialsUrl	Cadena	Dirección URL personalizada para restablecer las credenciales de la cuenta. Esta dirección URL debe estar en formato ASCII o los caracteres que no sean ASCII deben estar codificados con dirección URL y no deben superar los 128 caracteres.
customCannotAccessYourAccountText	Cadena	Cadena para reemplazar el texto de hipervínculo predeterminado "¿No se puede acceder a su cuenta?", texto de hipervínculo de autoservicio de restablecimiento de contraseña (SSPR) en la página de inicio de sesión. Este texto debe estar en formato Unicode y no superar los 256 caracteres.
customCSS	Stream	Estilo CSS que aparece en la página de inicio de sesión. El formato permitido es .css solo y no es mayor que 25 KB.
customForgotMyPasswordText	Cadena	Cadena para reemplazar el texto de hipervínculo predeterminado "Olvidó mi contraseña" en el formulario de inicio de sesión. Este texto debe estar en formato Unicode y no superar los 256 caracteres.
customPrivacyAndCookiesText	Cadena	Cadena para reemplazar el texto de hipervínculo "Privacidad y cookies" predeterminado en el pie de página. Este texto debe estar en formato Unicode y no superar los 256 caracteres.
customPrivacyAndCookiesUrl	Cadena	Dirección URL personalizada para reemplazar la dirección URL predeterminada del hipervínculo "Privacidad y cookies" en el pie de página. Esta dirección URL debe estar en formato ASCII o los caracteres que no sean ASCII deben estar codificados con dirección URL y no deben superar los 128 caracteres.
customTermsOfUseText	Cadena	Cadena para reemplazar el texto predeterminado del hipervínculo "Términos de uso" en el pie de página. Este texto debe estar en formato Unicode y no superar los 256 caracteres.
customTermsOfUseUrl	Cadena	Dirección URL personalizada para reemplazar la dirección URL predeterminada del hipervínculo "Términos de uso" en el pie de página. Esta dirección URL debe estar en formato ASCII o los caracteres que no sean ASCII deben estar codificados con dirección URL y no deben superar los 128characters.
icono de favoritos	Stream	Icono personalizado (favicon) para reemplazar un icono de favoritos de producto de Microsoft predeterminado en un inquilino de Microsoft Entra.
headerBackgroundColor	Cadena	Color RGB que se va a aplicar para personalizar el color del encabezado.
headerLogo	Stream	Logotipo de empresa que aparece en el encabezado de la página de inicio de sesión. Los tipos permitidos son PNG o JPEG que no superan los 245 x 36 píxeles. Se recomienda usar una imagen transparente sin relleno alrededor del logotipo.
loginPageLayoutConfiguration	loginPageLayoutConfiguration	Representa la configuración de diseño que se mostrará en la página de inicio de sesión de un inquilino.
loginPageTextVisibilitySettings	loginPageTextVisibilitySettings	Representa los distintos textos que se pueden ocultar en la página de inicio de sesión de un inquilino. Todas las propiedades se pueden actualizar.
signInPageText	Cadena	Texto que aparece en la parte inferior del cuadro de inicio de sesión. Use esta opción para comunicar información adicional, como el número de teléfono al departamento de soporte técnico o una declaración legal. Este texto debe estar en formato Unicode y no superar los 1024 caracteres.
squareLogo	Stream	Una versión cuadrada del logotipo de la empresa que aparece en Windows 10 experiencias integradas (OOBE) y cuando Windows Autopilot está habilitado para la implementación. Los tipos permitidos son PNG o JPEG que no superan los 240 x 240 píxeles y no tienen un tamaño superior a 10 KB. Se recomienda usar una imagen transparente sin relleno alrededor del logotipo.
squareLogoDark	Stream	Una versión cuadrada y oscura del logotipo de la empresa que aparece en Windows 10 experiencias integradas (OOBE) y cuando Windows Autopilot está habilitado para la implementación. Los tipos permitidos son PNG o JPEG que no superan los 240 x 240 píxeles y no tienen un tamaño superior a 10 KB. Se recomienda usar una imagen transparente sin relleno alrededor del logotipo.
usernameHintText	Cadena	Cadena que se muestra como sugerencia en el cuadro de texto nombre de usuario de la pantalla de inicio de sesión. Este texto debe ser Unicode, sin vínculos ni código, y no puede superar los 64 caracteres.

Respuesta

Si se ejecuta correctamente, este método devuelve un código de respuesta 204 No Content.

Ejemplos

Ejemplo 1: Actualización de la personalización de marca predeterminada

Solicitud

En el ejemplo siguiente se muestra la solicitud.

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"
}


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

// Dependencies
using Microsoft.Graph.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");
});



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



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

// Dependencies
import (
	  "context"
	  abstractions "github.com/microsoft/kiota-abstractions-go"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
	  graphorganization "github.com/microsoftgraph/msgraph-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)


// 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");
});


const options = {
	authProvider,
};

const client = Client.init(options);

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

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


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Organization\Item\Branding\BrandingRequestBuilderPatchRequestConfiguration;
use Microsoft\Graph\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();


Import-Module Microsoft.Graph.Identity.DirectoryManagement

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

Update-MgOrganizationBranding -OrganizationId $organizationId -BodyParameter $params


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.organization.item.branding.branding_request_builder import BrandingRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
from msgraph.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)

Respuesta

En el ejemplo siguiente se muestra la respuesta.

HTTP/1.1 204 No Content

Ejemplo 2: Actualizar bannerLogo para la personalización de marca predeterminada

La siguiente solicitud actualiza el logotipo del banner para la personalización de marca predeterminada. Para actualizar un tipo de objeto Stream, use el método HTTP PUT e incluya el identificador de configuración regional en la ruta de acceso url.

Solicitud

En el ejemplo siguiente se muestra la solicitud.

PUT https://graph.microsoft.com/v1.0/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/0/bannerLogo
Content-Type: image/jpeg

<Image>

Snippet not available



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

Snippet not available

Snippet not available


const options = {
	authProvider,
};

const client = Client.init(options);

const stream = <Image>;

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

Snippet not available


Import-Module Microsoft.Graph.Identity.DirectoryManagement

$params = Binary data for the image

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

Snippet not available

Respuesta

En el ejemplo siguiente se muestra la respuesta.

HTTP/1.1 204 No Content

Compartir a través de

Actualizar organizationalBranding

Permissions

Solicitud HTTP

Encabezados de solicitud

Cuerpo de la solicitud

Respuesta

Ejemplos

Ejemplo 1: Actualización de la personalización de marca predeterminada

Solicitud

Respuesta

Ejemplo 2: Actualizar bannerLogo para la personalización de marca predeterminada

Solicitud

Respuesta

Comentarios

Recursos adicionales