Frodo Library - v5.0.0-5
    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>;
        importAdminFederationProvider(
            providerId: string,
            importData: AdminFederationExportInterface,
        ): Promise<SocialIdpSkeleton>;
        importAdminFederationProviders(
            importData: AdminFederationExportInterface,
        ): Promise<SocialIdpSkeleton[]>;
        importFirstAdminFederationProvider(
            importData: AdminFederationExportInterface,
        ): Promise<SocialIdpSkeleton>;
        readAdminFederationProvider(providerId: string): Promise<SocialIdpSkeleton>;
        readAdminFederationProviders(): Promise<SocialIdpSkeleton[]>;
        updateAdminFederationProvider(
            providerType: string,
            providerId: string,
            providerData: SocialIdpSkeleton,
        ): Promise<SocialIdpSkeleton>;
    }
    Index
    createAdminFederationExportTemplate createAdminFederationProvider deleteAdminFederationProvider exportAdminFederationProvider exportAdminFederationProviders importAdminFederationProvider importAdminFederationProviders importFirstAdminFederationProvider readAdminFederationProvider readAdminFederationProviders updateAdminFederationProvider

    • Create admin federation provider

      Parameters

      • providerType: string

        social identity provider type

      • providerData: SocialIdpSkeleton

        social identity provider data

      • OptionalproviderId: string

        social identity provider id/name

      Returns Promise<SocialIdpSkeleton>

      a promise that resolves a social admin federation object

    • 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

    Settings
    Member Visibility

    On This Page
    Methods