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

Methods

createAdminFederationExportTemplate createAdminFederationProvider deleteAdminFederationProvider exportAdminFederationProvider exportAdminFederationProviders importAdminFederationProvider importAdminFederationProviders importFirstAdminFederationProvider readAdminFederationProvider readAdminFederationProviders updateAdminFederationProvider

Methods

createAdminFederationExportTemplate

createAdminFederationExportTemplate(): AdminFederationExportInterface
Create an empty idp export template

Returns AdminFederationExportInterface
an empty idp export template
- Defined in ops/cloud/AdminFederationOps.ts:20

createAdminFederationProvider

createAdminFederationProvider(
    providerType: string,
    providerData: SocialIdpSkeleton,
    providerId?: string,
): Promise<SocialIdpSkeleton>
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
- Defined in ops/cloud/AdminFederationOps.ts:39

deleteAdminFederationProvider

deleteAdminFederationProvider(providerId: string): Promise<SocialIdpSkeleton>
Delete admin federation provider by id
Parameters
- providerId: string
  admin federation provider id/name
Returns Promise<SocialIdpSkeleton>
a promise that resolves to an admin federation provider object
- Defined in ops/cloud/AdminFederationOps.ts:61

exportAdminFederationProvider

exportAdminFederationProvider(
providerId: string,
): Promise<AdminFederationExportInterface>
Export admin federation provider by id
Parameters
- providerId: string
  provider id/name
Returns Promise<AdminFederationExportInterface>
a promise that resolves to a SocialProviderExportInterface object
- Defined in ops/cloud/AdminFederationOps.ts:67

exportAdminFederationProviders

exportAdminFederationProviders(): Promise<AdminFederationExportInterface>
Export all providers

Returns Promise<AdminFederationExportInterface>
a promise that resolves to a SocialProviderExportInterface object
- Defined in ops/cloud/AdminFederationOps.ts:74

importAdminFederationProvider

importAdminFederationProvider(
providerId: string,
importData: AdminFederationExportInterface,
): Promise<SocialIdpSkeleton>
Import admin federation provider by id/name
Parameters
- providerId: string
  provider id/name
- importData: AdminFederationExportInterface
  import data
Returns Promise<SocialIdpSkeleton>
- Defined in ops/cloud/AdminFederationOps.ts:80

importAdminFederationProviders

importAdminFederationProviders(
importData: AdminFederationExportInterface,
): Promise<SocialIdpSkeleton[]>
Import all providers
Parameters
- importData: AdminFederationExportInterface
  import data
Returns Promise<SocialIdpSkeleton[]>
- Defined in ops/cloud/AdminFederationOps.ts:95

importFirstAdminFederationProvider

importFirstAdminFederationProvider(
importData: AdminFederationExportInterface,
): Promise<SocialIdpSkeleton>
Import first provider
Parameters
- importData: AdminFederationExportInterface
  import data
Returns Promise<SocialIdpSkeleton>
- Defined in ops/cloud/AdminFederationOps.ts:88

readAdminFederationProvider

readAdminFederationProvider(providerId: string): Promise<SocialIdpSkeleton>
Read admin federation provider
Parameters
- providerId: string
  social identity provider id/name
Returns Promise<SocialIdpSkeleton>
a promise that resolves a social admin federation object
- Defined in ops/cloud/AdminFederationOps.ts:31

readAdminFederationProviders

readAdminFederationProviders(): Promise<SocialIdpSkeleton[]>
Read all admin federation providers

Returns Promise<SocialIdpSkeleton[]>
a promise that resolves to an object containing an array of admin federation providers
- Defined in ops/cloud/AdminFederationOps.ts:25

updateAdminFederationProvider

updateAdminFederationProvider(
    providerType: string,
    providerId: string,
    providerData: SocialIdpSkeleton,
): Promise<SocialIdpSkeleton>
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
- Defined in ops/cloud/AdminFederationOps.ts:51

Type Alias AdminFederation

Index

Methods

Methods

createAdminFederationExportTemplate

Returns AdminFederationExportInterface

createAdminFederationProvider

Parameters

Returns Promise<SocialIdpSkeleton>

deleteAdminFederationProvider

Parameters

Returns Promise<SocialIdpSkeleton>

exportAdminFederationProvider

Parameters

Returns Promise<AdminFederationExportInterface>

exportAdminFederationProviders

Returns Promise<AdminFederationExportInterface>

importAdminFederationProvider

Parameters

Returns Promise<SocialIdpSkeleton>

importAdminFederationProviders

Parameters

Returns Promise<SocialIdpSkeleton[]>

importFirstAdminFederationProvider

Parameters

Returns Promise<SocialIdpSkeleton>

readAdminFederationProvider

Parameters

Returns Promise<SocialIdpSkeleton>

readAdminFederationProviders

Returns Promise<SocialIdpSkeleton[]>

updateAdminFederationProvider

Parameters

Returns Promise<SocialIdpSkeleton>

Settings

On This Page