| Setting
|
Type
|
Default
|
Description
|
authentication_providers
|
Array
|
[]
|
A list of definitions of OIDC and/or OAuth providers.
|
authentication_provider.profile
|
String (parseable to JS function)
|
null
|
When provided this function is called to map the external user_info to the internal fiftyone user/account.
|
session_ttl
|
Number
|
300
|
Time in seconds for sessions to live after which users will be forced to log out. Must be greater than 120 seconds to support refreshing of user session using refresh token.
|
js_hook_enabled
|
Boolean
|
true
|
When set to False, configured JavaScript hooks will not be invoked.
|
js_hook
|
String (parseable to a single JS function)
|
null
|
JavaScript hook which is invoked on several CAS events described in JS Hooks section below
|
skipSignInPage
|
Boolean
|
false
|
When set to True, sign in page with identity provider choices will be skipped when there is only one identity provider is configured
|
## JavaScript Hooks
This documentation outlines the JavaScript hook implementation for the Central
Authentication Service (CAS). As a CAS superuser, you are able to define
JavaScript functions that integrate with various authentication flows within
CAS, customizing the authentication processes.
### Overview
JavaScript hooks allow superusers to programmatically influence authentication
flows, including sign-in, sign-up, JWT handling and customization, redirection,
and session management. This document describes the available hooks, their
triggers, expected return types, and contextual information provided to each
hook.
### Example JavaScript Hook
```typescript
// Example JavaScript hook implementation
async function Hook(context) {
const { params, services, trigger } = context;
switch (trigger) {
// user is trying to sign in
case "signIn":
// returning false will prevent user from signing in
return true;
// JWT token is created for user session
case "jwt":
// custom payload returned will be merged with default payload
return {};
// user has logged out
case "logout":
// returning or throwing here does not affect the sign out flow
break;
// user is being redirected on sign in our sign out
case "redirect":
// user will be redirected to this URL on sign in our sign out
return "/settings/accounts";
}
}
```
### Actionable Triggers
| Trigger
|
Description
|
Return Type
|
signIn
|
Invoked when a user signs in. If the hook returns false or error is thrown, sign-in will be prevented.
|
Boolean
|
signUp
|
Invoked when a new user signs in for the very first time. If the hook returns false or an error is thrown, sign-in will be prevented and a user/account will not be created.
|
|
jwt
|
Invoked when JWT is created (on signIn, signUp, refresh token). The returned object will override payload of default JWT payload. If an error is thrown, the session will be expired and user will be redirected to sign-in
|
Object | undefined
|
redirect
|
Invoked post signIn or signOut. The user will be redirected to the URL/Path returned from the hook.
|
String (URL)
|
session
|
Invoked when a request for a session (on signIn, signUp, refresh token) is received.
|
|
**Event-Only Triggers**
|
Parameter
|
Description
|
Available in Triggers
|
token
|
The payload of a JWT token.
|
signIn, signUp, jwt, session, signOut, linkAccount, createUser
|
user
|
The signed-in user object.
|
signIn, signUp, jwt, linkAccount
|
account
|
The account from an identity provider.
|
signIn, signUp, jwt, linkAccount
|
profile
|
The profile from an identity provider.
|
signIn, signUp, jwt, linkAccount
|
isNewUser
|
True if a user is signing in for the first time.
|
jwt
|
trigger
|
Specifies the current trigger event.
|
jwt
|
Session
|
The session object.
|
session
|
services
|
Provides access to various services.
|
all
|
**Services**
| Service
|
Description
|
services.util.http
|
Provides get, post, put, and delete functions for making HTTP requests from a JS Hook.
|
services.userContext
|
Object containing information about the user performing the current action.
|
services.directory
|
|
services.directory.users
|
The UserService - providing methods for interacting with the directory of users.
|
services.directory.groups
|
The GroupsService - providing methods for interacting with the directory of groups.
|
services.config
|
The ConfigService - providing methods for reading and writing the AuthenticationConfig.
|
services.util
|
|
services.directory.orgs
|
The OrgsService - providing methods for interacting with the directory of organizations.
|
services.webhookService
|
Experimental
|
process.env['MY_ENV_VAR']
|
Syntax for reading environment variables in a JS Hook.
|