Config Keys
This list is generated from module default configuration files.
| Key | Default | Environment | Description | Source |
|---|---|---|---|---|
auth.authorization | — | — | Authentication system configuration object. In this file, you can change various configuration parameters related to the authentication system. / | auth.ts |
auth.authorization.fields | — | — | Configuration value. | auth.ts |
auth.authorization.fields.permission | "permissions" | AUTH_CHECK_FIELD | Field name used for permission checks. | auth.ts |
auth.authorization.fields.assuranceLevel | "assuranceLevel" | AUTH_AUTHORIZATION_ASSURANCE_LEVEL_FIELD | Configuration value. | auth.ts |
auth.authorization.fields.authenticationMethods | "authenticationMethods" | AUTH_AUTHORIZATION_AUTHENTICATION_METHODS_FIELD | Configuration value. | auth.ts |
auth.authorization.fields.completedFactors | "completedFactors" | AUTH_AUTHORIZATION_COMPLETED_FACTORS_FIELD | Configuration value. | auth.ts |
auth.jwt | — | — | JSON Web Token functions configuration parameters. / | auth.ts |
auth.jwt.secret | "thisisasecret" | JWT_SECRET | The secret used to encode the JWT Token when you are signing it. Without this your JWT Token isn't secure. Also, do not share this value publicly as there will be security issues for your application. / | auth.ts |
auth.jwt.issuer | "dev.quik.land" | JWT_ISSUER | The issuer is used by the sign and verify functions to create/validate a JWT Token. In the sign function, the issuer is added to the token in order to easily check if the received token was created by your application. / | auth.ts |
auth.jwt.audience | "dev.quik.land" | JWT_AUDIENCE | The audience is used by the sign and verify functions to create/validate a JWT Token. In the sign function, the audience is added to the token in order to easily check if the received token was created by your application and was received by the intended audience. / | auth.ts |
auth.jwt.expireTime | "1d" | JWT_EXPIRE_TIME | Defines how long a JWT token can be valid. Each JWT token signed by the application, except for the short-lived ones, are valid for this amount of time. / | auth.ts |
auth.jwt.rememberMeTime | "1y" | JWT_REMEMBER_ME_TIME | When the user of the application wants to be remembered for a longer period of time this configuration parameter is used. In order to use this `rememberMeTime` configuration parameter, you must pass the `rememberMe` parameter to the sign method. / | auth.ts |
auth.jwt.algorithm | "HS256" | JWT_ALGORITHM | The signing algorithm used when creating and verifying JWT tokens. Use `RS256` when signing with an RSA private key. / | auth.ts |