Type Alias AuthenticationSettings

Type declaration

• exportAuthenticationSettings:function

  • 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

• importAuthenticationSettings:function

  • 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>

• readAuthenticationSettings:function

  • 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

• updateAuthenticationSettings:function

  • 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