Add oauth_tokens to AuthkitAuthenticationResponse
#378
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
jonatascastro12
changed the title
oauth_tokens to AuthenticationResponse
jonatascastro12
force-pushed
the
feature/auth-3820-add-oauth_credentials-to-sdks-2
branch
from
10879ec to
b95dc7b
Compare
Created a new OAuthTokens model to represent OAuth credentials, including provider, access token, refresh token, expiration, and scopes. Integrated this new model into the AuthenticationResponse class, adding an optional field for OAuth tokens.
jonatascastro12
force-pushed
the
feature/auth-3820-add-oauth_credentials-to-sdks-2
branch
from
b95dc7b to
73bdedd
Compare
salbito-workos
approved these changes
Nov 5, 2024
mattgd
reviewed
Nov 6, 2024
| access_token: str | ||
| refresh_token: str | ||
| expires_at: int | ||
| scopes: List[str] |
Contributor
There was a problem hiding this comment.
For fields where we don't necessarily need mutability, we've been using the Sequence type instead of List. Example here.
| impersonator: Optional[Impersonator] = None | ||
| organization_id: Optional[str] = None | ||
| user: User | ||
| oauth_tokens: Optional[OAuthTokens] = None |
Contributor
There was a problem hiding this comment.
Will OAuth credentials exist for all authentication methods or just authenticate with code?
Contributor
Author
There was a problem hiding this comment.
Just for authenticate_with_code - so I guess we should split this type apart?
Contributor
Author
There was a problem hiding this comment.
@mattgd I'm wondering if I change the response, would it be considered a breaking change?
Contributor
Author
There was a problem hiding this comment.
Never mind, I found that I had the new field to the AuthKitAuthenticationResponse
Contributor
There was a problem hiding this comment.
I forgot about that type, nice!
mattgd
approved these changes
Nov 6, 2024
jonatascastro12
changed the title
oauth_tokens to AuthenticationResponseoauth_tokens to AuthkitAuthenticationResponse
jonatascastro12
deleted the
feature/auth-3820-add-oauth_credentials-to-sdks-2
branch
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.
Description
Created a new
OAuthTokensmodel to represent OAuth credentials, including provider, access token, refresh token, expiration, and scopes. Integrated this new model into theAuthenticationResponseclass, adding an optional field for OAuth tokens.Documentation
Does this require changes to the WorkOS Docs? E.g. the API Reference or code snippets need updates.
If yes, link a related docs PR and add a docs maintainer as a reviewer. Their approval is required.