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

    Type Alias AdminFederation

    type AdminFederation = {
        createAdminFederationExportTemplate(): AdminFederationExportInterface;
        createAdminFederationProvider(
            providerType: string,
            providerData: SocialIdpSkeleton,
            providerId?: string,
        ): Promise<SocialIdpSkeleton>;
        deleteAdminFederationProvider(
            providerId: string,
        ): Promise<SocialIdpSkeleton>;
        exportAdminFederationProvider(
            providerId: string,
        ): Promise<AdminFederationExportInterface>;
        exportAdminFederationProviders(): Promise<AdminFederationExportInterface>;
        getAdminFederationProvider(providerId: string): Promise<SocialIdpSkeleton>;
        getAdminFederationProviders(): Promise<SocialIdpSkeleton[]>;
        importAdminFederationProvider(
            providerId: string,
            importData: AdminFederationExportInterface,
        ): Promise<SocialIdpSkeleton>;
        importAdminFederationProviders(
            importData: AdminFederationExportInterface,
        ): Promise<SocialIdpSkeleton[]>;
        importFirstAdminFederationProvider(
            importData: AdminFederationExportInterface,
        ): Promise<SocialIdpSkeleton>;
        putProviderByTypeAndId(
            providerType: string,
            providerId: string,
            providerData: SocialIdpSkeleton,
        ): Promise<SocialIdpSkeleton>;
        readAdminFederationProvider(providerId: string): Promise<SocialIdpSkeleton>;
        readAdminFederationProviders(): Promise<SocialIdpSkeleton[]>;
        updateAdminFederationProvider(
            providerType: string,
            providerId: string,
            providerData: SocialIdpSkeleton,
        ): Promise<SocialIdpSkeleton>;
    }
    Index

    Methods

    Deprecated

    • Update or create admin federation provider

      Parameters

      • providerType: string

        social identity provider type

      • providerId: string

        social identity provider id/name

      • providerData: SocialIdpSkeleton

        social identity provider data

      Returns Promise<SocialIdpSkeleton>

      a promise that resolves a social admin federation object

      since v2.0.0 use updateAdminFederationProvider instead

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