Frodo Library - v4.0.0-10
    Preparing search index...

    Type Alias Idp

    type Idp = {
        createSocialIdentityProvider(
            providerType: string,
            providerId: string,
            providerData: SocialIdpSkeleton,
        ): Promise<SocialIdpSkeleton>;
        deleteSocialIdentityProvider(
            providerId: string,
        ): Promise<SocialIdpSkeleton>;
        deleteSocialIdentityProviders(): Promise<SocialIdpSkeleton[]>;
        deleteSocialProvider(providerId: string): Promise<SocialIdpSkeleton>;
        exportSocialIdentityProvider(
            providerId: string,
        ): Promise<SocialProviderExportInterface>;
        exportSocialIdentityProviders(
            options?: SocialIdentityProviderExportOptions,
        ): Promise<SocialProviderExportInterface>;
        exportSocialProvider(
            providerId: string,
        ): Promise<SocialProviderExportInterface>;
        exportSocialProviders(): Promise<SocialProviderExportInterface>;
        getSocialIdentityProviders(): Promise<SocialIdpSkeleton[]>;
        getSocialProvider(providerId: string): Promise<SocialIdpSkeleton>;
        importFirstSocialIdentityProvider(
            importData: SocialProviderExportInterface,
            options: SocialIdentityProviderImportOptions,
        ): Promise<SocialIdpSkeleton>;
        importFirstSocialProvider(
            importData: SocialProviderExportInterface,
        ): Promise<boolean>;
        importSocialIdentityProvider(
            providerId: string,
            importData: SocialProviderExportInterface,
            options: SocialIdentityProviderImportOptions,
        ): Promise<SocialIdpSkeleton>;
        importSocialIdentityProviders(
            importData: SocialProviderExportInterface,
            options: SocialIdentityProviderImportOptions,
        ): Promise<SocialIdpSkeleton[]>;
        importSocialProvider(
            providerId: string,
            importData: SocialProviderExportInterface,
        ): Promise<boolean>;
        importSocialProviders(
            importData: SocialProviderExportInterface,
        ): Promise<boolean>;
        putProviderByTypeAndId(
            providerType: string,
            providerId: string,
            providerData: SocialIdpSkeleton,
        ): Promise<SocialIdpSkeleton>;
        readSocialIdentityProvider(providerId: string): Promise<SocialIdpSkeleton>;
        readSocialIdentityProviders(): Promise<SocialIdpSkeleton[]>;
        updateSocialIdentityProvider(
            providerType: string,
            providerId: string,
            providerData: SocialIdpSkeleton,
        ): Promise<SocialIdpSkeleton>;
    }
    Index

    Methods

    • Create social identity provider

      Parameters

      • providerType: string

        identity provider type

      • providerId: string

        identity provider id/name

      • providerData: SocialIdpSkeleton

        identity provider data

      Returns Promise<SocialIdpSkeleton>

      a promise that resolves a social identity provider object

    • Delete social identity provider

      Parameters

      • providerId: string

        social identity provider id/name

      Returns Promise<SocialIdpSkeleton>

      a promise that resolves a social identity provider object

    • Read social identity provider

      Parameters

      • providerId: string

        identity provider id/name

      Returns Promise<SocialIdpSkeleton>

      a promise that resolves a social identity provider object

    • Update or create social identity provider

      Parameters

      • providerType: string

        identity provider type

      • providerId: string

        identity provider id/name

      • providerData: SocialIdpSkeleton

        identity provider data

      Returns Promise<SocialIdpSkeleton>

      a promise that resolves a social identity provider object

    Deprecated

    • Delete social identity provider

      Parameters

      • providerId: string

        social identity provider id/name

      Returns Promise<SocialIdpSkeleton>

      a promise that resolves to a social identity provider object

      since v2.0.0 use deleteSocialIdentityProvider instead

      deleteSocialIdentityProvider(providerId: string): Promise<SocialIdpSkeleton>
      
    • Get social identity provider by id

      Parameters

      • providerId: string

        identity provider id/name

      Returns Promise<SocialIdpSkeleton>

      a promise that resolves a social identity provider object

      since v2.0.0 use readSocialIdentityProvider instead

      readSocialIdentityProvider(providerId: string): Promise<SocialIdpSkeleton>
      
    • Import all social identity providers

      Parameters

      Returns Promise<boolean>

      since v2.0.0 use Idp.importFirstSocialIdentityProviders | importFirstSocialIdentityProviders instead

      importFirstSocialIdentityProviders(importData: SocialProviderExportInterface): Promise<SocialIdpSkeleton[]>
      
    • Update or create identity provider

      Parameters

      • providerType: string

        identity provider type

      • providerId: string

        identity provider id/name

      • providerData: SocialIdpSkeleton

        identity provider data

      Returns Promise<SocialIdpSkeleton>

      a promise that resolves a social identity provider object

      since v2.0.0 use updateSocialIdentityProvider or createSocialIdentityProvider instead

      updateSocialIdentityProvider(providerType: string, providerId: string, providerData: SocialIdpSkeleton): Promise<SocialIdpSkeleton>
      createSocialIdentityProvider(providerType: string, providerId: string, providerData: SocialIdpSkeleton): Promise<SocialIdpSkeleton>