oidc-react • Docs
oidc-react / AuthProviderProps
optional
authority:string
The URL of the OIDC/OAuth2 provider.
src/auth-context-interface.ts:41
optional
automaticSilentRenew:boolean
Flag to indicate if there should be an automatic attempt to renew the access token prior to its expiration.
Defaults to true.
src/auth-context-interface.ts:109
optional
autoSignIn:boolean
Flag to control automatic redirection to the OIDC/OAuth2 provider when not signed in.
Defaults to true.
src/auth-context-interface.ts:89
optional
autoSignInArgs:SigninRedirectArgs
Optional sign in arguments to be used when autoSignIn
is enabled.
src/auth-context-interface.ts:93
optional
autoSignOut:boolean
Flag to control automatic sign out redirection to the OIDC/OAuth2 provider when silent renewal fails.
Defaults to true.
src/auth-context-interface.ts:99
optional
autoSignOutArgs:SignoutRedirectArgs
Optional sign out arguments to be used when autoSignOut
is enabled.
src/auth-context-interface.ts:103
optional
clientId:string
Your client application's identifier as registered with the OIDC/OAuth2 provider.
src/auth-context-interface.ts:53
optional
clientSecret:string
Client secret defined on the identity server.
src/auth-context-interface.ts:57
optional
extraQueryParams:Record
<string
,string
>
Extra query params passed to the authorization url.
src/auth-context-interface.ts:49
optional
loadUserInfo:boolean
Flag to control if additional identity data is loaded from the user info endpoint in order to populate the user's profile.
Defaults to true.
src/auth-context-interface.ts:115
optional
location:Location
Defaults to windows.location
.
src/auth-context-interface.ts:83
optional
metadata:Partial
<OidcMetadata
>
Manually set metadata if CORS is not configured on the OIDC/OAuth2 provider.
src/auth-context-interface.ts:45
optional
onBeforeSignIn: () =>unknown
On before sign in hook. Can be use to store the current url for use after signing in.
This only gets called if autoSignIn is true
unknown
src/auth-context-interface.ts:136
optional
onSignIn: (userData
) =>void
|Promise
<void
>
On sign in hook. Can be a async function.
• userData: null
| User
User
void
| Promise
<void
>
src/auth-context-interface.ts:141
optional
onSignInError: (error
) =>void
On sign in error. Can be a async function.
• error: Error
void
src/auth-context-interface.ts:150
optional
onSignOut: (options
?) =>void
|Promise
<void
>
On sign out hook. Can be a async function.
• options?: AuthProviderSignOutProps
void
| Promise
<void
>
src/auth-context-interface.ts:145
optional
popupRedirectUri:string
The URL for the page containing the call to signinPopupCallback to handle the callback from the OIDC/OAuth2
src/auth-context-interface.ts:126
optional
popupWindowFeatures:PopupWindowFeatures
The features parameter to window.open for the popup signin window
defaults to 'location=no,toolbar=no,width=500,height=500,left=100,top=100'
src/auth-context-interface.ts:121
optional
popupWindowTarget:string
The target parameter to window.open for the popup signin window. * defaults to '_blank'
src/auth-context-interface.ts:131
optional
postLogoutRedirectUri:string
The post-logout redirect URI of your client application which your OIDC/OAuth2 provider can redirect to after completing logout.
src/auth-context-interface.ts:69
optional
redirectUri:string
The redirect URI of your client application to receive a response from the OIDC/OAuth2 provider.
src/auth-context-interface.ts:61
optional
responseType:string
Tells the authorization server which grant to execute.
Read more: https://tools.ietf.org/html/rfc6749#section-3.1.1
src/auth-context-interface.ts:75
optional
scope:string
A space-delimited list of permissions that the application requires.
src/auth-context-interface.ts:79
optional
silentRedirectUri:string
The redirect URI of your client application to receive a response from the OIDC/OAuth2 provider when completing a background sign-in refresh.
src/auth-context-interface.ts:65
optional
userManager:UserManager
See UserManager for more details.