Microsoft Entra ID (formerly Azure AD) Organization.organizational Branding API
The organization.organizationalBranding API from Microsoft Entra ID (formerly Azure AD) — 18 operation(s) for organization.organizationalbranding.
Operations 51
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
GET
/organization/{organization-id}/branding
Get the organization's default sign-in branding · Get organizationalBranding
#
Ask an LLM
“What sign-in page text and username hint does our default company branding use?”
“Why do I get a 404 when reading branding for an organization with none set up?”
Tell an agent
Show the default sign-in branding for organization {org}.
Get company branding properties {select} for tenant {org}.
PATCH
/organization/{organization-id}/branding
Update the default organizational branding · Update organizationalBranding
#
Ask an LLM
“How do I change our default sign-in branding properties?”
“Can I edit the localizations attached to the default branding object?”
Tell an agent
Update the default branding of organization {org}.
Patch the default company branding for {org} with localizations {localizations}.
DELETE
/organization/{organization-id}/branding
Delete the default organizational branding · Delete organizationalBranding
#
Ask an LLM
“Can I wipe out our default company branding entirely?”
“Do I have to remove all the branding images before deleting the default branding?”
Tell an agent destructive · confirm first
Delete the default company branding object for organization {org}.
Reset tenant {org} to no custom branding by deleting its default branding.
GET
/organization/{organization-id}/branding/backgroundImage
Download the default sign-in background image · Get backgroundImage for the navigation property branding from organization
#
Ask an LLM
“What background picture is shown behind our default sign-in page?”
“Can I fetch the full-screen backdrop image from the default branding?”
Tell an agent
Download the default sign-in page background image for organization {org}.
Fetch the backdrop picture used by tenant {org}'s default branding.
PUT
/organization/{organization-id}/branding/backgroundImage
Upload the default sign-in background image · Update backgroundImage for the navigation property branding in organization
#
Ask an LLM
“What size limits apply to a sign-in background image, like the 1920 × 1080 maximum?”
“Can I replace the full-page backdrop on our default sign-in screen with a JPEG?”
Tell an agent
Upload a new default sign-in background image for organization {org}.
Replace the backdrop photo in tenant {org}'s default branding.
DELETE
/organization/{organization-id}/branding/backgroundImage
Remove the default sign-in background image · Delete backgroundImage for the navigation property branding in organization
#
Ask an LLM
“Can I get rid of the custom background on our default sign-in page?”
“Is removing the default backdrop image needed before deleting branding?”
Tell an agent destructive · confirm first
Remove the default sign-in background image from organization {org}.
Clear the backdrop picture out of tenant {org}'s default branding.
GET
/organization/{organization-id}/branding/bannerLogo
Download the default banner logo · Get bannerLogo for the navigation property branding from organization
#
Ask an LLM
“Which banner version of our company logo appears on the default sign-in page?”
“Can I retrieve the wide banner logo from our base company branding?”
Tell an agent
Download the default banner logo for organization {org}.
Get the wide company banner image from tenant {org}'s base branding.
PUT
/organization/{organization-id}/branding/bannerLogo
Upload the default banner logo · Update bannerLogo for the navigation property branding in organization
#
Ask an LLM
“What dimensions are allowed for a sign-in banner logo, like the 36 × 245 limit?”
“Can I swap in a transparent banner logo for our base branding?”
Tell an agent
Upload a new default banner logo for organization {org}.
Replace the wide company banner in tenant {org}'s base branding.
DELETE
/organization/{organization-id}/branding/bannerLogo
Remove the default banner logo · Delete bannerLogo for the navigation property branding in organization
#
Ask an LLM
“Can I drop the banner logo from our default sign-in branding?”
“What happens to the sign-in page if the base banner logo is deleted?”
Tell an agent destructive · confirm first
Remove the default banner logo from organization {org}.
Delete the wide company banner out of tenant {org}'s base branding.
GET
/organization/{organization-id}/branding/customCSS
Download the default sign-in custom CSS · Get customCSS for the navigation property branding from organization
#
Ask an LLM
“What custom stylesheet is applied to our default sign-in page?”
“Can I pull down the CSS file from the base company branding to edit it?”
Tell an agent
Download the default custom CSS for organization {org}'s sign-in page.
Get the stylesheet used by tenant {org}'s base branding.
PUT
/organization/{organization-id}/branding/customCSS
Upload the default sign-in custom CSS · Update customCSS for the navigation property branding in organization
#
Ask an LLM
“Is there a size limit on sign-in page CSS, such as 25 KB?”
“Can I restyle our default sign-in page by uploading a .css file?”
Tell an agent
Upload new default custom CSS for organization {org}'s sign-in page.
Replace the stylesheet in tenant {org}'s base branding.
DELETE
/organization/{organization-id}/branding/customCSS
Remove the default sign-in custom CSS · Delete customCSS for the navigation property branding in organization
#
Ask an LLM
“Can I go back to the stock look by removing our default sign-in CSS?”
“Will deleting the base branding stylesheet affect localized branding?”
Tell an agent destructive · confirm first
Remove the default custom CSS from organization {org}.
Delete the stylesheet out of tenant {org}'s base branding.
GET
/organization/{organization-id}/branding/favicon
Download the default favicon · Get favicon for the navigation property branding from organization
#
Ask an LLM
“What browser tab icon does our default Entra branding use?”
“Can I retrieve the custom favicon that replaces the Microsoft default?”
Tell an agent
Download the default favicon for organization {org}.
Get the browser tab icon from tenant {org}'s base branding.
PUT
/organization/{organization-id}/branding/favicon
Upload the default favicon · Update favicon for the navigation property branding in organization
#
Ask an LLM
“Can I replace the Microsoft favicon on our tenant with our own icon?”
“Where do I upload a custom browser tab icon for the base branding?”
Tell an agent
Upload a new default favicon for organization {org}.
Swap the browser tab icon in tenant {org}'s base branding for our own.
DELETE
/organization/{organization-id}/branding/favicon
Remove the default favicon · Delete favicon for the navigation property branding in organization
#
Ask an LLM
“Can I restore the standard Microsoft favicon by deleting ours?”
“Is it possible to drop the custom tab icon from the base branding?”
Tell an agent destructive · confirm first
Remove the default favicon from organization {org}.
Delete the custom browser tab icon out of tenant {org}'s base branding.
GET
/organization/{organization-id}/branding/headerLogo
Download the default header logo · Get headerLogo for the navigation property branding from organization
#
Ask an LLM
“Which logo shows in the header strip of our default sign-in page?”
“Can I retrieve the header company logo from the base branding?”
Tell an agent
Download the default header logo for organization {org}.
Get the page-header company logo from tenant {org}'s base branding.
PUT
/organization/{organization-id}/branding/headerLogo
Upload the default header logo · Update headerLogo for the navigation property branding in organization
#
Ask an LLM
“What file types are accepted for the logo in the sign-in page header?”
“Can I put our logo in the header area of the default sign-in screen?”
Tell an agent
Upload a new default header logo for organization {org}.
Replace the page-header company logo in tenant {org}'s base branding.
DELETE
/organization/{organization-id}/branding/headerLogo
Remove the default header logo · Delete headerLogo for the navigation property branding in organization
#
Ask an LLM
“Can I take our logo out of the default sign-in page header?”
“Is deleting the base header logo reversible by uploading a new one later?”
Tell an agent destructive · confirm first
Remove the default header logo from organization {org}.
Delete the page-header company logo out of tenant {org}'s base branding.
GET
/organization/{organization-id}/branding/localizations
List branding localizations · List localizations
#
Ask an LLM
“Which languages have their own sign-in branding in our tenant?”
“Does the list of branding localizations include the default one?”
Tell an agent
List every branding localization for organization {org}.
Show the first {top} localized brandings of tenant {org}.
POST
/organization/{organization-id}/branding/localizations
Create a localized branding · Create organizationalBrandingLocalization
#
Ask an LLM
“How do I add sign-in branding for a specific browser language?”
“Does creating a localized branding also create the default branding if it's missing?”
Tell an agent
Create a new language-specific branding for organization {org}.
Add a localized sign-in branding to tenant {org}.
GET
/organization/{organization-id}/branding/localizations/{organizationalBrandingLocalization-id}
Get one localized branding · Get organizationalBrandingLocalization
#
Ask an LLM
“What sign-in text is configured for one particular language's branding?”
“Can I read a localized branding by its locale ID?”
Tell an agent
Get the {locale} branding localization of organization {org}.
Show the properties of localized branding {locale} for tenant {org}.
PATCH
/organization/{organization-id}/branding/localizations/{organizationalBrandingLocalization-id}
Update a localized branding · Update organizationalBrandingLocalization
#
Ask an LLM
“How do I change the sign-in text for one language's branding?”
“Can I edit a single locale's branding without touching the default?”
Tell an agent
Update the {locale} branding localization of organization {org}.
Edit properties of localized branding {locale} in tenant {org}.
DELETE
/organization/{organization-id}/branding/localizations/{organizationalBrandingLocalization-id}
Delete a localized branding · Delete organizationalBrandingLocalization
#
Ask an LLM
“Can I remove the branding for a single language?”
“Must the images be removed from a localized branding before deleting it?”
Tell an agent destructive · confirm first
Delete the {locale} branding localization from organization {org}.
Drop localized branding {locale} in tenant {org}.
GET
/organization/{organization-id}/branding/localizations/{organizationalBrandingLocalization-id}/backgroundImage
Download a localized sign-in background image · Get backgroundImage for the navigation property localizations from organization
#
Ask an LLM
“What backdrop picture is shown for users signing in in a specific language?”
“Can I fetch the background image of one localized branding?”
Tell an agent
Download the translated sign-in background image for the {locale} locale of organization {org}.
Fetch the language-specific backdrop in localization {locale} of tenant {org}.
PUT
/organization/{organization-id}/branding/localizations/{organizationalBrandingLocalization-id}/backgroundImage
Upload a localized sign-in background image · Update backgroundImage for the navigation property localizations in organization
#
Ask an LLM
“Can each language have its own sign-in background photo?”
“Do localized backdrop uploads follow the same PNG or JPEG size limits?”
Tell an agent
Upload the translated sign-in background image for the {locale} locale of organization {org}.
Set a language-specific backdrop on localization {locale} of tenant {org}.
DELETE
/organization/{organization-id}/branding/localizations/{organizationalBrandingLocalization-id}/backgroundImage
Remove a localized sign-in background image · Delete backgroundImage for the navigation property localizations in organization
#
Ask an LLM
“Can I clear the backdrop from just one language's branding?”
“Should I delete a localization's background image before deleting the localization?”
Tell an agent destructive · confirm first
Remove the translated sign-in background image from the {locale} locale of organization {org}.
Clear the language-specific backdrop in localization {locale} of tenant {org}.
GET
/organization/{organization-id}/branding/localizations/{organizationalBrandingLocalization-id}/bannerLogo
Download a localized banner logo · Get organizationalBranding
#
Ask an LLM
“Which banner logo do users see when signing in in a particular language?”
“Can I retrieve the banner logo from a single localization?”
Tell an agent
Download the translated banner logo for the {locale} locale of organization {org}.
Get the language-specific wide banner in localization {locale} of tenant {org}.
PUT
/organization/{organization-id}/branding/localizations/{organizationalBrandingLocalization-id}/bannerLogo
Upload a localized banner logo · Update organizationalBrandingLocalization
#
Ask an LLM
“Can I give one language its own banner logo on the sign-in page?”
“Is a translated banner logo uploaded per localization?”
Tell an agent
Upload the translated banner logo for the {locale} locale of organization {org}.
Set a language-specific wide banner on localization {locale} of tenant {org}.
DELETE
/organization/{organization-id}/branding/localizations/{organizationalBrandingLocalization-id}/bannerLogo
Remove a localized banner logo · Delete bannerLogo for the navigation property localizations in organization
#
Ask an LLM
“Can I delete the banner logo from one language's branding only?”
“Does removing a localized banner logo fall back to the default one?”
Tell an agent destructive · confirm first
Remove the translated banner logo from the {locale} locale of organization {org}.
Delete the language-specific wide banner in localization {locale} of tenant {org}.
GET
/organization/{organization-id}/branding/localizations/{organizationalBrandingLocalization-id}/customCSS
Download a localized sign-in custom CSS · Get customCSS for the navigation property localizations from organization
#
Ask an LLM
“What stylesheet applies to the sign-in page for a given language?”
“Can I download the CSS attached to one localization?”
Tell an agent
Download the translated custom CSS for the {locale} locale of organization {org}.
Get the language-specific stylesheet in localization {locale} of tenant {org}.
PUT
/organization/{organization-id}/branding/localizations/{organizationalBrandingLocalization-id}/customCSS
Upload a localized sign-in custom CSS · Update customCSS for the navigation property localizations in organization
#
Ask an LLM
“Can I style the sign-in page differently for one language with its own CSS?”
“Does the 25 KB CSS limit apply to each localization's stylesheet too?”
Tell an agent
Upload translated custom CSS for the {locale} locale of organization {org}.
Set a language-specific stylesheet on localization {locale} of tenant {org}.
DELETE
/organization/{organization-id}/branding/localizations/{organizationalBrandingLocalization-id}/customCSS
Remove a localized sign-in custom CSS · Delete customCSS for the navigation property localizations in organization
#
Ask an LLM
“Can I strip the custom CSS from a single language's sign-in branding?”
“Is it possible to delete one locale's stylesheet but keep the default CSS?”
Tell an agent destructive · confirm first
Remove the translated custom CSS from the {locale} locale of organization {org}.
Delete the language-specific stylesheet in localization {locale} of tenant {org}.
GET
/organization/{organization-id}/branding/localizations/{organizationalBrandingLocalization-id}/favicon
Download a localized favicon · Get favicon for the navigation property localizations from organization
#
Ask an LLM
“Which tab icon is used for one language's sign-in branding?”
“Can I retrieve the favicon of a specific localization?”
Tell an agent
Download the translated favicon for the {locale} locale of organization {org}.
Get the language-specific tab icon in localization {locale} of tenant {org}.
PUT
/organization/{organization-id}/branding/localizations/{organizationalBrandingLocalization-id}/favicon
Upload a localized favicon · Update favicon for the navigation property localizations in organization
#
Ask an LLM
“Can a single language's branding carry its own favicon?”
“Is uploading a per-locale tab icon supported?”
Tell an agent
Upload the translated favicon for the {locale} locale of organization {org}.
Set a language-specific tab icon on localization {locale} of tenant {org}.
DELETE
/organization/{organization-id}/branding/localizations/{organizationalBrandingLocalization-id}/favicon
Remove a localized favicon · Delete favicon for the navigation property localizations in organization
#
Ask an LLM
“Can I delete the favicon from just one localization?”
“What icon shows after a locale's custom favicon is removed?”
Tell an agent destructive · confirm first
Remove the translated favicon from the {locale} locale of organization {org}.
Delete the language-specific tab icon in localization {locale} of tenant {org}.
GET
/organization/{organization-id}/branding/localizations/{organizationalBrandingLocalization-id}/headerLogo
Download a localized header logo · Get headerLogo for the navigation property localizations from organization
#
Ask an LLM
“Which header logo appears on the sign-in page for a specific language?”
“Can I fetch one localization's page-header logo?”
Tell an agent
Download the translated header logo for the {locale} locale of organization {org}.
Get the language-specific page-header logo in localization {locale} of tenant {org}.
PUT
/organization/{organization-id}/branding/localizations/{organizationalBrandingLocalization-id}/headerLogo
Upload a localized header logo · Update headerLogo for the navigation property localizations in organization
#
Ask an LLM
“Can I show a different header logo to users of one language?”
“Is a per-locale header logo limited to PNG or JPEG?”
Tell an agent
Upload the translated header logo for the {locale} locale of organization {org}.
Set a language-specific page-header logo on localization {locale} of tenant {org}.
DELETE
/organization/{organization-id}/branding/localizations/{organizationalBrandingLocalization-id}/headerLogo
Remove a localized header logo · Delete headerLogo for the navigation property localizations in organization
#
Ask an LLM
“Can I take the header logo out of one language's branding?”
“Is it possible to clear a locale's header logo while keeping its other images?”
Tell an agent destructive · confirm first
Remove the translated header logo from the {locale} locale of organization {org}.
Delete the language-specific page-header logo in localization {locale} of tenant {org}.
GET
/organization/{organization-id}/branding/localizations/{organizationalBrandingLocalization-id}/squareLogo
Download a localized square logo · Get squareLogo for the navigation property localizations from organization
#
Ask an LLM
“Which square logo appears in Windows Autopilot setup for a particular language?”
“Can I retrieve the light square logo from one localization?”
Tell an agent
Download the translated square logo for the {locale} locale of organization {org}.
Get the language-specific Windows OOBE logo in localization {locale} of tenant {org}.
PUT
/organization/{organization-id}/branding/localizations/{organizationalBrandingLocalization-id}/squareLogo
Upload a localized square logo · Update squareLogo for the navigation property localizations in organization
#
Ask an LLM
“Can each language get its own square logo for Windows out-of-box experience screens?”
“Is a per-locale square logo capped at 240 x 240 pixels and 10 KB?”
Tell an agent
Upload the translated square logo for the {locale} locale of organization {org}.
Set a language-specific Windows OOBE logo on localization {locale} of tenant {org}.
DELETE
/organization/{organization-id}/branding/localizations/{organizationalBrandingLocalization-id}/squareLogo
Remove a localized square logo · Delete squareLogo for the navigation property localizations in organization
#
Ask an LLM
“Can I remove the square Autopilot logo from one language's branding?”
“Does deleting a locale's light square logo leave the dark variant in place?”
Tell an agent destructive · confirm first
Remove the translated square logo from the {locale} locale of organization {org}.
Delete the language-specific Windows OOBE logo in localization {locale} of tenant {org}.
GET
/organization/{organization-id}/branding/localizations/{organizationalBrandingLocalization-id}/squareLogoDark
Download a localized dark square logo · Get squareLogoDark for the navigation property localizations from organization
#
Ask an LLM
“What dark-theme square logo does a given language show during Windows setup?”
“Can I pull the dark variant of the square logo for one locale?”
Tell an agent
Download the dark-mode square logo in the {locale} branding of organization {org}.
Fetch localization {locale}'s dark Autopilot icon for tenant {org}.
PUT
/organization/{organization-id}/branding/localizations/{organizationalBrandingLocalization-id}/squareLogoDark
Upload a localized dark square logo · Update squareLogoDark for the navigation property localizations in organization
#
Ask an LLM
“Can I provide a dark version of the square logo for a single language?”
“Which image formats work for a locale's dark-theme Autopilot logo?”
Tell an agent
Upload a dark-mode square logo into the {locale} branding of organization {org}.
Replace localization {locale}'s dark Autopilot icon for tenant {org}.
DELETE
/organization/{organization-id}/branding/localizations/{organizationalBrandingLocalization-id}/squareLogoDark
Remove a localized dark square logo · Delete squareLogoDark for the navigation property localizations in organization
#
Ask an LLM
“Can I delete just the dark square logo from one language's branding?”
“Is removing a locale's dark-theme Windows logo independent of the light one?”
Tell an agent destructive · confirm first
Remove the dark-mode square logo from the {locale} branding of organization {org}.
Clear localization {locale}'s dark Autopilot icon for tenant {org}.
GET
/organization/{organization-id}/branding/localizations/$count
Count branding localizations · Get the number of the resource
#
Ask an LLM
“How many languages have localized sign-in branding configured?”
“Can I count branding localizations matching a filter?”
Tell an agent
Count the branding localizations of organization {org}.
Tell me how many localized brandings in tenant {org} match {filter}.
GET
/organization/{organization-id}/branding/squareLogo
Download the default square logo · Get squareLogo for the navigation property branding from organization
#
Ask an LLM
“Which square logo shows in Windows 10 out-of-box setup for our tenant by default?”
“Can I retrieve the standard light square logo from base branding?”
Tell an agent
Download the default square logo for organization {org}.
Get the Windows OOBE logo from tenant {org}'s base branding.
PUT
/organization/{organization-id}/branding/squareLogo
Upload the default square logo · Update squareLogo for the navigation property branding in organization
#
Ask an LLM
“What are the limits for the Autopilot square logo, like 240 x 240 pixels and 10 KB?”
“Can I set the square logo used by default when Windows Autopilot is enabled?”
Tell an agent
Upload a new default square logo for organization {org}.
Replace the Windows OOBE logo in tenant {org}'s base branding.
DELETE
/organization/{organization-id}/branding/squareLogo
Remove the default square logo · Delete squareLogo for the navigation property branding in organization
#
Ask an LLM
“Can I remove the square logo shown during default Windows setup?”
“Does deleting the base light square logo also remove the dark one?”
Tell an agent destructive · confirm first
Remove the default square logo from organization {org}.
Delete the Windows OOBE logo out of tenant {org}'s base branding.
GET
/organization/{organization-id}/branding/squareLogoDark
Download the default dark square logo · Get squareLogoDark for the navigation property branding from organization
#
Ask an LLM
“What dark-theme square logo does our tenant show by default in Windows setup?”
“Can I pull the dark variant of the base square logo?”
Tell an agent
Download the dark-mode square logo in organization {org}'s default branding.
Fetch the base dark Autopilot icon for tenant {org}.
PUT
/organization/{organization-id}/branding/squareLogoDark
Upload the default dark square logo · Update squareLogoDark for the navigation property branding in organization
#
Ask an LLM
“Can I supply a dark version of our square logo for default Windows out-of-box screens?”
“Is there a size cap on the base dark-theme Autopilot logo?”
Tell an agent
Upload a dark-mode square logo into organization {org}'s default branding.
Replace the base dark Autopilot icon for tenant {org}.
DELETE
/organization/{organization-id}/branding/squareLogoDark
Remove the default dark square logo · Delete squareLogoDark for the navigation property branding in organization
#
Ask an LLM
“Can I delete only the dark square logo from our base branding?”
“Is the default dark-theme Windows logo removable on its own?”
Tell an agent destructive · confirm first
Remove the dark-mode square logo from organization {org}'s default branding.
Clear the base dark Autopilot icon for tenant {org}.