Refactors to JWTAuth #178
Merged
Refactors to JWTAuth #178
Conversation
This file contains hidden or 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
|
Verified that @jmoldow has signed the CLA. Thanks for the pull request! |
Rename `JWTAuth.authenticate_app_user()` to `JWTAuth.authenticate_user()`, to reflect the fact that the new Box service accounts can authenticate as managed users as well as app users. `JWTAuth.authenticate_app_user()` is retained as an alias, for backwards-compatability. Allow a user ID to be passed to `JWTAuth`, instead of a `User` object. Previously, developers would need to import and manually construct a `boxsdk.object.user.User`, since `Client.user()` cannot be used until the `Client` has been constructed (which is usually done after all authentication is complete). Allow a user or user ID to be passed to the `JWTAuth` constructor. This way, `JWTAuth.authenticate_user()` can be called without any arguments. More importantly, this means that `JWTAuth.refresh()` can be called immediately after construction, with no need for a manual call to `JWTAuth.authenticate_user()`. When `auto_session_renewal=True`, if there is no access token, then `BoxSession.request()` will renew the token _before_ making the request. This saves an API call. And combined with the above, authentication for `JWTAuth` objects can be done completely automatically, at the time of first API call. Document that the `enterprise_id` argument to `JWTAuth` is allowed to be `None` (and must be `None` if `user` is passed). Also allow it to be passed to `authenticate_instance()`, so that it doesn't need to be provided at construction time. Clean up the README. Fixes #174.
The initial commit that added the `user` parameter to `JWTAuth` only allowed it to be passed when `enterprise_id=None` was passed. After playing around with this a little bit, I determined that this is unnecessarily inflexible for developers. So this constraint is now relaxed. They can both be passed, with `user` taking precedence. Fixup for Pull Request #178.
Contributor
|
👍 |
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.
Rename
JWTAuth.authenticate_app_user()toJWTAuth.authenticate_user(), to reflect the fact that the newBox service accounts can authenticate as managed users as well
as app users.
JWTAuth.authenticate_app_user()is retained asan alias, for backwards-compatability.
Allow a user ID to be passed to
JWTAuth, instead of aUserobject. Previously, developers would need to import and manually
construct a
boxsdk.object.user.User, sinceClient.user()cannot be used until the
Clienthas been constructed (which isusually done after all authentication is complete).
Allow a user or user ID to be passed to the
JWTAuthconstructor. This way,
JWTAuth.authenticate_user()can becalled without any arguments. More importantly, this means that
JWTAuth.refresh()can be called immediately afterconstruction, with no need for a manual call to
JWTAuth.authenticate_user().When
auto_session_renewal=True, if there is no access token,then
BoxSession.request()will renew the token before makingthe request. This saves an API call. And combined with the
above, authentication for
JWTAuthobjects can be donecompletely automatically, at the time of first API call.
Document that the
enterprise_idargument toJWTAuthisallowed to be
None(and must beNoneifuseris passed).Also allow it to be passed to
authenticate_instance(), so thatit doesn't need to be provided at construction time.
Clean up the README.
Fixes #174.