Type Alias AuthenticationSettings

type AuthenticationSettings = {
    exportAuthenticationSettings(
        globalConfig: boolean,
    ): Promise<AuthenticationSettingsExportInterface>;
    importAuthenticationSettings(
        importData: AuthenticationSettingsExportInterface,
        globalConfig: boolean,
    ): Promise<AuthenticationSettingsSkeleton>;
    readAuthenticationSettings(
        globalConfig: boolean,
    ): Promise<AuthenticationSettingsSkeleton>;
    updateAuthenticationSettings(
        settings: AuthenticationSettingsSkeleton,
        globalConfig: boolean,
    ): Promise<AuthenticationSettingsSkeleton>;
}

Index

Methods

exportAuthenticationSettings importAuthenticationSettings readAuthenticationSettings updateAuthenticationSettings

Methods

exportAuthenticationSettings

exportAuthenticationSettings(
globalConfig: boolean,
): Promise<AuthenticationSettingsExportInterface>
Export authentication settings
Parameters
- globalConfig: boolean
  true if global authentication settings is the target of the operation, false otherwise. Default: false.
Returns Promise<AuthenticationSettingsExportInterface>
a promise that resolves to an AuthenticationSettingsExportInterface object
- Defined in ops/AuthenticationSettingsOps.ts:37

importAuthenticationSettings

importAuthenticationSettings(
importData: AuthenticationSettingsExportInterface,
globalConfig: boolean,
): Promise<AuthenticationSettingsSkeleton>
Import authentication settings
Parameters
- importData: AuthenticationSettingsExportInterface
  import data
- globalConfig: boolean
  true if global authentication settings are the target of the operation, false otherwise. Default: false.
Returns Promise<AuthenticationSettingsSkeleton>
- Defined in ops/AuthenticationSettingsOps.ts:45

readAuthenticationSettings

readAuthenticationSettings(
globalConfig: boolean,
): Promise<AuthenticationSettingsSkeleton>
Read authentication settings
Parameters
- globalConfig: boolean
  true if global authentication settings is the target of the operation, false otherwise. Default: false.
Returns Promise<AuthenticationSettingsSkeleton>
a promise that resolves an authentication settings object
- Defined in ops/AuthenticationSettingsOps.ts:19

updateAuthenticationSettings

updateAuthenticationSettings(
settings: AuthenticationSettingsSkeleton,
globalConfig: boolean,
): Promise<AuthenticationSettingsSkeleton>
Update authentication settings
Parameters
- settings: AuthenticationSettingsSkeleton
  authentication settings data
- globalConfig: boolean
  true if global authentication settings are the target of the operation, false otherwise. Default: false.
Returns Promise<AuthenticationSettingsSkeleton>
a promise that resolves an authentication settings object
- Defined in ops/AuthenticationSettingsOps.ts:28