registry/ts_interfaces/requests/admin.ts

import * as plugins from '../plugins.ts';
import * as data from '../data/index.ts';

// ============================================================================
// Admin Requests
// ============================================================================

export interface IReq_GetAdminProviders extends
  plugins.typedrequestInterfaces.implementsTR<
    plugins.typedrequestInterfaces.ITypedRequest,
    IReq_GetAdminProviders
  > {
  method: 'getAdminProviders';
  request: {
    identity: data.IIdentity;
  };
  response: {
    providers: data.IAuthProvider[];
  };
}

export interface IReq_CreateAdminProvider extends
  plugins.typedrequestInterfaces.implementsTR<
    plugins.typedrequestInterfaces.ITypedRequest,
    IReq_CreateAdminProvider
  > {
  method: 'createAdminProvider';
  request: {
    identity: data.IIdentity;
    name: string;
    displayName: string;
    type: data.TAuthProviderType;
    oauthConfig?: data.IOAuthConfig;
    ldapConfig?: data.ILdapConfig;
    attributeMapping?: data.IAttributeMapping;
    provisioning?: data.IProvisioningSettings;
  };
  response: {
    provider: data.IAuthProvider;
  };
}

export interface IReq_GetAdminProvider extends
  plugins.typedrequestInterfaces.implementsTR<
    plugins.typedrequestInterfaces.ITypedRequest,
    IReq_GetAdminProvider
  > {
  method: 'getAdminProvider';
  request: {
    identity: data.IIdentity;
    providerId: string;
  };
  response: {
    provider: data.IAuthProvider;
  };
}

export interface IReq_UpdateAdminProvider extends
  plugins.typedrequestInterfaces.implementsTR<
    plugins.typedrequestInterfaces.ITypedRequest,
    IReq_UpdateAdminProvider
  > {
  method: 'updateAdminProvider';
  request: {
    identity: data.IIdentity;
    providerId: string;
    displayName?: string;
    status?: data.TAuthProviderStatus;
    priority?: number;
    oauthConfig?: Partial<data.IOAuthConfig>;
    ldapConfig?: Partial<data.ILdapConfig>;
    attributeMapping?: Partial<data.IAttributeMapping>;
    provisioning?: Partial<data.IProvisioningSettings>;
  };
  response: {
    provider: data.IAuthProvider;
  };
}

export interface IReq_DeleteAdminProvider extends
  plugins.typedrequestInterfaces.implementsTR<
    plugins.typedrequestInterfaces.ITypedRequest,
    IReq_DeleteAdminProvider
  > {
  method: 'deleteAdminProvider';
  request: {
    identity: data.IIdentity;
    providerId: string;
  };
  response: {
    message: string;
  };
}

export interface IReq_TestAdminProvider extends
  plugins.typedrequestInterfaces.implementsTR<
    plugins.typedrequestInterfaces.ITypedRequest,
    IReq_TestAdminProvider
  > {
  method: 'testAdminProvider';
  request: {
    identity: data.IIdentity;
    providerId: string;
  };
  response: {
    result: data.IConnectionTestResult;
  };
}

export interface IReq_GetPlatformSettings extends
  plugins.typedrequestInterfaces.implementsTR<
    plugins.typedrequestInterfaces.ITypedRequest,
    IReq_GetPlatformSettings
  > {
  method: 'getPlatformSettings';
  request: {
    identity: data.IIdentity;
  };
  response: {
    settings: data.IPlatformSettings;
  };
}

export interface IReq_UpdatePlatformSettings extends
  plugins.typedrequestInterfaces.implementsTR<
    plugins.typedrequestInterfaces.ITypedRequest,
    IReq_UpdatePlatformSettings
  > {
  method: 'updatePlatformSettings';
  request: {
    identity: data.IIdentity;
    auth?: Partial<data.IPlatformAuthSettings>;
  };
  response: {
    settings: data.IPlatformSettings;
  };
}