Skip to content

Commit f3689bb

Browse files
Merge pull request #226865 from shlipsey3/company-branding-api-020923
company-branding-api
2 parents a81e56e + 813da65 commit f3689bb

File tree

3 files changed

+35
-23
lines changed

3 files changed

+35
-23
lines changed

articles/active-directory/fundamentals/customize-branding.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.service: active-directory
99
ms.workload: identity
1010
ms.subservice: fundamentals
1111
ms.topic: how-to
12-
ms.date: 11/21/2022
12+
ms.date: 03/01/2023
1313
ms.author: sarahlipsey
1414
ms.reviewer: kexia
1515
ms.custom: "it-pro, seodec18, fasttrack-edit"
@@ -24,7 +24,7 @@ This article covers how to customize the company branding for sign-in experience
2424

2525
An updated experience for adding company branding is available as an Azure AD preview feature. To opt in and explore the new experience, go to **Azure AD** > **Preview features** and enable the **Enhanced Company Branding** feature. Check out the updated documentation on [how to customize branding](how-to-customize-branding.md).
2626

27-
## License requirements
27+
## Role and license requirements
2828

2929
Adding custom branding requires one of the following licenses:
3030

@@ -34,7 +34,9 @@ Adding custom branding requires one of the following licenses:
3434

3535
Azure AD Premium editions are available for customers in China using the worldwide instance of Azure AD. Azure AD Premium editions aren't currently supported in the Azure service operated by 21Vianet in China. For more information about licensing and editions, see [Sign up for Azure AD Premium](active-directory-get-started-premium.md).
3636

37-
## Customize the default sign-in experience
37+
The **Global Administrator** role is required to customize company branding.
38+
39+
## Before you begin
3840

3941
You can customize the sign-in experience when users sign in to your organization's tenant-specific apps, such as `https://outlook.com/woodgrove.com`, or when passing a domain variable, such as `https://passwordreset.microsoftonline.com/?whr=woodgrove.com`.
4042

@@ -44,6 +46,10 @@ Custom branding appears after users sign in. Users that start the sign-in proces
4446

4547
**Images have different image and file size requirements.** Take note of the requirements for each option. You may need to use a photo editor to create the right-sized images. The preferred image type for all images is PNG, but JPG is accepted.
4648

49+
**Use Microsoft Graph with Azure AD company branding.** Company branding can be viewed and managed using Microsoft Graph on the `/beta` endpoint and the `organizationalBranding` resource type. For more information, see the [organizational branding API documentation](/graph/api/resources/organizationalbranding?view=graph-rest-beta&preserve-view=true).
50+
51+
## How to configure company branding
52+
4753
1. Sign in to the [Azure portal](https://portal.azure.com/) using a Global administrator account for the directory.
4854

4955
2. Go to **Azure Active Directory** > **Company branding** > **Configure**.
@@ -54,7 +60,7 @@ Custom branding appears after users sign in. Users that start the sign-in proces
5460

5561
- **Language** The language for your first customized branding configuration is based on your default locale can't be changed. Once a default sign-in experience is created, you can add language-specific customized branding.
5662

57-
- **Sign-in page background image** Select a PNG or JPG image file to appear as the background for your sign-in pages. The image will be anchored to the center of the browser, and will scale to the size of the viewable space.
63+
- **Sign-in page background image** Select a PNG or JPG image file to appear as the background for your sign-in pages. The image is anchored to the center of the browser, and scales to the size of the viewable space.
5864

5965
We recommended using images without a strong subject focus. An opaque white box appears in the center of the screen, which could cover any part of the image depending on the dimensions of the viewable space.
6066

@@ -79,17 +85,17 @@ Custom branding appears after users sign in. Users that start the sign-in proces
7985
> [!IMPORTANT]
8086
> Hyperlinks that are added to the sign-in page text render as text in native environments, such as desktop and mobile applications.
8187
82-
- **Advanced settings**
88+
- **Advanced settings**
8389

8490
![Configure company branding page, with advanced settings completed](media/customize-branding/legacy-customize-branding-configure-advanced.png)
8591

86-
- **Sign-in page background color** Specify the hexadecimal color (#FFFFFF) that will appear in place of your background image in low-bandwidth connection situations. We recommend using the primary color of your banner logo or your organization color.
92+
- **Sign-in page background color** Specify the hexadecimal color (#FFFFFF) that appears in place of your background image in low-bandwidth connection situations. We recommend using the primary color of your banner logo or your organization color.
8793

88-
- **Square logo image** Select a PNG or JPG image of your organization's logo to appear during the setup process for new Windows 10 Enterprise devices. This image is only used for Windows authentication and appears only on tenants that are using [Windows Autopilot](/windows/deployment/windows-autopilot/windows-10-autopilot) for deployment or for password entry pages in other Windows 10 experiences. In some cases, it may also appear in the consent dialog.
94+
- **Square logo image** Select a PNG or JPG image of your organization's logo to appear during the setup process for new Windows 10 Enterprise devices. This image is only used for Windows authentication and only appears on tenants that are using [Windows Autopilot](/windows/deployment/windows-autopilot/windows-10-autopilot) for deployment or password entry pages in other Windows 10 experiences. In some cases, it may also appear in the consent dialog.
8995

9096
We recommend using a transparent image since the background might not match your logo background. We also recommend not adding padding around the image or it might make your logo look small.
9197

92-
- **Square logo image, dark theme** Same as the square logo image above. This logo image takes the place of the square logo image when used with a dark background, such as with Windows 10 Azure AD joined screens during the out-of-box experience (OOBE). If your logo looks good on white, dark blue, and black backgrounds, you don't need to add this image.
98+
- **Square logo image, dark theme** Same as the square logo image. This logo image takes the place of the square logo image when used with a dark background, such as with Windows 10 Azure AD joined screens during the out-of-box experience (OOBE). If your logo looks good on white, dark blue, and black backgrounds, you don't need to add this image.
9399

94100
>[!IMPORTANT]
95101
> Transparent logos are supported with the square logo image. The color palette used in the transparent logo could conflict with backgrounds (such as, white, light grey, dark grey, and black backgrounds) used within Microsoft 365 apps and services that consume the square logo image. Solid color backgrounds may need to be used to ensure the square image logo is rendered correctly in all situations.
@@ -101,7 +107,7 @@ Custom branding appears after users sign in. Users that start the sign-in proces
101107
This process creates your first custom branding configuration, and it becomes the default for your tenant. The default custom branding configuration serves as a fallback option for all language-specific branding configurations. The configuration can't be removed after you create it.
102108

103109
>[!IMPORTANT]
104-
>To add more corporate branding configurations to your tenant, you must choose **New language** on the **Contoso - Company branding** page. This opens the **Configure company branding** page, where you can follow the same steps as above.
110+
>To add more corporate branding configurations to your tenant, you must choose **New language** on the **Contoso - Company branding** page. This opens the **Configure company branding** page, where you can follow the previous steps.
105111
106112
## Customize the sign-in experience by browser language
107113

@@ -111,13 +117,13 @@ To create an inclusive experience for all of your users, you can customize the s
111117

112118
2. Select **Azure Active Directory** > **Company branding** > **+ New language**.
113119

114-
The process for customizing the experience is the same as the [Default sign-in experience](#customize-the-default-sign-in-experience), except you select a **Language** from the dropdown list.
120+
The process for customizing the experience is the same as the main [configure company branding](#configure-your-company-branding) process, except you select a **Language** from the dropdown list.
115121

116122
We recommend adding **Sign-in page text** in the selected language.
117123

118124
## Edit custom branding
119125

120-
If custom branding has been added to your tenant, you can edit the details already provided. Refer to the details and descriptions of each setting in the [Add custom branding](#customize-the-default-sign-in-experience) section of this article.
126+
If custom branding has been added to your tenant, you can edit the details already provided. Refer to the details and descriptions of each setting in the [configure your company branding](#configure-your-company-branding) section of this article.
121127

122128
1. Sign in to the [Azure portal](https://portal.azure.com/) using a Global Administrator account for the directory.
123129

@@ -134,4 +140,4 @@ If custom branding has been added to your tenant, you can edit the details alrea
134140
## Next steps
135141

136142
- [Add your organization's privacy info on Azure AD](./active-directory-properties-area.md)
137-
- [Learn more about Conditional Access](../conditional-access/overview.md)
143+
- [Learn more about Conditional Access](../conditional-access/overview.md)

articles/active-directory/fundamentals/how-to-customize-branding.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.service: active-directory
99
ms.workload: identity
1010
ms.subservice: fundamentals
1111
ms.topic: how-to
12-
ms.date: 01/31/2023
12+
ms.date: 03/01/2023
1313
ms.author: sarahlipsey
1414
ms.reviewer: almars
1515
ms.custom: "it-pro, seodec18, fasttrack-edit"
@@ -20,17 +20,17 @@ ms.collection: M365-identity-device-management
2020

2121
When users authenticate into your corporate intranet or web-based applications, Azure Active Directory (Azure AD) provides the identity and access management (IAM) service. You can add company branding that applies to all these sign-in experiences to create a consistent experience for your users.
2222

23-
The default sign-in experience is the global look and feel that applies across all sign-ins to your tenant. Before you customize any settings, the default Microsoft branding will appear in your sign-in pages. You can customize this default experience with a custom background image or color, favicon, layout, header, and footer. You can also upload a custom CSS.
23+
The default sign-in experience is the global look and feel that applies across all sign-ins to your tenant. Before you customize any settings, the default Microsoft branding appears in your sign-in pages. You can customize this default experience with a custom background image or color, favicon, layout, header, and footer. You can also upload a custom CSS.
2424

25-
The updated experience for adding company branding covered in this article is available as an Azure AD preview feature. To opt in and explore the new experience, go to **Azure AD** > **Preview features** and enable the **Enhanced Company Branding** feature. For more information about previews, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
26-
27-
Instructions for the legacy company branding customization process can be found in the [Customize branding](customize-branding.md) article.
25+
> [!NOTE]
26+
> Instructions for the legacy company branding customization process can be found in the **[Customize branding](customize-branding.md)** article.<br><br>The updated experience for adding company branding covered in this article is available as an Azure AD preview feature. To opt in and explore the new experience, go to **Azure AD** > **Preview features** and enable the **Enhanced Company Branding** feature. For more information about previews, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
27+
>
2828
2929
## User experience
3030

3131
You can customize the sign-in pages when users access your organization's tenant-specific apps. For Microsoft and SaaS applications (multi-tenant apps) such as <https://myapps.microsoft.com>, or <https://outlook.com> the customized sign-in page appears only after the user types their **Email**, or **Phone**, and select **Next**.
3232

33-
Some of the Microsoft applications support the home realm discovery `whr` query string parameter, or a domain variable. With the home realm discovery and domain parameter, the customized sign-in page will appear immediately in the first step.
33+
Some of the Microsoft applications support the home realm discovery `whr` query string parameter, or a domain variable. With the home realm discovery and domain parameter, the customized sign-in page appears immediately in the first step.
3434

3535
In the following examples replace the contoso.com with your own tenant name, or verified domain name:
3636

@@ -39,7 +39,7 @@ In the following examples replace the contoso.com with your own tenant name, or
3939
- For my app portal `https://myapps.microsoft.com/?whr=contoso.com`
4040
- Self-service password reset `https://passwordreset.microsoftonline.com/?whr=contoso.com`
4141

42-
## License requirements
42+
## Role and license requirements
4343

4444
Adding custom branding requires one of the following licenses:
4545

@@ -51,16 +51,22 @@ For more information about licensing and editions, see the [Sign up for Azure AD
5151

5252
Azure AD Premium editions are available for customers in China using the worldwide instance of Azure AD. Azure AD Premium editions aren't currently supported in the Azure service operated by 21Vianet in China
5353

54+
The **Global Administrator** role is required to customize company branding.
55+
5456
## Before you begin
5557

5658
**All branding elements are optional. Default settings will remain, if left unchanged.** For example, if you specify a banner logo but no background image, the sign-in page shows your logo with a default background image from the destination site such as Microsoft 365. Additionally, sign-in page branding doesn't carry over to personal Microsoft accounts. If your users or guests authenticate using a personal Microsoft account, the sign-in page won't reflect the branding of your organization.
5759

5860
**Images have different image and file size requirements.** Take note of the image requirements for each option. You may need to use a photo editor to create the right size images. The preferred image type for all images is PNG, but JPG is accepted.
5961

62+
**Use Microsoft Graph with Azure AD company branding.** Company branding can be viewed and managed using Microsoft Graph on the `/beta` endpoint and the `organizationalBranding` resource type. For more information, see the [organizational branding API documentation](/graph/api/resources/organizationalbranding?view=graph-rest-beta&preserve-view=true).
63+
64+
## How to navigate the company branding process
65+
6066
1. Sign in to the [Azure portal](https://portal.azure.com/) using a Global Administrator account for the directory.
6167

6268
2. Go to **Azure Active Directory** > **Company branding** > **Customize**.
63-
- If you currently have a customized sign-in experience, you'll see an **Edit** button.
69+
- If you currently have a customized sign-in experience, the **Edit** button is available.
6470

6571
![Custom branding landing page with 'Company branding' highlighted in the side menu and 'Configure' button highlighted in the center of the page](media/how-to-customize-branding/customize-branding-getting-started.png)
6672

@@ -72,7 +78,7 @@ The sign-in experience process is grouped into sections. At the end of each sect
7278

7379
- **Favicon**: Select a PNG or JPG of your logo that appears in the web browser tab.
7480

75-
- **Background image**: Select a PNG or JPG to display as the main image on your sign-in page. This image will scale and crop according to the window size, but may be partially blocked by the sign-in prompt.
81+
- **Background image**: Select a PNG or JPG to display as the main image on your sign-in page. This image scales and crops according to the window size, but may be partially blocked by the sign-in prompt.
7682

7783
- **Page background color**: If the background image isn't able to load because of a slower connection, your selected background color appears instead.
7884

@@ -133,7 +139,7 @@ If you haven't enabled the footer, go to the **Layout** section and select **Sho
133139
134140
- **Self-service password reset**:
135141
- Show self-service password reset (SSPR): Select the checkbox to turn on SSPR.
136-
- Common URL: Enter the destination URL for where your users will reset their passwords. This URL appears on the username and password collection screens.
142+
- Common URL: Enter the destination URL for where your users reset their passwords. This URL appears on the username and password collection screens.
137143
- Username collection display text: Replace the default text with your own custom username collection text.
138144
- Password collection display text: Replace the default text with your own customer password collection text.
139145

articles/active-directory/fundamentals/toc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ items:
1717
href: active-directory-how-subscriptions-associated-directory.md
1818
- name: Add your privacy info
1919
href: active-directory-properties-area.md
20-
- name: Add company branding
20+
- name: Add company branding (preview)
2121
href: how-to-customize-branding.md
2222
- name: Users, groups, and licenses
2323
expanded: false

0 commit comments

Comments
 (0)