Frodo Library - v5.0.0-47
    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(
            resultCallback?: ResultCallback<SocialIdpSkeleton>,
        ): Promise<AdminFederationExportInterface>;
        importAdminFederationProvider(
            providerId: string,
            importData: AdminFederationExportInterface,
        ): Promise<SocialIdpSkeleton>;
        importAdminFederationProviders(
            importData: AdminFederationExportInterface,
            resultCallback?: ResultCallback<SocialIdpSkeleton>,
        ): 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
    • 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

    • Export all providers

      Parameters

      • OptionalresultCallback: ResultCallback<SocialIdpSkeleton>

        Optional callback to process individual results. When given, the outcome of every provider is passed to it as it happens: a provider that was exported with its configuration as the provider, a provider that cannot be exported as an error that names the provider and carries the cause. Such a provider is left out of the export and does not stop the others, and the function does not throw for it. Without it, the failures are collected and thrown as one error after every provider was tried. Failing to read the providers always throws.

      Returns Promise<AdminFederationExportInterface>

      a promise that resolves to a SocialProviderExportInterface 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