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

Rename realm parameter to realmOrConnection #602

Merged
merged 3 commits into from
Dec 20, 2021
Merged

Rename realm parameter to realmOrConnection #602

merged 3 commits into from
Dec 20, 2021

Conversation

Widcket
Copy link
Contributor

@Widcket Widcket commented Dec 18, 2021

Changes

⚠️ THIS PR CONTAINS BREAKING CHANGES

The Authentication API client has a method for logging in with username/password, login(usernameOrEmail:password:realm:audience:scope:). It has a parameter called realm, that can be used for both realm domains or connection names. The latter is obscured to the consumer of the API unless the documentation is consulted, which can be confusing and misleading.

A similar situation arises in the same method with the first parameter, which can be both a username or an email. So this PR adopts that same approach and renames realm to realmOrConnection.

The Android SDK also calls it realmOrConnection.

References

See https://auth0.com/docs/authorization/flows/call-your-api-using-resource-owner-password-flow#configure-realm-support.

Testing

  • This change adds unit test coverage
  • This change has been tested on the latest version of the platform/language or why not

Checklist

@Widcket Widcket requested a review from a team as a code owner December 18, 2021 01:32
@Widcket Widcket added the review:small Small review label Dec 18, 2021
@Widcket Widcket merged commit 0b00acb into beta Dec 20, 2021
@Widcket Widcket deleted the v2/realm-rename branch December 20, 2021 15:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
review:small Small review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants