Interface IdentityProviderEndpoints

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.

interface IdentityProviderEndpoints {
edit(attr: IdentityProviderAttributes): Promise<MailcowResponse>;
}

Index

Methods

Methods

edit

edit(attr: IdentityProviderAttributes): Promise<MailcowResponse>
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.
Parameters
- attr: IdentityProviderAttributes
  The identity-provider attributes to apply.
Returns Promise<MailcowResponse>
- Defined in src/endpoints/identity-provider-endpoints.ts:20