-
Notifications
You must be signed in to change notification settings - Fork 647
Branding journey landing page #5752
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
e4365ed
setting up landing
susanharper-okta bd62179
branding journey landing page
susanharper-okta cc8741c
fixing link issues and tweaking
susanharper-okta 95daa6f
acrolinx
susanharper-okta a2beec3
links to other journeys sections
susanharper-okta da4f270
adding links
susanharper-okta 008e72c
small tweak
susanharper-okta 0b5a20c
commenting out link to spreadsheet repo
susanharper-okta 2aa4dcf
adding link and commenting out a doc
susanharper-okta e8d5ea2
editorial review
susanharper-okta File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
9 changes: 9 additions & 0 deletions
9
packages/@okta/vuepress-site/docs/journeys/OCI-branding/index.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| --- | ||
| title: Apply your brand to the Okta user experience | ||
| meta: | ||
| - name: description | ||
| content: Change the look and feel of the Okta default user experience to match your brand. | ||
|
|
||
| sections: | ||
| - main | ||
| --- |
97 changes: 97 additions & 0 deletions
97
packages/@okta/vuepress-site/docs/journeys/OCI-branding/main/index.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| --- | ||
| title: Apply your brand to the Okta user experience | ||
| meta: | ||
| - name: description | ||
| content: Change the look and feel of the Okta default user experience to match your brand. | ||
| date-updated: December 9, 2025 | ||
| target persona: Admin, Designer | ||
| level: Intermediate | ||
| sections: | ||
| - main | ||
| --- | ||
|
|
||
| # Apply your brand to the Okta user experience | ||
|
|
||
| Design and apply a custom look and feel that matches your brand to the Okta-hosted Sign-In Widget. | ||
|
|
||
| ## Introduction | ||
|
|
||
| You have a customer-facing app that uses the Okta-hosted Sign-In Widget and messaging services. Design and apply your own look and feel to these elements, which keeps your customers engaged. When you deliver a seamless, branded experience, you build trust with your users. | ||
|
|
||
| ## Learn | ||
|
|
||
| There are three key elements to the theming of the Okta default user experience: | ||
|
|
||
| * The [Sign-In Widget](/docs/concepts/sign-in-widget/) is the default Okta UI for registration, enrollment, verification, and account recovery. You can customize it to match your brand. | ||
| * The [Okta Expression Language](/docs/reference/okta-expression-language/) is used to customize email and SMS messages. | ||
| * Okta [Brands](https://developer.okta.com/docs/concepts/brands/) allows you to manage multiple brands in one Okta org. | ||
|
|
||
| <!-- See the [repository of example style sheets for the Sign-In Widget](https://github.com/oktadev/okta-js-siw-customzation-example) for examples of the types of updates that you can make.--> | ||
| > **Note**: This document is only for Identity Engine. See [Identify your Okta solution](https://help.okta.com/okta_help.htm?type=oie&id=ext-oie-version) to determine your Okta version. | ||
|
|
||
| ## Plan | ||
|
|
||
| To get the most from the Okta branding options: | ||
|
|
||
| * Purchase a custom domain for your org to associate with the brand. | ||
| * Identify your brand-matching design for the Sign-In Widget. | ||
| * Identify how messages and error pages from Okta are worded to reflect your brand. | ||
| * Decide if you want to use [one domain for all brands or separate domains](/docs/concepts/multibrand-architecture/). | ||
|
|
||
| To make branding changes in the Admin Console, you need a super admin or org admin role, or have [a role with customization permissions](https://help.okta.com/okta_help.htm?type=oie&id=csh-create-role). | ||
|
|
||
| ## Build | ||
|
|
||
| To apply your brand to the Okta-hosted Sign-In Widget, consider an upgrade to the third-generation Sign-In Widget, and then register a vanity domain. | ||
|
|
||
| ### Upgrade the Sign-In Widget | ||
|
|
||
| Consider using the third generation Sign-In Widget for the best customization options: | ||
|
|
||
| * [Understand the differences between the second and third-generation widget](https://help.okta.com/oie/en-us/content/topics/reference/siw-compare-generations.htm?cshid=ext-compare-siw). | ||
| * [Learn how to upgrade to the third-generation widget](/docs/guides/custom-widget-migration-gen3/main/). | ||
|
|
||
| ### Register a vanity domain with your org | ||
|
|
||
| All customizations are tied to the custom domain that you must first attach to your org. See [Add a custom domain to your org](/docs/guides/custom-url-domain/main/). | ||
|
|
||
| ### Apply your brand to the Sign-In Widget | ||
|
|
||
| Create a stylesheet and any required JavaScript for custom behaviors and attach it to your custom domain in the Admin Console: | ||
|
|
||
| <!-- * Use [our samples repo](https://github.com/oktadev/okta-js-siw-customzation-example) to build the correct CSS to match your design. --> | ||
| * Add your style sheets and scripts. You can do this using either the [second](/docs/guides/custom-widget/main/#style-for-redirect-authentication) or [third-generation](/docs/guides/custom-widget-gen3/main/) widget. | ||
| * [Use design tokens](/docs/guides/custom-widget-gen3/main/). You can do this using the third-generation widget. | ||
|
|
||
| ### Apply your brand to Okta default text elements | ||
|
|
||
| Customize the text of emails, SMS messages, and error pages delivered by Okta for a custom domain and also localize it to match your messaging: | ||
|
|
||
| * [Customize your email templates](/docs/guides/custom-email/main/) | ||
| * [Add app-level context logic](/docs/guides/custom-email/main/#app-name) | ||
| * [Customize your SMS messages](/docs/guides/custom-sms-messaging/main/) | ||
| * [Customize your error pages](/docs/guides/custom-error-pages/main/) | ||
|
|
||
| ## Test your customizations | ||
|
|
||
| The Okta default UI spans user registration, enrollment, verification, and account recovery: | ||
|
|
||
| * Test that your new branding is consistent for your users across all four actions. | ||
| * Test that your error pages work as expected. | ||
| * Test that your text works in different languages as expected. | ||
| <!-- * [Copy/Synchronize your settings from UAT to Production (using the Admin Console or Terraform)](/docs/guides/migrate-customizations/). --> | ||
|
|
||
| ## Related topics | ||
|
|
||
| Congratulations, your app now wraps its Okta components in your brand's look and feel. Your design team and your customers are both happy. | ||
|
|
||
| Go deeper into the Okta APIs that allow you to manipulate your customizations in code: | ||
|
|
||
| * Use the [Brands API](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Brands/) to manage brands, and their metadata, in your orgs. | ||
| * Use the [Custom Email Templates API](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/CustomTemplates/) to manage email customizations. | ||
| * Use the [SMS Templates API](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Template/) to manage SMS customizations. | ||
|
|
||
| This journey is part of the Secure your portal pathway, which also contains: | ||
|
|
||
| * [Secure your first web app](/docs/journeys/OCI-secure-your-first-web-app/main/) | ||
| * [Sign users in through your web app](/docs/journeys/OCI-web-sign-in/main/) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This paragraph sounds sarcastic and I love it.