Partager via


Mettre à jour organizationalBrandingLocalization

Espace de noms: microsoft.graph

Mettez à jour les propriétés d’un objet organizationalBrandingLocalization pour une localisation spécifique.

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/localizations/{organizationalBrandingLocalizationId}

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.

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 conserveront leurs valeurs précédentes ou seront recalculées en fonction des modifications apportées à d’autres valeurs des propriétés.

Le tableau ci-dessous spécifie les propriétés pouvant être mises à jour.

Propriété Type Description
backgroundColor String Couleur qui apparaîtra à 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 36 × 245 pixels. Nous vous recommandons d’utiliser une image transparente sans remplissage autour du logo.
signInPageText String Texte qui apparaît en bas de la zone de connexion. Vous pouvez l’utiliser 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 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 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 : Définition de bannerLogo pour la localisation fr-FR à l’aide de PUT

La requête suivante met à jour le logo de bannière pour la localisation fr-FR.

Demande

L’exemple suivant illustre une demande.

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

<Image>

Réponse

HTTP/1.1 204 NO CONTENT

Exemple 2 : mettre à jour backgroundColor et signInPageText pour la localisation fr-FR à l’aide de PATCH

La requête suivante met à jour le logo de bannière pour la fr-FR localisation.

Demande

L’exemple suivant illustre une demande.

PATCH https://graph.microsoft.com/v1.0/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/fr-FR
Content-Type: application/json

{
    "backgroundColor":"#00000F",
    "signInPageText": "Welcome to Contoso France"
}

Réponse

HTTP/1.1 204 No Content

Exemple 3 : Remplacer une valeur de personnalisation par défaut par une chaîne vide

Demande

L’exemple suivant illustre une demande.

PATCH https://graph.microsoft.com/v1.0/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/fr-FR
Content-Type: application/json

{
    "signInPageText": "Welcome to Contoso France.",
    "usernameHintText":" "
}

Réponse

HTTP/1.1 204 No Content

À la suite de cette demande, usernameHintText pour la fr-FR localisation sera vide au lieu d’hériter de la valeur de l’objet de personnalisation par défaut.