Type Alias Idp

type Idp = {
    createSocialIdentityProvider(
        providerType: string,
        providerId: string,
        providerData: SocialIdpSkeleton,
    ): Promise<SocialIdpSkeleton>;
    deleteSocialIdentityProvider(
        providerId: string,
    ): Promise<SocialIdpSkeleton>;
    deleteSocialIdentityProviders(): Promise<SocialIdpSkeleton[]>;
    exportSocialIdentityProvider(
        providerId: string,
    ): Promise<SocialProviderExportInterface>;
    exportSocialIdentityProviders(
        options?: SocialIdentityProviderExportOptions,
    ): Promise<SocialProviderExportInterface>;
    importFirstSocialIdentityProvider(
        importData: SocialProviderExportInterface,
        options: SocialIdentityProviderImportOptions,
    ): Promise<SocialIdpSkeleton>;
    importSocialIdentityProvider(
        providerId: string,
        importData: SocialProviderExportInterface,
        options: SocialIdentityProviderImportOptions,
    ): Promise<SocialIdpSkeleton>;
    importSocialIdentityProviders(
        importData: SocialProviderExportInterface,
        options: SocialIdentityProviderImportOptions,
    ): Promise<SocialIdpSkeleton[]>;
    readSocialIdentityProvider(providerId: string): Promise<SocialIdpSkeleton>;
    readSocialIdentityProviders(): Promise<SocialIdpSkeleton[]>;
    updateSocialIdentityProvider(
        providerType: string,
        providerId: string,
        providerData: SocialIdpSkeleton,
    ): Promise<SocialIdpSkeleton>;
}

Index

Methods

createSocialIdentityProvider deleteSocialIdentityProvider deleteSocialIdentityProviders exportSocialIdentityProvider exportSocialIdentityProviders importFirstSocialIdentityProvider importSocialIdentityProvider importSocialIdentityProviders readSocialIdentityProvider readSocialIdentityProviders updateSocialIdentityProvider

Methods

createSocialIdentityProvider

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
- Defined in ops/IdpOps.ts:46

deleteSocialIdentityProvider

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
- Defined in ops/IdpOps.ts:73

deleteSocialIdentityProviders

deleteSocialIdentityProviders(): Promise<SocialIdpSkeleton[]>
Delete all social identity providers

Returns Promise<SocialIdpSkeleton[]>
a promise that resolves to an array of social identity provider objects
- Defined in ops/IdpOps.ts:67

exportSocialIdentityProvider

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
- Defined in ops/IdpOps.ts:79

exportSocialIdentityProviders

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
- Defined in ops/IdpOps.ts:87

importFirstSocialIdentityProvider

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
- Defined in ops/IdpOps.ts:108

importSocialIdentityProvider

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
- Defined in ops/IdpOps.ts:97

importSocialIdentityProviders

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
- Defined in ops/IdpOps.ts:118

readSocialIdentityProvider

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
- Defined in ops/IdpOps.ts:38

readSocialIdentityProviders

readSocialIdentityProviders(): Promise<SocialIdpSkeleton[]>
Read all social identity providers

Returns Promise<SocialIdpSkeleton[]>
a promise that resolves to an array of social identity providers
- Defined in ops/IdpOps.ts:32

updateSocialIdentityProvider

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
- Defined in ops/IdpOps.ts:58

Type Alias Idp

Index

Methods

Methods

createSocialIdentityProvider

Parameters

Returns Promise<SocialIdpSkeleton>

deleteSocialIdentityProvider

Parameters

Returns Promise<SocialIdpSkeleton>

deleteSocialIdentityProviders

Returns Promise<SocialIdpSkeleton[]>

exportSocialIdentityProvider

Parameters

Returns Promise<SocialProviderExportInterface>

exportSocialIdentityProviders

Parameters

Returns Promise<SocialProviderExportInterface>

importFirstSocialIdentityProvider

Parameters

Returns Promise<SocialIdpSkeleton>

importSocialIdentityProvider

Parameters

Returns Promise<SocialIdpSkeleton>

importSocialIdentityProviders

Parameters

Returns Promise<SocialIdpSkeleton[]>

readSocialIdentityProvider

Parameters

Returns Promise<SocialIdpSkeleton>

readSocialIdentityProviders

Returns Promise<SocialIdpSkeleton[]>

updateSocialIdentityProvider

Parameters

Returns Promise<SocialIdpSkeleton>

Settings

On This Page