DXCDT-297: Update documentation #555
Merged
Conversation
This file contains 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
Widcket
approved these changes
Dec 13, 2022
willvedd
commented
Dec 13, 2022
Comment on lines
+136
to
+143
| To log in, run: | ||
|
|
||
| ```bash | ||
| auth0 login | ||
| ``` | ||
|
|
||
| To log in to an Auth0 private cloud please ensure you have a native application type created | ||
| with the Device Code grant type enabled and set the following env variables: | ||
|
|
||
| - `AUTH0_AUDIENCE` - The audience of the Auth0 Management API (System API) to use. | ||
| - `AUTH0_CLIENT_ID` - Client ID of a native application configured with the **Device Code** grant type. | ||
| - `AUTH0_DEVICE_CODE_ENDPOINT` - Device Authorization URL, you can find this under **Advanced Settings -> Endpoints**. | ||
| - `AUTH0_OAUTH_TOKEN_ENDPOINT` - OAuth Token URL, you can find this under **Advanced Settings -> Endpoints**. | ||
|
|
||
| ```bash | ||
| AUTH0_AUDIENCE="https://my-org.example.com/api/v2/" \ | ||
| AUTH0_DEVICE_CODE_ENDPOINT="https://my-org.example.com/oauth/device/code" \ | ||
| AUTH0_OAUTH_TOKEN_ENDPOINT="https://my-org.example.com/oauth/token" \ | ||
| AUTH0_CLIENT_ID="xxxxxxxxxxxxxxxx" \ | ||
| auth0 login | ||
| ``` | ||
| > **Warning** | ||
| > Authenticating as a user via `auth0 login` is not supported for **private cloud** tenants. Instead, those users should authenticate with client credentials via `auth0 tenants add`. |
There was a problem hiding this comment.
This is the only content change being made in this PR.
sergiught
approved these changes
Dec 13, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
🔧 Changes
Updating documentation to more accurately advise private cloud users on how to authenticate. Removing the previous login instructions because we're still working through some issues on authenticating as a user via device code flow.
📚 References
Related PR: #554
📝 Checklist