Type Alias EnvFederationEnforcement

type EnvFederationEnforcement = {
    enforceFederationFor(
        group: EnforcementGroup,
    ): Promise<FederationEnforcement>;
    readFederationEnforcement(): Promise<FederationEnforcement>;
    updateFederationEnforcement(
        config: FederationEnforcement,
    ): Promise<FederationEnforcement>;
}

Index

Methods

enforceFederationFor readFederationEnforcement updateFederationEnforcement

Methods

enforceFederationFor

enforceFederationFor(group: EnforcementGroup): Promise<FederationEnforcement>
Enforce federation for a group of admins
Parameters
- group: EnforcementGroup
  Group of admins to enforce federation for
Returns Promise<FederationEnforcement>
a promise that resolves to a FederationEnforcement object.
- Defined in ops/cloud/EnvFederationEnforcementOps.ts:28

readFederationEnforcement

readFederationEnforcement(): Promise<FederationEnforcement>
Read federation enforcement configuration

Returns Promise<FederationEnforcement>
a promise that resolves to a FederationEnforcement object
- Defined in ops/cloud/EnvFederationEnforcementOps.ts:14

updateFederationEnforcement

updateFederationEnforcement(
config: FederationEnforcement,
): Promise<FederationEnforcement>
Update federation enforcement configuration
Parameters
- config: FederationEnforcement
  FederationEnforcement object
Returns Promise<FederationEnforcement>
a promise that resolves to a FederationEnforcement object.
- Defined in ops/cloud/EnvFederationEnforcementOps.ts:20