-
Notifications
You must be signed in to change notification settings - Fork 10.4k
[ZT] Update API call environment variables #19785
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
Closed
Closed
Changes from 11 commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
40cfece
Replace account_id
maxvp b4f0b26
Replace service_token_id
maxvp e8071b0
Replace {tunnel_id}
maxvp 2ed5ff2
Replace {identity_provider_id}
maxvp 94ac2a1
Replace {app_id}
maxvp ff838dd
Replace {policy_id}
maxvp 0be4107
Replace {route_id}
maxvp 2667199
Add stragglers
maxvp 494bb2e
Replace key authorization with tokens
maxvp bb6b25a
Replace learning path env vars
maxvp c14a7f6
Replace learning path authorization keys
maxvp 551b23e
Update src/content/docs/cloudflare-one/applications/configure-apps/da…
maxvp 5a1cd10
Fix partial formatting
maxvp 06f874b
Replace single quotes
maxvp 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,10 +3,9 @@ pcx_content_type: how-to | |
| title: Cloudflare dashboard SSO application | ||
| sidebar: | ||
| order: 4 | ||
|
|
||
| --- | ||
|
|
||
| import { FeatureTable } from "~/components" | ||
| import { FeatureTable } from "~/components"; | ||
|
|
||
| By adding a Dashboard SSO application to your Cloudflare Zero Trust account, you can enforce single sign-on (SSO) to the Cloudflare dashboard with the identity provider (IdP) of your choice. SSO will be enforced for every user in your email domain. | ||
|
|
||
|
|
@@ -16,7 +15,7 @@ By adding a Dashboard SSO application to your Cloudflare Zero Trust account, you | |
|
|
||
| ## Prerequisites | ||
|
|
||
| All users in your email domain must exist as a member in your Cloudflare account and IdP. To add users to your Cloudflare account, refer to [Manage Cloudflare account access](/fundamentals/setup/manage-members/). | ||
| All users in your email domain must exist as a member in your Cloudflare account and IdP. To add users to your Cloudflare account, refer to [Manage Cloudflare account access](/fundamentals/setup/manage-members/). | ||
|
|
||
| ## 1. Set up an IdP | ||
|
|
||
|
|
@@ -32,9 +31,9 @@ Once your SSO domain is approved, a new **SSO App** application will appear unde | |
|
|
||
| ### SSO domain requirements | ||
|
|
||
| * The email domain must belong to your organization. Public email providers such as `@gmail.com` are not allowed. | ||
| * Every user with that email domain must be an employee in your organization. For example, university domains such as `@harvard.edu` are not allowed because they include student emails. | ||
| * Your SSO domain can include multiple email domains. | ||
| - The email domain must belong to your organization. Public email providers such as `@gmail.com` are not allowed. | ||
| - Every user with that email domain must be an employee in your organization. For example, university domains such as `@harvard.edu` are not allowed because they include student emails. | ||
| - Your SSO domain can include multiple email domains. | ||
|
|
||
| ## 3. Enable dashboard SSO | ||
|
|
||
|
|
@@ -58,8 +57,8 @@ We recommend noting down your [Global API key](/fundamentals/api/get-started/key | |
|
|
||
| Cloudflare dashboard SSO does not support: | ||
|
|
||
| * Users with plus-addressed emails, such as `[email protected]`. If you have users like this added to your Cloudflare organization, they will be unable to login with SSO. | ||
| * IdP initiated logins (such as a tile in Okta). All login attempts must originate from `https://dash.cloudflare.com`. You can create a bookmark for this URL in your IdP to assist users. | ||
| - Users with plus-addressed emails, such as `[email protected]`. If you have users like this added to your Cloudflare organization, they will be unable to login with SSO. | ||
| - IdP initiated logins (such as a tile in Okta). All login attempts must originate from `https://dash.cloudflare.com`. You can create a bookmark for this URL in your IdP to assist users. | ||
|
|
||
| ## Bypass dashboard SSO | ||
|
|
||
|
|
@@ -72,9 +71,8 @@ If there is an issue with your SSO IdP provider, you can add an alternate IdP us | |
| 1. [Add](/api/resources/zero_trust/subresources/identity_providers/methods/create/) one-time PIN login: | ||
|
|
||
| ```bash title="cURL command" | ||
| curl 'https://api.cloudflare.com/client/v4/accounts/{account_id}/access/identity_providers' \ | ||
| --header "X-Auth-Email: <EMAIL>" \ | ||
| --header "X-Auth-Key: <API_KEY>" \ | ||
| curl 'https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/access/identity_providers' \ | ||
| --header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \ | ||
| --header "Content-Type: application/json" \ | ||
| --data '{ | ||
| "type": "onetimepin", | ||
|
|
@@ -85,9 +83,8 @@ curl 'https://api.cloudflare.com/client/v4/accounts/{account_id}/access/identity | |
| 2. [Get](/api/resources/zero_trust/subresources/access/subresources/applications/methods/list/) the `id` of the `dash_sso` Access application. You can use [`jq`](https://jqlang.github.io/jq/download/) to quickly find the correct application: | ||
|
|
||
| ```bash title="cURL command" | ||
| curl 'https://api.cloudflare.com/client/v4/accounts/{account_id}/access/apps' \ | ||
| --header "X-Auth-Email: <EMAIL>" \ | ||
| --header "X-Auth-Key: <API_KEY>" \ | ||
| curl 'https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/access/apps' \ | ||
| --header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \ | ||
| | jq '.result[] | select(.type == "dash_sso")' | ||
| ``` | ||
|
|
||
|
|
@@ -105,9 +102,8 @@ curl 'https://api.cloudflare.com/client/v4/accounts/{account_id}/access/apps' \ | |
|
|
||
| ```bash title="cURL command" | ||
| curl --request PUT \ | ||
| 'https://api.cloudflare.com/client/v4/accounts/{account_id}/access/apps/3537a672-e4d8-4d89-aab9-26cb622918a1' \ | ||
| --header "X-Auth-Email: <EMAIL>" \ | ||
| --header "X-Auth-Key: <API_KEY>" \ | ||
| 'https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/access/apps/3537a672-e4d8-4d89-aab9-26cb622918a1' \ | ||
| --header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \ | ||
| --header "Content-Type: application/json" \ | ||
| --data '{ | ||
| "id": "3537a672-e4d8-4d89-aab9-26cb622918a1", | ||
|
|
@@ -126,9 +122,8 @@ The following API calls will disable SSO enforcement for an account. This action | |
| 1. Get your SSO `connector_id`: | ||
|
|
||
| ```bash title="cURL command" | ||
| curl https://api.cloudflare.com/client/v4/accounts/{account_id}/sso/v2/connectors \ | ||
| --header "X-Auth-Email: <EMAIL>" \ | ||
| --header "X-Auth-Key: <API_KEY>" | ||
| curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/sso/v2/connectors \ | ||
| --header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" | ||
| ``` | ||
|
|
||
| ```json title="Response" | ||
|
|
@@ -152,9 +147,8 @@ curl https://api.cloudflare.com/client/v4/accounts/{account_id}/sso/v2/connector | |
|
|
||
| ```bash title="cURL command" | ||
| curl --request PATCH \ | ||
| 'https://api.cloudflare.com/client/v4/accounts/{account_id}/sso/v2/connectors/2828' \ | ||
| --header "X-Auth-Email: <EMAIL>" \ | ||
| --header "X-Auth-Key: <API_KEY>" \ | ||
| 'https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/sso/v2/connectors/2828' \ | ||
| --header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \ | ||
| --header "Content-Type: application/json" \ | ||
| --data '{ | ||
| "sso_connector_status": "DIS" | ||
|
|
@@ -163,12 +157,12 @@ curl --request PATCH \ | |
|
|
||
| ```json title="Response" | ||
| { | ||
| "result": { | ||
| "id": "2828" | ||
| }, | ||
| "success": true, | ||
| "errors": [], | ||
| "messages": [] | ||
| "result": { | ||
| "id": "2828" | ||
| }, | ||
| "success": true, | ||
| "errors": [], | ||
| "messages": [] | ||
| } | ||
| ``` | ||
|
|
||
|
|
||
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
Oops, something went wrong.
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.