organizationalBranding abrufen

Namespace: microsoft.graph

Rufen Sie das Standardmäßige Organisationsbrandingobjekt ab, wenn der Accept-Language-Header auf 0 oder defaultfestgelegt ist. Wenn kein standardmäßiges Organisationsbrandingobjekt vorhanden ist, gibt diese Methode einen Fehler zurück 404 Not Found .

Wenn der Accept-Language-Header auf ein vorhandenes Gebietsschema festgelegt ist, das durch den Wert seiner ID identifiziert wird, ruft diese Methode das Branding für das angegebene Gebietsschema ab.

Diese Methode ruft nur nicht Stream Eigenschaften ab, z. B. usernameHintText und signInPageText. Um Stream Typen des Standardbrandings abzurufen, z. B. bannerLogo und backgroundImage, verwenden Sie die METHODE GET organizationalBrandingLocalization.

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) User.Read Organization.Read.All, OrganizationalBranding.Read.All, OrganizationalBranding.ReadWrite.All, User.Read.All
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Anwendung OrganizationalBranding.Read.All Organization.Read.All, OrganizationalBranding.ReadWrite.All

Bei delegierten Szenarien muss der angemeldete Benutzer mindestens über die Rolle Globaler Leser oder OrganisationsbrandingadministratorMicrosoft Entra verfügen.

HTTP-Anforderung

GET /organization/{organizationId}/branding

Optionale Abfrageparameter

Diese Methode unterstützt nur den $select OData-Abfrageparameter, um die Antwort anzupassen. Allgemeine Informationen finden Sie unter OData-Abfrageparameter.

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über die Authentifizierung und Autorisierung.
Accept-Language Ein gültiges ISO 639-1-Gebietsschema. Erforderlich.

Anforderungstext

Geben Sie keinen Anforderungstext für diese Methode an.

Antwort

Wenn die Methode erfolgreich verläuft, werden der 200 OK Antwortcode und ein organizationalBranding-Objekt im Antworttext zurückgegeben. Wenn kein Standardbrandingobjekt vorhanden ist, gibt diese Methode einen 404 Not Found Antwortcode zurück.

Beispiele

Beispiel 1: Abrufen des Standardbrandings

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

GET https://graph.microsoft.com/v1.0/organization/dcd219dd-bc68-4b9b-bf0b-4a33a796be35/branding
Accept-Language: 0

Antwort

Das folgende Beispiel zeigt die Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#branding",
    "@odata.id": "https://graph.microsoft.com/v2/99b24e1b-abec-4598-9d63-a2baf0a3cea1/directoryObjects/$/Microsoft.DirectoryServices.Organization('99b24e1b-abec-4598-9d63-a2baf0a3cea1')/branding/0",
    "id": "0",
    "backgroundColor": "",
    "backgroundImageRelativeUrl": "c1c6b6c8-urr-dzbkz44n5kuo9kzl1kziuujjcdqonoe2owyacso/logintenantbranding/0/illustration?ts=637535563816027796",
    "bannerLogoRelativeUrl": "c1c6b6c8-urr-dzbkz44n5kuo9kzl1kziuujjcdqonoe2owyacso/logintenantbranding/0/bannerlogo?ts=637535563824629275",
    "cdnList": [
        "secure.aadcdn.microsoftonline-p.com",
        "aadcdn.msftauthimages.net",
        "aadcdn.msauthimages.net"
    ],
    "signInPageText": "Contoso",
    "squareLogoRelativeUrl": "c1c6b6c8-urr-dzbkz44n5kuo9kzl1kziuujjcdqonoe2owyacso/logintenantbranding/0/tilelogo?ts=637535563832888580",
    "usernameHintText": ""
}

Beispiel 2: Abrufen des Unternehmensbrandings, wenn kein Branding konfiguriert ist

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

GET https://graph.microsoft.com/v1.0/organization/dcd219dd-bc68-4b9b-bf0b-4a33a796be35/branding
Accept-Language: 0

Antwort

Das folgende Beispiel zeigt die Antwort.

HTTP/1.1 404 Not Found

Beispiel 3: Abrufen des Organisationsbrandings für das französische Gebietsschema

Im folgenden Beispiel wird der Accept-Language-Header zum Abrufen des Lokalisierungsbrandings fr-FR verwendet.

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

GET https://graph.microsoft.com/v1.0/organization/dcd219dd-bc68-4b9b-bf0b-4a33a796be35/branding
Accept-Language: fr-FR

Antwort

Das folgende Beispiel zeigt die Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#branding",
    "@odata.id": "https://graph.microsoft.com/v2/84841066-274d-4ec0-a5c1-276be684bdd3/directoryObjects/$/Microsoft.DirectoryServices.Organization('84841066-274d-4ec0-a5c1-276be684bdd3')/branding/fr-FR",
    "id": "fr-FR",
    "backgroundColor": "#FFFF33",
    "backgroundImageRelativeUrl": null,
    "bannerLogoRelativeUrl": null,
    "cdnList": [],
    "signInPageText": " ",
    "squareLogoRelativeUrl": null,
    "usernameHintText": " "
}

Beispiel 4: Abrufen des BannerLogos für das Standardgebietsschema

Im folgenden Beispiel wird das bannerLogo-Objekt für das Standardgebietsschema zurückgegeben. Um Stream Objekttypen abzurufen, z. B. bannerLogo, verwenden Sie die Get organizationalBrandingLocalization-Methode. Sie können den Wert von id als default oder 0 in der Anforderungs-URL angeben. Wenn die Eigenschaft nicht festgelegt ist, gibt die Anforderung eine leere Antwort zurück.

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

GET https://graph.microsoft.com/v1.0/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/default/bannerLogo

Antwort

Das folgende Beispiel zeigt die Antwort.

HTTP/1.1 200 OK
Content-Type: image/*

<Image>

Beispiel 5: Abrufen des BannerLogos für das Standardgebietsschema, wenn es nicht festgelegt ist

Im folgenden Beispiel wird das bannerLogo-Objekt zurückgegeben, das für das Standardgebietsschema nicht festgelegt wurde.

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

GET https://graph.microsoft.com/v1.0/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/default/bannerLogo

Antwort

Das folgende Beispiel zeigt die Antwort.

HTTP/1.1 200 OK

{}