Skip to content
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

[SDK-2757] Improve support for custom domain configurations #554

Merged
merged 1 commit into from
Sep 3, 2021

Conversation

evansims
Copy link
Member

@evansims evansims commented Sep 2, 2021

Changes

A community GitHub issue was reported (#538) in which Management SDK calls don't work with custom domains "out of the box." After some testing, I confirmed our current handling of the single-use domain configuration option in both the stable and upcoming release of the PHP are not adequate to cover the needs of custom domain users.

In particular, without providing a means of specifying both the tenant domain and a custom domain, Management SDK calls will be broken unless the customer writes custom code exchange boilerplate because of the reasons outlined here: https://auth0.com/docs/brand-and-customize/custom-domains#step-3-complete-feature-specific-setup

This PR adds a new configuration option, customDomain. When this is configured, the SDK will automatically adapt API calls and Token verifications to ensure the appropriate domains are used at the appropriate times. This fixes out-of-the-box Management SDK calls and provides a clearer API by explicitly separating the definitions of tenant domain and custom domain during configuration.

References

Resolves #538

Testing

  • Test coverage was added for the changes.
  • All tests pass with 100% coverage.
  • Run composer run tests or composer run tests:docker to run these tests locally, or review the CircleCI tests ran on this PR.

Contributor Checklist

@evansims evansims marked this pull request as ready for review September 2, 2021 19:06
@evansims evansims requested a review from a team as a code owner September 2, 2021 19:06
@Nyholm
Copy link
Contributor

Nyholm commented Sep 3, 2021

Lovely!

I tested this and it works for me.
Thank you

@evansims evansims merged commit eb759f8 into main Sep 3, 2021
@evansims evansims mentioned this pull request Sep 3, 2021
2 tasks
@evansims evansims added this to the 8.0.0 milestone Sep 3, 2021
@evansims evansims deleted the v8-custom-domains branch September 6, 2021 23:13
@github-actions
Copy link
Contributor

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 23, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Login domains vs api domain
3 participants