@@ -91,30 +91,30 @@ function App() {
9191Your app should be wrapped in the ` AuthKitProvider` component. This component
9292takes the following props:
9393
94- * ` clientId` (required): Your ` WORKOS_CLIENT_ID `
95- * ` apiHostname` : Defaults to ` api .workos .com ` . This should be set to your custom Authentication API domain in production.
96- * ` redirectUri` : The url that WorkOS will redirect to upon successful authentication. (Used when constructing sign-in/sign-up URLs).
97- * ` 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.
98- * ` onRedirectCallback` : Called after exchanging the
94+ - ` clientId` (required): Your ` WORKOS_CLIENT_ID `
95+ - ` apiHostname` : Defaults to ` api .workos .com ` . This should be set to your custom Authentication API domain in production.
96+ - ` redirectUri` : The url that WorkOS will redirect to upon successful authentication. (Used when constructing sign-in/sign-up URLs).
97+ - ` 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.
98+ - ` onRedirectCallback` : Called after exchanging the
9999 ` authorization_code` . Can be used for things like redirecting to a "return
100100 to" path in the OAuth state.
101101
102102### ` useAuth`
103103
104104The ` useAuth` hook returns user information and helper functions:
105105
106- * ` isLoading` : true while user information is being obtained from fetch during initial load.
107- * ` user` : The WorkOS ` User` object for this session.
108- * ` getAccessToken` : Returns an access token. Will fetch a fresh access token if necessary.
109- * ` signIn` : Redirects the user to the Hosted AuthKit sign-in page. Takes an optional ` state` argument.
110- * ` signUp` : Redirects the user to the Hosted AuthKit sign-up page. Takes an optional ` state` argument.
111- * ` signOut` : Ends the session.
106+ - ` isLoading` : true while user information is being obtained from fetch during initial load.
107+ - ` user` : The WorkOS ` User` object for this session.
108+ - ` getAccessToken` : Returns an access token. Will fetch a fresh access token if necessary.
109+ - ` signIn` : Redirects the user to the Hosted AuthKit sign-in page. Takes an optional ` state` argument.
110+ - ` signUp` : Redirects the user to the Hosted AuthKit sign-up page. Takes an optional ` state` argument.
111+ - ` signOut` : Ends the session.
112112
113113The following claims may be populated if the user is part of an organization:
114114
115- * ` organizationId` : The currently-selected organization.
116- * ` role` : The ` role` of the user for the current organization.
117- * ` permissions` : Permissions corresponding to this role.
115+ - ` organizationId` : The currently-selected organization.
116+ - ` role` : The ` role` of the user for the current organization.
117+ - ` permissions` : Permissions corresponding to this role.
118118
119119## Impersonation
120120
0 commit comments