• Configurations Breakdown
  • Publishing Config File
  • Secret
    • Environment Variables
  • Event Queue
    • Environment Variable
  • OTP Settings
    • Environment Variables
  • Authentication Settings
  • Repositories
  • User Data Settings
  • Static Data
    • Scopes
    • Clients

#Configurations Breakdown

View Source (config/ssofy-server.php)

#Publishing Config File

php artisan vendor:publish --tag=ssofy:config

#Secret

The secret is required for verifying the signature of incoming requests as well as generating signed responses.

Obtain the secret from the panel's Application Profile page.

#Environment Variables

SSOFY_API_SECRET=

#Event Queue

Specify which queue the SDK should use to send the events.

#Environment Variable

SSOFY_EVENT_QUEUE=default

#OTP Settings

Set the cache driver for OTP Code storage. As well as branding settings and channels for sending OTP codes by Email and SMS.

#Environment Variables

SSOFY_OTP_CACHE_DRIVER=file
SSOFY_OTP_EMAIL_CHANNEL=email
SSOFY_OTP_SMS_CHANNEL=vonage

#Authentication Settings

Specify the authentication methods you want to make available from your server.

If your login page doesn't allow password entry and relies solely on OTP verification, you must enable the passwordless authentication option. Without a password, the authentication endpoint then responds with user information.

#Repositories

Point to any custom repository implementations here.

Learn how to create your own Repositories.

#User Data Settings

SDK will default to Laravel's standard User model and column names in the users table.

If your model or column names differ, you can configure them here to map to your customized column names.

The filter configuration is another important setting in this section. Read the UserFilter page for details.

#Static Data

The default Repository implementation reads the scopes and clients configuration from this section of the configuration file. However, for more complicated scenarios, such as reading from a database, you may consider overriding the ClientRepository and ScopeRepository with your own custom repository implementations.

#Scopes

Configure an array of scopes in the scopes property, where the array key represents the id of scope.

#Clients

Configure an array of clients in the clients property, where the array key represents the id of client.