organizationalBrandingLocalization aktualisieren
Namespace: microsoft.graph
Wichtig
Die APIs unter der /beta
Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.
Aktualisieren Sie die Eigenschaften eines organizationalBrandingLocalization-Objekts für eine bestimmte Lokalisierung.
Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.
Globaler Dienst | US Government L4 | US Government L5 (DOD) | China, betrieben von 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Berechtigungen
Wählen Sie für diese API die Als am wenigsten privilegierten Berechtigungen gekennzeichneten Berechtigungen aus. Verwenden Sie nur dann eine Berechtigung mit höheren Berechtigungen , wenn dies für Ihre App erforderlich ist. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.
Berechtigungstyp | Berechtigungen mit den geringsten Berechtigungen | Berechtigungen mit höheren Berechtigungen |
---|---|---|
Delegiert (Geschäfts-, Schul- oder Unikonto) | OrganizationalBranding.ReadWrite.All | Organization.ReadWrite.All |
Delegiert (persönliches Microsoft-Konto) | Nicht unterstützt | Nicht unterstützt |
Anwendung | OrganizationalBranding.ReadWrite.All | Organization.ReadWrite.All |
In delegierten Szenarien mit Geschäfts-, Schul- oder Unikonten muss dem angemeldeten Benutzer eine unterstützte Microsoft Entra-Rolle oder eine benutzerdefinierte Rolle mit einer unterstützten Rollenberechtigung zugewiesen werden. Der Organisationsbrandingadministrator ist die Rolle mit den geringsten Berechtigungen, die für diesen Vorgang unterstützt wird.
HTTP-Anforderung
Um String-Datentypen wie signInPageText und usernameHintText zu aktualisieren, verwenden Sie die PATCH-Methode. Verwenden Sie die PUT-Methode, um Stream-Datentypen wie backgroundLogo und backgroundImage zu aktualisieren. Stream-Typen können nicht mit anderen Datentypen in derselben Anforderung aktualisiert werden.
PATCH /organization/{organizationId}/branding/localizations/{organizationalBrandingLocalizationId}
PUT /organization/{organizationId}/branding/localizations/{organizationalBrandingLocalizationId}/{Stream object type such as backgroundImage}
Anforderungsheader
Name | Beschreibung |
---|---|
Authorization | Bearer {token}. Erforderlich. Erfahren Sie mehr über die Authentifizierung und Autorisierung. |
Content-Type | application/json. Erforderlich. |
Anforderungstext
Geben Sie im Anforderungstext nur die Werte für die Eigenschaften an, die aktualisiert werden sollen. Vorhandene Eigenschaften, die nicht im Anforderungstext enthalten sind, behalten ihre vorherigen Werte bei oder werden basierend auf Änderungen an anderen Eigenschaftswerten neu berechnet.
In der folgenden Tabelle sind die Eigenschaften angegeben, die aktualisiert werden können.
Eigenschaft | Typ | Beschreibung |
---|---|---|
backgroundColor | Zeichenfolge | Farbe, die anstelle des Hintergrundbilds in Verbindungen mit geringer Bandbreite angezeigt wird. Es wird empfohlen, die Primärfarbe Ihres Bannerlogos oder der Farbe Ihrer Organisation zu verwenden. Geben Sie dies im Hexadezimalformat an, z. B. ist #FFFFFF weiß . |
backgroundImage | Stream | Abbildung, die als Hintergrund der Anmeldeseite angezeigt wird. Die zulässigen Typen sind PNG oder JPEG nicht kleiner als 300 KB und nicht größer als 1920 × 1080 Pixel. Ein kleineres Bild reduziert die Bandbreitenanforderungen und führt dazu, dass die Seite schneller geladen wird. |
bannerLogo | Stream | Eine Bannerversion Ihres Unternehmenslogos, die auf der Anmeldeseite angezeigt wird. Die zulässigen Typen sind PNG oder JPEG, die nicht größer als 36 × 245 Pixel sind. Es wird empfohlen, ein transparentes Bild ohne Abstand um das Logo zu verwenden. |
contentCustomization | contentCustomization | Stellt die verschiedenen Inhaltsoptionen dar, die während des Authentifizierungsablaufs für einen Mandanten angepasst werden sollen. ANMERKUNG: Wird nur von Mandanten von "Microsoft Entra ID for customers" unterstützt. |
customAccountResetCredentialsUrl | Zeichenfolge | Eine benutzerdefinierte URL zum Zurücksetzen von Kontoanmeldeinformationen. Diese URL muss im ASCII-Format vorliegen, oder Nicht-ASCII-Zeichen müssen URL-codiert sein und dürfen 128 Zeichen nicht überschreiten. |
customCannotAccessYourAccountText | Zeichenfolge | Eine Zeichenfolge, die den standardmäßigen Linktext "Kann nicht auf Ihr Konto zugreifen?" auf der Anmeldeseite ersetzen. Dieser Text muss im Unicode-Format vorliegen und darf 256 Zeichen nicht überschreiten. |
customCSS | Stream | CSS-Formatierung, die auf der Anmeldeseite angezeigt wird. Das zulässige Format ist nur .css Format und nicht größer als 25 KB. |
customForgotMyPasswordText | Zeichenfolge | Eine Zeichenfolge zum Ersetzen des Standardlinktexts "Kennwort vergessen" im Anmeldeformular. Dieser Text muss im Unicode-Format vorliegen und darf 256 Zeichen nicht überschreiten. |
customPrivacyAndCookiesText | Zeichenfolge | Eine Zeichenfolge, um den standardmäßigen Linktext "Datenschutz und Cookies" in der Fußzeile zu ersetzen. Dieser Text muss im Unicode-Format vorliegen und darf 256 Zeichen nicht überschreiten. |
customPrivacyAndCookiesUrl | Zeichenfolge | Eine benutzerdefinierte URL zum Ersetzen der Standard-URL des Links "Datenschutz und Cookies" in der Fußzeile. Diese URL muss im ASCII-Format vorliegen, oder Nicht-ASCII-Zeichen müssen URL-codiert sein und dürfen 128 Zeichen nicht überschreiten. |
customTermsOfUseText | Zeichenfolge | Eine Zeichenfolge, die den Standardtext des Links "Nutzungsbedingungen" in der Fußzeile ersetzt. Dieser Text muss im Unicode-Format vorliegen und darf 256 Zeichen nicht überschreiten. |
customTermsOfUseUrl | Zeichenfolge | Eine benutzerdefinierte URL zum Ersetzen der Standard-URL des Links "Nutzungsbedingungen" in der Fußzeile. Diese URL muss im ASCII-Format vorliegen, oder Nicht-ASCII-Zeichen müssen URL-codiert sein und 128 Zeichen nicht überschreiten. |
Favicon | Stream | Ein benutzerdefiniertes Symbol (Favicon) zum Ersetzen eines Standardmäßigen Microsoft-Produktfavicons in einem Microsoft Entra-Mandanten. |
headerBackgroundColor | Zeichenfolge | Die RGB-Farbe, die angewendet werden soll, um die Farbe des Headers anzupassen. |
headerLogo | Stream | Ein Unternehmenslogo, das in der Kopfzeile der Anmeldeseite angezeigt wird. Die zulässigen Typen sind PNG oder JPEG, die nicht größer als 36 × 245 Pixel sind. Es wird empfohlen, ein transparentes Bild ohne Abstand um das Logo zu verwenden. |
loginPageLayoutConfiguration | loginPageLayoutConfiguration | Stellt die Layoutkonfiguration dar, die auf der Anmeldeseite für einen Mandanten angezeigt werden soll. |
loginPageTextVisibilitySettings | loginPageTextVisibilitySettings | Stellt die verschiedenen Texte dar, die auf der Anmeldeseite für einen Mandanten ausgeblendet werden können. Alle Eigenschaften können aktualisiert werden. |
signInPageText | Zeichenfolge | Text, der unten im Anmeldefeld angezeigt wird. Verwenden Sie dies, um zusätzliche Informationen wie die Telefonnummer an Ihren Helpdesk oder eine rechtliche Erklärung zu übermitteln. Dieser Text muss im Unicode-Format vorliegen und darf 1.024 Zeichen nicht überschreiten. |
squareLogo | Stream | Eine quadratische Version Ihres Unternehmenslogos, die in Windows 10 Out-of-Box-Umgebungen (OOBE) angezeigt wird und wenn Windows Autopilot für die Bereitstellung aktiviert ist. Zulässige Typen sind PNG oder JPEG, die nicht größer als 240 x 240 Pixel und nicht mehr als 10 KB groß sind. Es wird empfohlen, ein transparentes Bild ohne Abstand um das Logo zu verwenden. |
squareLogoDark | Stream | Eine quadratische dunkle Version Ihres Unternehmenslogos, die in Windows 10 Out-of-Box-Umgebungen (OOBE) angezeigt wird und wenn Windows Autopilot für die Bereitstellung aktiviert ist. Zulässige Typen sind PNG oder JPEG, die nicht größer als 240 x 240 Pixel und nicht mehr als 10 KB groß sind. Es wird empfohlen, ein transparentes Bild ohne Abstand um das Logo zu verwenden. |
usernameHintText | Zeichenfolge | Eine Zeichenfolge, die als Hinweis im Textfeld benutzername auf dem Anmeldebildschirm angezeigt wird. Bei diesem Text muss es sich um einen Unicode-Text ohne Links oder Code handeln und darf 64 Zeichen nicht überschreiten. |
Antwort
Wenn die Methode erfolgreich verläuft, wird der Antwortcode 204 No Content
zurückgegeben.
Beispiele
Beispiel 1: Festlegen von bannerLogo für die fr-FR-Lokalisierung mithilfe von PUT
Die folgende Anforderung aktualisiert das Bannerlogo für die Lokalisierung von fr-FR.
Anforderung
Das folgende Beispiel zeigt eine Anfrage.
PUT https://graph.microsoft.com/beta/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/fr-FR/bannerLogo
Content-Type: image/jpeg
<Image>
Antwort
HTTP/1.1 204 No Content
Beispiel 2: Aktualisieren von backgroundColor und signInPageText für die fr-FR-Lokalisierung mithilfe von PATCH
Die folgende Anforderung aktualisiert das Bannerlogo für die fr-FR
Lokalisierung.
Anforderung
Das folgende Beispiel zeigt eine Anfrage.
PATCH https://graph.microsoft.com/beta/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/fr-FR
Content-Type: application/json
{
"backgroundColor":"#00000F",
"signInPageText": "Welcome to Contoso France"
}
Antwort
HTTP/1.1 204 No Content
Beispiel 3: Überschreiben eines Standardbrandingwerts mit einer leeren Zeichenfolge
Anforderung
Das folgende Beispiel zeigt eine Anfrage.
PATCH https://graph.microsoft.com/beta/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/fr-FR
Content-Type: application/json
{
"signInPageText": "Welcome to Contoso France.",
"usernameHintText":" "
}
Antwort
Nach der Anforderung ist usernameHintText für die fr-FR
Lokalisierung leer, anstatt den Wert vom Standardbrandingobjekt zu erben.
HTTP/1.1 204 No Content