-
Notifications
You must be signed in to change notification settings - Fork 811
Added documentation for the new Management API Security settings #6779
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 7 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
be4f18a
Added documentation for the new Management API Security settings
ozgey99 b8989ec
Trying to eliminate the vale errors
ozgey99 c1eada3
Added link to the new page in summary
ozgey99 5e52113
Added new section in the README.md file for the new page
ozgey99 a92c76f
Change MFA with IP filtering
ozgey99 d9fbceb
Used less words
ozgey99 a2ed3c6
Even less words
ozgey99 51227fe
Update umbraco-cloud/set-up/project-settings/management-api-security.md
ozgey99 3bf1f09
Update umbraco-cloud/set-up/project-settings/management-api-security.md
ozgey99 7115b3a
Update umbraco-cloud/set-up/project-settings/management-api-security.md
ozgey99 fe4e731
Update umbraco-cloud/set-up/project-settings/management-api-security.md
ozgey99 3c359b5
Updated the menu references after moving the new UI under the Securit…
ozgey99 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
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
31 changes: 31 additions & 0 deletions
31
umbraco-cloud/set-up/project-settings/management-api-security.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,31 @@ | ||
| --- | ||
| description: In this article, we show how you can enable IP filtering for the back-end services of your Umbraco Cloud project, so only whitelisted IP addresses have access to these services. | ||
| --- | ||
|
|
||
| # Management API Security | ||
|
|
||
| {% hint style="info" %} | ||
| This is a beta feature. Enabling this feature might have other side effects for your Umbraco Cloud project. | ||
| {% endhint %} | ||
|
|
||
| **Management API Security** lets you secure access to the back-end services of your Umbraco Cloud project. | ||
ozgey99 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| When enabled, the following domains will be protected by an IP filter: | ||
| - Git Domains: Used for version control and deployment processes, identified by the _*.git_ suffix. | ||
| - Scm Domains: Used for additional back-end service operations, such as builds and deployment management. They follow the _your-project-alias.regional-identifier.scm.umbraco.io_ pattern. | ||
|
|
||
| If the IP address is not whitelisted, these domains will not be accessible. | ||
|
|
||
| ## How to enable Management API IP filter and allow IPs | ||
|
|
||
| 1. Go to **Hostnames** in the **Configuration** tab | ||
| 2. Enable **IP Filtering** for Management API on the project | ||
ozgey99 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
|  | ||
|
|
||
| 3. Once enabled, **Add IPs** for users that need access to the Management API of your project | ||
ozgey99 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
|  | ||
|
|
||
| After **IP Filtering** has been enabled, users with IPs not added to the allowlist will be denied access to the Management API. | ||
|
|
||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.