organizationalBranding aktualisieren

Artikel
10/14/2024

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 des Standardbrandingobjekts, das von der ressource organizationalBranding angegeben wird.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Weltweiter Service	US Government L4	US Government L5 (DOD)	China, betrieben von 21Vianet
✅	✅	✅	✅

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. 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

Wichtig

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. Sie können Stream Typen nicht mit anderen Datentypen in derselben Anforderung aktualisieren.

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

Anforderungsheader

Name	Beschreibung
Authorization	Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.
Content-Type	application/json. Erforderlich.
Accept-Language	Ein gültiges ISO 639-1-Gebietsschema oder `0` für das Standardgebietsschema. Erforderlich.

Anforderungstext

Geben Sie im Anforderungstext nur die Werte für zu aktualisierende Eigenschaften an. 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	String	Farbe, die anstelle des Hintergrundbilds in Verbindungen mit geringer Bandbreite angezeigt wird. Es wird empfohlen, die Primärfarbe Ihres Bannerlogos oder Ihre organization Farbe 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 245 x 36 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: Unterstützt von Microsoft Entra ID nur für Kundenmandanten.
customAccountResetCredentialsUrl	String	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	String	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	String	Eine Zeichenfolge zum Ersetzen des Standardlinktexts "Kennwort vergessen" im Anmeldeformular. Dieser Text muss im Unicode-Format vorliegen und darf 256 Zeichen nicht überschreiten.
customPrivacyAndCookiesText	String	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	String	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	String	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	String	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-Produkt-Favicons auf einem Microsoft Entra Mandanten.
headerBackgroundColor	String	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 245 x 36 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	String	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 experiences (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	String	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: Aktualisieren des Standardbrandings

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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

Wichtig

Die Microsoft Graph SDKs verwenden standardmäßig die Version v1.0 der API und unterstützen nicht alle Typen, Eigenschaften und APIs, die in der Beta-Version verfügbar sind. Einzelheiten zum Zugriff auf die Beta-API mit dem SDK finden Sie unter Verwenden der Microsoft Graph SDKs mit der Beta-API.

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.



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

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.



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

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

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)

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


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

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


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

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


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

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


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

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

Update-MgBetaOrganizationBranding -OrganizationId $organizationId -BodyParameter $params

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


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

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.

Antwort

Das folgende Beispiel zeigt die Antwort.

HTTP/1.1 204 No Content

Beispiel 2: Aktualisieren von bannerLogo für das Standardbranding

Die folgende Anforderung aktualisiert das Bannerlogo für das Standardbranding. Um einen Stream Objekttyp zu aktualisieren, verwenden Sie die PUT-HTTP-Methode, und fügen Sie die Gebietsschema-ID in den URL-Pfad ein.

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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

<Image>

Snippet not available

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.



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

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.

Snippet not available

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.

Snippet not available

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


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

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.

Snippet not available

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


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

$params = Binary data for the image

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

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.

Snippet not available

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.

Antwort

Das folgende Beispiel zeigt die Antwort.

HTTP/1.1 204 No Content

Freigeben über

organizationalBranding aktualisieren

Berechtigungen

HTTP-Anforderung

Anforderungsheader

Anforderungstext

Antwort

Beispiele

Beispiel 1: Aktualisieren des Standardbrandings

Anforderung

Antwort

Beispiel 2: Aktualisieren von bannerLogo für das Standardbranding

Anforderung

Antwort

Feedback

Zusätzliche Ressourcen