Skip to content

docs: add Auth0 CLI examples alongside Management API curl commands - #1663

Open
developerkunal wants to merge 4 commits into
mainfrom
docs/add-auth0-cli-management-api-examples
Open

docs: add Auth0 CLI examples alongside Management API curl commands#1663
developerkunal wants to merge 4 commits into
mainfrom
docs/add-auth0-cli-management-api-examples

Conversation

@developerkunal

@developerkunal developerkunal commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Description

Adds an "Auth0 CLI" example next to every Management API (/api/v2/) curl command in the docs, so readers can copy the equivalent auth0 api command instead of only having curl.

Each Management API example is now presented with <Tabs>, showing the Auth0 CLI variant first and the cURL variant second. The auth0 api commands drop the domain and Authorization header (the CLI uses the logged-in tenant), map query parameters to -q, and keep the request body under --data. JSON request bodies are pretty-printed so they match the curl formatting rather than collapsing to a single line.

Each Management API page also gets a single link to the Auth0 CLI setup and authentication guide on its first Auth0 CLI example, so readers who are not logged in know where to start. The link sits inside the Auth0 CLI tab for standalone examples, and just after the code group for multi-language AuthCodeGroup examples.

This covers 134 pages and adds 273 auth0 api commands.

Testing

  • Verified fence parity and <Tabs>/<Tab> balance across all changed files.
  • Confirmed no non-.mdx files were modified.

Checklist

  • I've read and followed CONTRIBUTING.md.
  • I've tested the site build for this change locally.
  • I've made appropriate docs updates for any code or config changes.
  • I've coordinated with the Product Docs and/or Docs Management team about non-trivial changes.

Add an "Auth0 CLI" tab next to every Management API (/api/v2/) curl example, so readers can copy the equivalent `auth0 api` command. Each example is presented as Tabs with the Auth0 CLI variant first and cURL second. JSON request bodies are pretty-printed to match the curl formatting.

Covers 132 pages and 273 auth0 api commands.
@developerkunal
developerkunal requested review from a team as code owners August 4, 2026 11:31
@mintlify

mintlify Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
auth0 🟢 Ready View Preview Aug 4, 2026, 11:36 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify

mintlify Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
auth0-docs-dev 🟢 Ready View Preview Aug 4, 2026, 11:37 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify

mintlify Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
auth0-docs-staging 🟢 Ready View Preview Aug 4, 2026, 11:37 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@github-actions

github-actions Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Summary

Status Count
🔍 Total 1705
✅ Successful 368
⏳ Timeouts 0
🔀 Redirected 39
👻 Excluded 1280
❓ Unknown 0
🚫 Errors 13
⛔ Unsupported 5

Errors per input

Errors in main/docs/customize/custom-domains/multiple-custom-domains/migration-guide.mdx

Errors in main/docs/get-started/applications/configure-private-key-jwt.mdx

Errors in main/docs/manage-users/user-accounts/user-account-linking/link-user-accounts.mdx

Errors in main/docs/secure/data-privacy-and-compliance/gdpr/gdpr-track-consent-with-custom-ui.mdx

Errors in main/docs/secure/multi-factor-authentication/multi-factor-authentication-factors/configure-sms-voice-notifications-mfa.mdx

Errors in main/docs/secure/tokens/refresh-tokens/multi-resource-refresh-token/configure-and-implement-multi-resource-refresh-token.mdx

Redirects per input

Redirects in main/docs/authenticate/identity-providers/calling-an-external-idp-api.mdx

Redirects in main/docs/authenticate/identity-providers/enterprise-identity-providers/okta/express-configuration.mdx

Redirects in main/docs/authenticate/identity-providers/pass-parameters-to-idps.mdx

Redirects in main/docs/authenticate/identity-providers/retrieve-connection-options.mdx

Redirects in main/docs/authenticate/passwordless/authentication-methods/use-sms-gateway-passwordless.mdx

Redirects in main/docs/customize/custom-domains/multiple-custom-domains/migration-guide.mdx

Redirects in main/docs/customize/hooks/hook-secrets/delete-hook-secrets.mdx

Redirects in main/docs/customize/hooks/update-hooks.mdx

Redirects in main/docs/get-started/apis/configure-json-web-encryption.mdx

Redirects in main/docs/get-started/apis/enable-role-based-access-control-for-apis.mdx

Redirects in main/docs/get-started/applications/configure-fapi-compliance.mdx

Redirects in main/docs/get-started/applications/configure-fapi-compliance/configure-auth0-to-pass-openid-fapi-certification-tests.mdx

Redirects in main/docs/get-started/applications/configure-mtls/configure-mtls-for-a-tenant.mdx

Redirects in main/docs/get-started/applications/rotate-client-secret.mdx

Redirects in main/docs/get-started/tenant-settings/signing-keys/rotate-signing-keys.mdx

Redirects in main/docs/get-started/tenant-settings/signing-keys/view-signing-certificates.mdx

Redirects in main/docs/manage-users/access-control/configure-core-rbac/roles/create-roles.mdx

Redirects in main/docs/manage-users/access-control/configure-core-rbac/roles/view-role-permissions.mdx

Redirects in main/docs/manage-users/organizations/organizations-for-m2m-applications/manage-m2m-access.mdx

Redirects in main/docs/manage-users/sessions/configure-session-lifetime-settings.mdx

Redirects in main/docs/manage-users/user-accounts/user-profiles/root-attributes/set-root-attributes-during-user-sign-up.mdx

Redirects in main/docs/manage-users/user-accounts/user-profiles/root-attributes/update-root-attributes-for-users.mdx

Redirects in main/docs/secure/call-apis-on-users-behalf/on-behalf-of-token-exchange.mdx

Redirects in main/docs/secure/multi-factor-authentication/manage-mfa-auth0-apis/manage-authentication-methods-with-management-api.mdx

Redirects in main/docs/secure/multi-factor-authentication/manage-mfa-auth0-apis/manage-authenticator-factors-mfa-api.mdx

Redirects in main/docs/secure/multi-factor-authentication/multi-factor-authentication-factors/configure-sms-voice-notifications-mfa.mdx

Redirects in main/docs/secure/security-guidance/data-security/user-data-storage.mdx

Redirects in main/docs/secure/tokens/access-tokens/management-api-access-tokens/get-management-api-access-tokens-for-production.mdx

Redirects in main/docs/secure/tokens/refresh-tokens/multi-resource-refresh-token/configure-and-implement-multi-resource-refresh-token.mdx

The source curl put backslash-continuations inside the JSON body, which collapsed onto a single line during conversion. Pretty-print the body to match the curl formatting.
nick-gagliardi
nick-gagliardi previously approved these changes Aug 6, 2026
Add a single link to the Auth0 CLI setup and authentication guide on the first Auth0 CLI example of each Management API page, so readers who aren't logged in know where to start. The note sits inside the Auth0 CLI tab for standalone examples, and just after the code group for multi-language AuthCodeGroup examples.
…nagement-api-examples

# Conflicts:
#	main/docs/customize/email/manage-email-flow.mdx
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants