import { type AdminFederationConfigSkeleton } from '../../api/cloud/AdminFederationProvidersApi'; import { SocialIdpSkeleton } from '../../api/SocialIdentityProvidersApi'; import { State } from '../../shared/State'; import { ExportMetaData } from '../OpsTypes'; export type AdminFederation = { /** * Create an empty idp export template * @returns {AdminFederationExportInterface} an empty idp export template */ createAdminFederationExportTemplate(): AdminFederationExportInterface; /** * Read all admin federation providers * @returns {Promise} a promise that resolves to an object containing an array of admin federation providers */ readAdminFederationProviders(): Promise; /** * Read admin federation provider * @param {string} providerId social identity provider id/name * @returns {Promise} a promise that resolves a social admin federation object */ readAdminFederationProvider(providerId: string): Promise; /** * Create admin federation provider * @param {string} providerType social identity provider type * @param {string} providerId social identity provider id/name * @param {SocialIdpSkeleton} providerData social identity provider data * @returns {Promise} a promise that resolves a social admin federation object */ createAdminFederationProvider(providerType: string, providerData: SocialIdpSkeleton, providerId?: string): Promise; /** * Update or create admin federation provider * @param {string} providerType social identity provider type * @param {string} providerId social identity provider id/name * @param {SocialIdpSkeleton} providerData social identity provider data * @returns {Promise} a promise that resolves a social admin federation object */ updateAdminFederationProvider(providerType: string, providerId: string, providerData: SocialIdpSkeleton): Promise; /** * Delete admin federation provider by id * @param {String} providerId admin federation provider id/name * @returns {Promise} a promise that resolves to an admin federation provider object */ deleteAdminFederationProvider(providerId: string): Promise; /** * Export admin federation provider by id * @param {string} providerId provider id/name * @returns {Promise} a promise that resolves to a SocialProviderExportInterface object */ exportAdminFederationProvider(providerId: string): Promise; /** * Export all providers * @returns {Promise} a promise that resolves to a SocialProviderExportInterface object */ exportAdminFederationProviders(): Promise; /** * Import admin federation provider by id/name * @param {string} providerId provider id/name * @param {AdminFederationExportInterface} importData import data */ importAdminFederationProvider(providerId: string, importData: AdminFederationExportInterface): Promise; /** * Import first provider * @param {AdminFederationExportInterface} importData import data */ importFirstAdminFederationProvider(importData: AdminFederationExportInterface): Promise; /** * Import all providers * @param {AdminFederationExportInterface} importData import data */ importAdminFederationProviders(importData: AdminFederationExportInterface): Promise; /** * Get all admin federation providers * @returns {Promise} a promise that resolves to an object containing an array of admin federation providers * @deprecated since v2.0.0 use {@link AdminFederation.readAdminFederationProviders | readAdminFederationProviders} instead * ```javascript * readAdminFederationProviders(): Promise * ``` * @group Deprecated */ getAdminFederationProviders(): Promise; /** * Get admin federation provider * @param {String} providerId social identity provider id/name * @returns {Promise} a promise that resolves a social admin federation object * @deprecated since v2.0.0 use {@link AdminFederation.readAdminFederationProvider | readAdminFederationProvider} instead * ```javascript * readAdminFederationProvider(providerId: string): Promise * ``` * @group Deprecated */ getAdminFederationProvider(providerId: string): Promise; /** * Update or create admin federation provider * @param {string} providerType social identity provider type * @param {string} providerId social identity provider id/name * @param {SocialIdpSkeleton} providerData social identity provider data * @returns {Promise} a promise that resolves a social admin federation object * @deprecated since v2.0.0 use {@link AdminFederation.updateAdminFederationProvider | updateAdminFederationProvider} instead * ```javascript * updateAdminFederationProvider(providerType: string, providerId: string, providerData: SocialIdpSkeleton): Promise * ``` * @group Deprecated */ putProviderByTypeAndId(providerType: string, providerId: string, providerData: SocialIdpSkeleton): Promise; }; declare const _default: (state: State) => AdminFederation; export default _default; export interface AdminFederationExportInterface { meta?: ExportMetaData; config: Record; idp: Record; } /** * Create an empty idp export template * @returns {AdminFederationExportInterface} an empty idp export template */ export declare function createAdminFederationExportTemplate({ state, }: { state: State; }): AdminFederationExportInterface; /** * Get all admin federation providers * @returns {Promise} a promise that resolves to an object containing an array of admin federation providers */ export declare function readAdminFederationProviders({ state, }: { state: State; }): Promise; /** * Get admin federation provider by id * @param {String} providerId social identity provider id/name * @returns {Promise} a promise that resolves a social admin federation object */ export declare function readAdminFederationProvider({ providerId, state, }: { providerId: string; state: State; }): Promise; export declare function createAdminFederationProvider({ providerType, providerId, providerData, state, }: { providerType: string; providerId: string; providerData: SocialIdpSkeleton; state: State; }): Promise; export declare function updateAdminFederationProvider({ providerType, providerId, providerData, state, }: { providerType: string; providerId: string; providerData: SocialIdpSkeleton; state: State; }): Promise; /** * Delete admin federation provider by id * @param {String} providerId admin federation provider id/name * @returns {Promise} a promise that resolves to an admin federation provider object */ export declare function deleteAdminFederationProvider({ providerId, state, }: { providerId: string; state: State; }): Promise; /** * Export admin federation provider by id * @param {string} providerId provider id/name * @returns {Promise} a promise that resolves to a SocialProviderExportInterface object */ export declare function exportAdminFederationProvider({ providerId, state, }: { providerId: string; state: State; }): Promise; /** * Export all providers * @returns {Promise} a promise that resolves to a SocialProviderExportInterface object */ export declare function exportAdminFederationProviders({ state, }: { state: State; }): Promise; /** * Import admin federation provider by id/name * @param {string} providerId provider id/name * @param {AdminFederationExportInterface} importData import data */ export declare function importAdminFederationProvider({ providerId, importData, state, }: { providerId: string; importData: AdminFederationExportInterface; state: State; }): Promise; /** * Import first provider * @param {AdminFederationExportInterface} importData import data */ export declare function importFirstAdminFederationProvider({ importData, state, }: { importData: AdminFederationExportInterface; state: State; }): Promise; /** * Import all providers * @param {AdminFederationExportInterface} importData import data */ export declare function importAdminFederationProviders({ importData, state, }: { importData: AdminFederationExportInterface; state: State; }): Promise; //# sourceMappingURL=AdminFederationOps.d.ts.map