Type Alias Idp

Type declaration

• createSocialIdentityProvider:function

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

    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

• deleteSocialIdentityProvider:function

  • deleteSocialIdentityProvider(providerId: string): Promise<SocialIdpSkeleton>

    Delete social identity provider

    Parameters

    • providerId: string

      social identity provider id/name

    Returns Promise<SocialIdpSkeleton>

    a promise that resolves a social identity provider object

• deleteSocialIdentityProviders:function

  • deleteSocialIdentityProviders(): Promise<SocialIdpSkeleton[]>

    Delete all social identity providers

    Returns Promise<SocialIdpSkeleton[]>

    a promise that resolves to an array of social identity provider objects

• deleteSocialProvider:function

  • deleteSocialProvider(providerId: string): Promise<SocialIdpSkeleton>

    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

    Deprecated

    since v2.0.0 use deleteSocialIdentityProvider instead

    deleteSocialIdentityProvider(providerId: string): Promise<SocialIdpSkeleton>
    Copy

• exportSocialIdentityProvider:function

  • exportSocialIdentityProvider(
        providerId: string,
    ): Promise<SocialProviderExportInterface>

    Export social identity provider

    Parameters

    • providerId: string

      provider id/name

    Returns Promise<SocialProviderExportInterface>

    a promise that resolves to a SocialProviderExportInterface object

• exportSocialIdentityProviders:function

  • exportSocialIdentityProviders(
        options?: SocialIdentityProviderExportOptions,
    ): Promise<SocialProviderExportInterface>

    Export all social identity providers

    Parameters

    • Optionaloptions: SocialIdentityProviderExportOptions

      export options

    Returns Promise<SocialProviderExportInterface>

    a promise that resolves to a SocialProviderExportInterface object

• exportSocialProvider:function

  • exportSocialProvider(providerId: string): Promise<SocialProviderExportInterface>

    Export social identity provider

    Parameters

    • providerId: string

      provider id/name

    Returns Promise<SocialProviderExportInterface>

    a promise that resolves to a SocialProviderExportInterface object

    Deprecated

    since v2.0.0 use exportSocialIdentityProvider instead

    exportSocialIdentityProvider(providerId: string): Promise<SocialProviderExportInterface>
    Copy

• exportSocialProviders:function

  • exportSocialProviders(): Promise<SocialProviderExportInterface>

    Export all social identity providers

    Returns Promise<SocialProviderExportInterface>

    a promise that resolves to a SocialProviderExportInterface object

    Deprecated

    since v2.0.0 use exportSocialIdentityProviders instead

    exportSocialIdentityProviders(): Promise<SocialProviderExportInterface[]>
    Copy

• getSocialIdentityProviders:function

  • getSocialIdentityProviders(): Promise<SocialIdpSkeleton[]>

    Get all social identity providers

    Returns Promise<SocialIdpSkeleton[]>

    a promise that resolves to an array of social identity providers

    Deprecated

    since v2.0.0 use readSocialIdentityProviders instead

    readSocialIdentityProviders(): Promise<SocialIdpSkeleton[]>
    Copy

• getSocialProvider:function

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

    Deprecated

    since v2.0.0 use readSocialIdentityProvider instead

    readSocialIdentityProvider(providerId: string): Promise<SocialIdpSkeleton>
    Copy

• importFirstSocialIdentityProvider:function

  • importFirstSocialIdentityProvider(
        importData: SocialProviderExportInterface,
        options: SocialIdentityProviderImportOptions,
    ): Promise<SocialIdpSkeleton>

    Import first social identity provider

    Parameters

    • importData: SocialProviderExportInterface

      import data
    • options: SocialIdentityProviderImportOptions

      import options

    Returns Promise<SocialIdpSkeleton>

    a promise resolving to a social identity provider object

• importFirstSocialProvider:function

  • importFirstSocialProvider(
        importData: SocialProviderExportInterface,
    ): Promise<boolean>

    Import first social identity provider

    Parameters

    • importData: SocialProviderExportInterface

      import data

    Returns Promise<boolean>

    Deprecated

    since v2.0.0 use importFirstSocialIdentityProvider instead

    importFirstSocialIdentityProvider(importData: SocialProviderExportInterface): Promise<SocialIdpSkeleton>
    Copy

• importSocialIdentityProvider:function

  • importSocialIdentityProvider(
        providerId: string,
        importData: SocialProviderExportInterface,
        options: SocialIdentityProviderImportOptions,
    ): Promise<SocialIdpSkeleton>

    Import social identity provider

    Parameters

    • providerId: string

      provider id/name
    • importData: SocialProviderExportInterface

      import data
    • options: SocialIdentityProviderImportOptions

      import options

    Returns Promise<SocialIdpSkeleton>

    a promise resolving to a social identity provider object

• importSocialIdentityProviders:function

  • importSocialIdentityProviders(
        importData: SocialProviderExportInterface,
        options: SocialIdentityProviderImportOptions,
    ): Promise<SocialIdpSkeleton[]>

    Import all social identity providers

    Parameters

    • importData: SocialProviderExportInterface

      import data
    • options: SocialIdentityProviderImportOptions

      import options

    Returns Promise<SocialIdpSkeleton[]>

    a promise resolving to an array of social identity provider objects

• importSocialProvider:function

  • importSocialProvider(
        providerId: string,
        importData: SocialProviderExportInterface,
    ): Promise<boolean>

    Import social identity provider

    Parameters

    • providerId: string

      provider id/name
    • importData: SocialProviderExportInterface

      import data

    Returns Promise<boolean>

    Deprecated

    since v2.0.0 use importSocialIdentityProvider instead

    importSocialIdentityProvider(providerId: string, importData: SocialProviderExportInterface): Promise<SocialIdpSkeleton>
    Copy

• importSocialProviders:function

  • importSocialProviders(
        importData: SocialProviderExportInterface,
    ): Promise<boolean>

    Import all social identity providers

    Parameters

    • importData: SocialProviderExportInterface

      import data

    Returns Promise<boolean>

    Deprecated

    since v2.0.0 use Idp.importFirstSocialIdentityProviders | importFirstSocialIdentityProviders instead

    importFirstSocialIdentityProviders(importData: SocialProviderExportInterface): Promise<SocialIdpSkeleton[]>
    Copy

• putProviderByTypeAndId:function

  • putProviderByTypeAndId(
        providerType: string,
        providerId: string,
        providerData: SocialIdpSkeleton,
    ): 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

    Deprecated

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

• readSocialIdentityProvider:function

  • readSocialIdentityProvider(providerId: string): Promise<SocialIdpSkeleton>

    Read social identity provider

    Parameters

    • providerId: string

      identity provider id/name

    Returns Promise<SocialIdpSkeleton>

    a promise that resolves a social identity provider object

• readSocialIdentityProviders:function

  • readSocialIdentityProviders(): Promise<SocialIdpSkeleton[]>

    Read all social identity providers

    Returns Promise<SocialIdpSkeleton[]>

    a promise that resolves to an array of social identity providers

• updateSocialIdentityProvider:function

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

    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