ts-mailcow-api/dist/endpoints/identity-provider-endpoints.d.ts

TypeScript wrapper for the mailcow API.

import MailcowClient from '../index';
import { IdentityProviderAttributes, MailcowResponse } from '../types';
/**
 * Interface for the external Identity Provider endpoint.
 *
 * Mailcow has a single global identity-provider configuration -- there
 * is no add or delete, only edit -- so this group exposes a single
 * method.
 */
export interface IdentityProviderEndpoints {
    /**
     * Configure (or reconfigure) the external Identity Provider used for
     * Mailcow login. Pass the attributes for one of the supported
     * `authsource` values; the wrapper supplies the required
     * `items: ['identity-provider']` envelope.
     *
     * @param attr - The identity-provider attributes to apply.
     */
    edit(attr: IdentityProviderAttributes): Promise<MailcowResponse>;
}
/**
 * Binder function between the MailcowClient class and the
 * IdentityProviderEndpoints.
 * @param bind - The MailcowClient to bind.
 * @internal
 */
export declare function identityProviderEndpoints(bind: MailcowClient): IdentityProviderEndpoints;