Skip to content

docs: add backward compatibility note for AuthenticateRequestOptions #215

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.

Sign up for GitHub

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

Open
AbiramDevOps wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add backward compatibility note for AuthenticateRequestOptions #215

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,16 @@ def is_signed_in(request: httpx.Request):

If the request is correctly authenticated, the token's payload is made available in `request_state.payload`. Otherwise the reason for the token verification failure is given by `request_state.reason`.


> [!NOTE]
> **Backward Compatibility:** If you are using an older version of the SDK (v1.x or v2.x), the `AuthenticateRequestOptions` class and the `authenticate_request` method are located in a different module.
>
> You should import them like this:
> ```python
> from clerk_backend_api.jwks_helpers import authenticate_request, AuthenticateRequestOptions
> ```


### Authenticating Machine Tokens

If you need to authenticate a machine token rather than a session token, this can be done using the `accepts_token` param as such:
Expand Down