organizationalBranding abrufen
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.
Rufen Sie das Standardmäßige Organisationsbrandingobjekt ab, wenn der Accept-Language-Header auf 0
oder default
festgelegt 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.
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) | User.Read | Organization.Read.All, Organization.ReadWrite.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, Organization.ReadWrite.All, OrganizationalBranding.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. Globaler Leser oder Organisationsbrandingadministrator sind die Am wenigsten privilegierten Rollen, die für diesen Vorgang unterstützt werden.
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 Authentifizierung und Autorisierung. |
Accept-Language | Ein gültiges ISO 639-1-Gebietsschema oder 0 für das Standardgebietsschema. 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/beta/organization/84841066-274d-4ec0-a5c1-276be684bdd3/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/beta/$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"
],
"contentCustomization": {
"attributeCollectionRelativeUrl": "dbd5a2dd-dt17xdjgu8kxc14xcav-rckknamct7yytiih-vm-ksm/logintenantbranding/1033/attributecollection?ts=638151133931615483",
"attributeCollection": [
{
"key": "AttributeCollection_Description",
"value": "We just need a little more information to set up your account."
},
{
"key": "AttributeCollection_Title",
"value": "Add details"
},
{
"key": "Attribute_City",
"value": "City"
},
{
"key": "Attribute_Country",
"value": "Country/Region"
},
{
"key": "Attribute_DisplayName",
"value": "Display Name"
},
{
"key": "Attribute_Email",
"value": "Email Address"
},
{
"key": "Attribute_Generic_ConfirmationLabel",
"value": "Re-enter"
},
{
"key": "Attribute_GivenName",
"value": "Given Name"
},
{
"key": "Attribute_JobTitle",
"value": "Job Title"
},
{
"key": "Attribute_Password",
"value": "Password"
},
{
"key": "Attribute_Password_MismatchErrorString",
"value": "Passwords do not match."
},
{
"key": "Attribute_PostalCode",
"value": "Postal Code"
},
{
"key": "Attribute_State",
"value": "State/Province"
},
{
"key": "Attribute_StreetAddress",
"value": "Street Address"
},
{
"key": "Attribute_Surname",
"value": "Sasha Surname"
},
{
"key": "SignIn_Description",
"value": "Sign in to access"
},
{
"key": "SignIn_Title",
"value": "Sign in"
},
{
"key": "SignUp_Description",
"value": "Sign up to access"
},
{
"key": "SignUp_Title",
"value": "Create account"
},
{
"key": "SisuOtc_Title",
"value": "Enter code"
},
{
"key": "Attribute_extension_82936c774db949fcac549215e8857017_Total_Job_Experience_Years",
"value": "Total_Job_Experience_Years"
}
]
},
"customAccountResetCredentialsUrl": null,
"customCannotAccessYourAccountText": null,
"customCannotAccessYourAccountUrl": null,
"customCSS": null,
"customCSSRelativetUrl": null,
"customForgotMyPasswordText": null,
"customPrivacyAndCookiesText": null,
"customPrivacyAndCookiesUrl": null,
"customTermsOfUseText": null,
"customTermsOfUseUrl": null,
"customResetItNowText": null,
"faviconRelativeUrl": null,
"headerBackgroundColor": null,
"headerLogoRelativeUrl": null,
"signInPageText": "Contoso",
"squareLogoRelativeUrl": "c1c6b6c8-urr-dzbkz44n5kuo9kzl1kziuujjcdqonoe2owyacso/logintenantbranding/0/tilelogo?ts=637535563832888580",
"squareLogoDarkRelativeUrl": null,
"usernameHintText": " ",
"loginPageLayoutConfiguration": {
"layoutTemplateType": "default",
"isHeaderShown": false,
"isFooterShown": true
},
"loginPageTextVisibilitySettings": {
"hideCannotAccessYourAccount": false,
"hideForgotMyPassword": false,
"hideResetItNow": false,
"hideTermsOfUse": true,
"hidePrivacyAndCookies": true
}
}
Beispiel 2: Abrufen des Unternehmensbrandings, wenn kein Branding konfiguriert ist
Anforderung
Das folgende Beispiel zeigt eine Anfrage.
GET https://graph.microsoft.com/beta/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/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 verwendet, um anzugeben, um das Lokalisierungsbranding fr-FR
abzurufen.
Anforderung
Das folgende Beispiel zeigt eine Anfrage.
GET https://graph.microsoft.com/beta/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/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/beta/$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,
"squareLogoDarkRelativeUrl": 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/beta/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/beta/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/default/bannerLogo
Antwort
Das folgende Beispiel zeigt die Antwort.
HTTP/1.1 200 OK
{}