Interface UserDefaultAdapterOptions

interface UserDefaultAdapterOptions {
    allowedAttachmentContentTypes?: string[];
    authEncSecret: string;
    authSignSecret: string;
    authenticate?: AuthenticationFunction;
    collectionNames?: UserDefaultAdapterCollectionNames;
    customFields?: {
        user: CustomField[];
    };
    customStrategies?: UserDefaultAdapterStrategies;
    emailConfig: UserAdapterEmailConfig;
    maxAttachmentSizeMB?: number;
    maxFailedLoginAttempts?: number;
    organizationsCanEditUsers?: boolean;
    paginationConfiguration?: PaginationConfigurations;
}

Properties

allowedAttachmentContentTypes? authEncSecret authSignSecret authenticate? collectionNames? customFields? customStrategies? emailConfig maxAttachmentSizeMB? maxFailedLoginAttempts? organizationsCanEditUsers? paginationConfiguration?

Properties

Optional allowedAttachmentContentTypes

allowedAttachmentContentTypes?: string[]

List of content types that can be uploaded to attachment endpoints

authEncSecret

authEncSecret: string

Secret use to encrypt the JWT Token

authSignSecret

authSignSecret: string

Secret use to sign the JWT Token

Optional authenticate

authenticate?: AuthenticationFunction

Function that will be called to authenticate the user via validators. When not provided, this will default to the default for the given authType.

Typically you would only provide this if designing your own authentication.

Optional collectionNames

collectionNames?: UserDefaultAdapterCollectionNames

Customizable collection name for services

Optional customFields

customFields?: {
    user: CustomField[];
}

Custom field configuration for each data type

Type declaration

  • user: CustomField[]

Optional customStrategies

customStrategies?: UserDefaultAdapterStrategies

Alternate strategies for built in logic (e.g. for password checking)

emailConfig

emailConfig: UserAdapterEmailConfig

Email configuration (templates & whether to send emails)

Optional maxAttachmentSizeMB

maxAttachmentSizeMB?: number

Max file size that can be uploaded to attachment endpoints

Optional maxFailedLoginAttempts

maxFailedLoginAttempts?: number

Max number of failed attempts at login before a user is locked. 0 to disable.

Optional organizationsCanEditUsers

organizationsCanEditUsers?: boolean

Can organizations edit users flag

Optional paginationConfiguration

paginationConfiguration?: PaginationConfigurations

Default pagination configuration for each of the list endpoints

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc