Mettre à jour organizationalBranding

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

Importante

Dans les scénarios délégués avec des comptes professionnels ou scolaires, l’utilisateur connecté doit se voir attribuer un rôle Microsoft Entra pris en charge ou un rôle personnalisé avec une autorisation de rôle prise en charge. Administrateur de personnalisation de l’organisation est le rôle le moins privilégié pris en charge pour cette opération.

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 à mettre à 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 String 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 String 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 String 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 String 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 String Chaîne pour remplacer le texte de lien hypertexte « Confidentialité et cookies » par défaut dans le pied de page. Ce texte doit être au format Unicode et ne doit pas dépasser 256 caractères.
customPrivacyAndCookiesUrl String 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 String 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 String 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 String 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 String 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 String 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"
}

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>

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 204 No Content