Mettre à jour organizationalBranding

Article
10/28/2023

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Mettez à jour les propriétés de l’objet de personnalisation par défaut spécifié par la ressource organizationalBranding .

Cette API est disponible dans les déploiements de cloud national suivants.

Service global	Gouvernement des États-Unis L4	Us Government L5 (DOD)	Chine gérée par 21Vianet
✅	✅	✅	✅

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation	Autorisations avec privilèges minimum	Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire)	OrganizationalBranding.ReadWrite.All	Organization.ReadWrite.All
Déléguée (compte Microsoft personnel)	Non prise en charge.	Non prise en charge.
Application	OrganizationalBranding.ReadWrite.All	Organization.ReadWrite.All

Pour les scénarios délégués, seuls les utilisateurs disposant du rôle Administrateur de la marque organisationnelleMicrosoft Entra peuvent gérer entièrement la personnalisation de l’organization.

Requête HTTP

Pour mettre à jour les types de données String, tels que signInPageText et usernameHintText, utilisez la méthode PATCH. Pour mettre à jour Stream types de données, tels que backgroundLogo et backgroundImage, utilisez la méthode PUT. Vous ne pouvez pas mettre à jour Stream types avec d’autres types de données dans la même requête.

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

En-têtes de demande

Nom	Description
Autorisation	Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-Type	application/json. Obligatoire.
Accept-Language	Paramètres régionaux ISO 639-1 valides ou `0` pour les paramètres régionaux par défaut. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez uniquement les valeurs des propriétés qui doivent être mises à jour. Les propriétés existantes qui ne sont pas incluses dans le corps de la demande conservent leurs valeurs précédentes ou sont recalculées en fonction des modifications apportées à d’autres valeurs de propriété.

Le tableau suivant spécifie les propriétés qui peuvent être mises à jour.

Propriété	Type	Description
Backgroundcolor	Chaîne	Couleur qui apparaît à la place de l’image d’arrière-plan dans les connexions à faible bande passante. Nous vous recommandons d’utiliser la couleur principale de votre logo de bannière ou de votre organization couleur. Spécifiez cela au format hexadécimal, par exemple, blanc est `#FFFFFF`.
Backgroundimage	Stream	Image qui apparaît comme arrière-plan de la page de connexion. Les types autorisés sont PNG ou JPEG au-dessus de 300 Ko et ne dépassent pas 1920 × 1 080 pixels. Une image plus petite réduit les besoins en bande passante et accélère le chargement de la page.
bannerLogo	Stream	Une version de bannière du logo de votre entreprise qui s’affiche sur la page de connexion. Les types autorisés sont PNG ou JPEG ne dépassant pas 245 x 36 pixels. Nous vous recommandons d’utiliser une image transparente sans remplissage autour du logo.
contentCustomization	contentCustomization	Représente les différentes options de contenu à personnaliser tout au long du flux d’authentification pour un locataire. NOTE: Pris en charge par Microsoft Entra ID pour les locataires clients uniquement.
customAccountResetCredentialsUrl	Chaîne	URL personnalisée pour la réinitialisation des informations d’identification du compte. Cette URL doit être au format ASCII ou les caractères non-ASCII doivent être codés url et ne pas dépasser 128 caractères.
customCannotAccessYourAccountText	Chaîne	Chaîne pour remplacer le texte par défaut du lien hypertexte de réinitialisation de mot de passe en libre-service (SSPR) sur la page de connexion. Ce texte doit être au format Unicode et ne doit pas dépasser 256 caractères.
customCSS	Stream	Style CSS qui s’affiche sur la page de connexion. Le format autorisé est .css format uniquement et ne dépasse pas 25 Ko.
customForgotMyPasswordText	Chaîne	Chaîne pour remplacer le texte par défaut du lien hypertexte « J’ai oublié mon mot de passe » dans le formulaire de connexion. Ce texte doit être au format Unicode et ne doit pas dépasser 256 caractères.
customPrivacyAndCookiesText	Chaîne	Chaîne pour remplacer le texte par défaut du lien hypertexte « Confidentialité et cookies » dans le pied de page. Ce texte doit être au format Unicode et ne doit pas dépasser 256 caractères.
customPrivacyAndCookiesUrl	Chaîne	URL personnalisée pour remplacer l’URL par défaut du lien hypertexte « Confidentialité et cookies » dans le pied de page. Cette URL doit être au format ASCII ou les caractères non-ASCII doivent être codés url et ne pas dépasser 128 caractères.
customTermsOfUseText	Chaîne	Chaîne pour remplacer le texte par défaut du lien hypertexte « Conditions d’utilisation » dans le pied de page. Ce texte doit être au format Unicode et ne doit pas dépasser 256 caractères.
customTermsOfUseUrl	Chaîne	URL personnalisée pour remplacer l’URL par défaut du lien hypertexte « Conditions d’utilisation » dans le pied de page. Cette URL doit être au format ASCII ou les caractères non-ASCII doivent être codés url et ne pas dépasser 128 caractères.
Favicon	Stream	Icône personnalisée (favicon) pour remplacer un favicon de produit Microsoft par défaut sur un locataire Microsoft Entra.
headerBackgroundColor	Chaîne	Couleur RVB à appliquer pour personnaliser la couleur de l’en-tête.
headerLogo	Stream	Logo de l’entreprise qui apparaît dans l’en-tête de la page de connexion. Les types autorisés sont PNG ou JPEG ne dépassant pas 245 x 36 pixels. Nous vous recommandons d’utiliser une image transparente sans remplissage autour du logo.
loginPageLayoutConfiguration	loginPageLayoutConfiguration	Représente la configuration de disposition à afficher sur la page de connexion d’un locataire.
loginPageTextVisibilitySettings	loginPageTextVisibilitySettings	Représente les différents textes qui peuvent être masqués sur la page de connexion d’un locataire. Toutes les propriétés peuvent être mises à jour.
signInPageText	Chaîne	Texte qui apparaît en bas de la zone de connexion. Utilisez-le pour communiquer des informations supplémentaires, telles que le numéro de téléphone à votre support technique ou une déclaration légale. Ce texte doit être au format Unicode et ne doit pas dépasser 1 024 caractères.
squareLogo	Stream	Version carrée du logo de votre entreprise qui apparaît dans Windows 10 expériences OOBE (Out-of-Box Experience) et lorsque Windows Autopilot est activé pour le déploiement. Les types autorisés sont PNG ou JPEG qui ne dépassent pas 240 x 240 pixels et ne dépassent pas 10 Ko. Nous vous recommandons d’utiliser une image transparente sans remplissage autour du logo.
squareLogoDark	Stream	Une version sombre carrée du logo de votre entreprise qui apparaît dans Windows 10 expériences OOBE (out-of-box experience) et lorsque Windows Autopilot est activé pour le déploiement. Les types autorisés sont PNG ou JPEG qui ne dépassent pas 240 x 240 pixels et ne dépassent pas 10 Ko. Nous vous recommandons d’utiliser une image transparente sans remplissage autour du logo.
usernameHintText	Chaîne	Chaîne qui s’affiche comme indicateur dans la zone de texte username sur l’écran de connexion. Ce texte doit être unicode, sans liens ni code, et ne peut pas dépasser 64 caractères.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse 204 No Content.

Exemples

Exemple 1 : Mettre à jour la personnalisation par défaut

Demande

L’exemple suivant illustre une demande.

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

Microsoft Graph SDK utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le SDK, consultez Utiliser les kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta organization branding patch --organization-id {organization-id} --body '{\
    "signInPageText":"Default",\
    "usernameHintText":"DefaultHint"\
}\
'

Importante



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
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


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) 

branding, err := graphClient.Organization().ByOrganizationId("organization-id").Branding().Patch(context.Background(), requestBody, configuration)

Importante


// 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


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


<?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();

Importante


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

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

Update-MgBetaOrganizationBranding -OrganizationId $organizationId -BodyParameter $params

Importante


from msgraph import GraphServiceClient
from msgraph.generated.organization.item.branding.branding_request_builder import BrandingRequestBuilder
from msgraph.generated.models.organizational_branding import OrganizationalBranding

graph_client = GraphServiceClient(credentials, scopes)

request_body = OrganizationalBranding(
	sign_in_page_text = "Default",
	username_hint_text = "DefaultHint",
)

request_configuration = BrandingRequestBuilder.BrandingRequestBuilderPatchRequestConfiguration()
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

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 204 No Content

Exemple 2 : Mettre à jour bannerLogo pour la personnalisation par défaut

La requête suivante met à jour le logo de bannière pour la personnalisation par défaut. Pour mettre à jour un type d’objet Stream, utilisez la méthode HTTP PUT et incluez l’ID des paramètres régionaux dans le chemin d’URL.

Demande

L’exemple suivant illustre une demande.

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


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta organization branding localizations banner-logo put --organization-id {organization-id} --organizational-branding-localization-id {organizationalBrandingLocalization-id}

Importante

Snippet not available

Importante

Snippet not available

Importante


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

Snippet not available

Importante


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

$params = Binary data for the image

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

Importante

Snippet not available

Importante

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 204 No Content

Mettre à jour organizationalBranding

Autorisations

Requête HTTP

En-têtes de demande

Corps de la demande

Réponse

Exemples

Exemple 1 : Mettre à jour la personnalisation par défaut

Demande

Réponse

Exemple 2 : Mettre à jour bannerLogo pour la personnalisation par défaut

Demande

Réponse

Commentaires

Commentaires

Ressources supplémentaires