Rename realm
parameter to realmOrConnection
#602
Merged
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
The Authentication API client has a method for logging in with username/password,
login(usernameOrEmail:password:realm:audience:scope:)
. It has a parameter calledrealm
, 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
torealmOrConnection
.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
Checklist