Security News
Introducing the Socket Python SDK
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
@workos-inc/authkit-react
Advanced tools
npm install @workos-inc/authkit-react
or
yarn add @workos-inc/authkit-react
Add your site's URL to the list of allowed origins in the WorkOS dashboard by clicking on the "Configure sessions" button of the "Authentication" page.
import { useAuth, AuthKitProvider } from "@workos-inc/authkit-react";
function Root() {
return (
<AuthKitProvider clientId="client_123456" apiHostname="auth.example.com">
<App />
</AuthKitProvider>
);
}
function App() {
const { user, getAccessToken, isLoading, signIn, signUp, signOut } = useAuth();
if (isLoading) {
return <Spinner />;
}
const performMutation = async () => {
const accessToken = await getAccessToken();
console.log("api request with accessToken", accessToken);
};
if (user) {
return (
<div>
Hello, {user.email}
<p>
<button
onClick={() => {
performMutation();
}}
>
Make API Request
</button>
</p>
<p>
<button onClick={() => signOut()}>Sign out</button>
</p>
</div>
);
}
return (
<>
<button onClick={() => signIn()}>Sign in</button>{" "}
<button onClick={() => signUp()}>Sign up</button>
</>
);
}
<AuthKitProvider />
Your app should be wrapped in the AuthKitProvider
component. This component
takes the following props:
clientId
(required): Your WORKOS_CLIENT_ID
apiHostname
: Defaults to api.workos.com
. This should be set to your custom Authentication API domain in production.redirectUri
: The url that WorkOS will redirect to upon successful authentication. (Used when constructing sign-in/sign-up URLs).devMode
: Defaults to true
if window.location is "localhost" or "127.0.0.1". Tokens will be stored in localStorage when this prop is true.onRedirectCallback
: Called after exchanging the
authorization_code
. Can be used for things like redirecting to a "return
to" path in the OAuth state.useAuth
The useAuth
hook returns user information and helper functions:
isLoading
: true while user information is being obtained from fetch during initial load.user
: The WorkOS User
object for this session.getAccessToken
: Returns an access token. Will fetch a fresh access token if necessary.signIn
: Redirects the user to the Hosted AuthKit sign-in page. Takes an optional state
argument.signUp
: Redirects the user to the Hosted AuthKit sign-up page. Takes an optional state
argument.signOut
: Ends the session.The following claims may be populated if the user is part of an organization:
organizationId
: The currently-selected organization.role
: The role
of the user for the current organization.permissions
: Permissions corresponding to this role.FAQs
AuthKit React SDK
The npm package @workos-inc/authkit-react receives a total of 429 weekly downloads. As such, @workos-inc/authkit-react popularity was classified as not popular.
We found that @workos-inc/authkit-react demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.
Security News
A new Rust RFC proposes "Trusted Publishing" for Crates.io, introducing short-lived access tokens via OIDC to improve security and reduce risks associated with long-lived API tokens.