/** * Agilicus API * Agilicus is API-first. Modern software is controlled by other software, is open, is available for you to use the way you want, securely, simply. The OpenAPI Specification in YAML format is available on [www](https://www.agilicus.com/www/api/agilicus-openapi.yaml) for importing to other tools. A rendered, online viewable and usable version of this specification is available at [api](https://www.agilicus.com/api). You may try the API inline directly in the web page. To do so, first obtain an Authentication Token (the simplest way is to install the Python SDK, and then run `agilicus-cli --issuer https://MYISSUER get-token`). You will need an org-id for most calls (and can obtain from `agilicus-cli --issuer https://MYISSUER list-orgs`). The `MYISSUER` will typically be `auth.MYDOMAIN`, and you will see it as you sign-in to the administrative UI. This API releases on Bearer-Token authentication. To obtain a valid bearer token you will need to Authenticate to an Issuer with OpenID Connect (a superset of OAUTH2). Your \"issuer\" will look like https://auth.MYDOMAIN. For example, when you signed-up, if you said \"use my own domain name\" and assigned a CNAME of cloud.example.com, then your issuer would be https://auth.cloud.example.com. If you selected \"use an Agilicus supplied domain name\", your issuer would look like https://auth.myorg.agilicus.cloud. For test purposes you can use our [Python SDK](https://pypi.org/project/agilicus/) and run `agilicus-cli --issuer https://auth.MYDOMAIN get-token`. This API may be used in any language runtime that supports OpenAPI 3.0, or, you may use our [Python SDK](https://pypi.org/project/agilicus/), our [Typescript SDK](https://www.npmjs.com/package/@agilicus/angular), or our [Golang SDK](https://git.agilicus.com/pub/sdk-go). 100% of the activities in our system our API-driven, from our web-admin, through our progressive web applications, to all internals: there is nothing that is not accessible. For more information, see [developer resources](https://www.agilicus.com/developer). * * The version of the OpenAPI document: 2025.12.16 * Contact: dev@agilicus.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { HttpHeaders } from '@angular/common/http'; import { Observable } from 'rxjs'; import { AdminStatus } from '../model/models'; import { AgentConnector } from '../model/models'; import { AgentConnectorDynamicStats } from '../model/models'; import { AgentConnectorInfo } from '../model/models'; import { AgentConnectorInstance } from '../model/models'; import { AgentConnectorProxy } from '../model/models'; import { AgentConnectorQueue } from '../model/models'; import { AgentConnectorQueueResponse } from '../model/models'; import { AgentConnectorStats } from '../model/models'; import { AgentLocalAuthInfo } from '../model/models'; import { AppliedConnectorStatsConfig } from '../model/models'; import { CSRReasonEnum } from '../model/models'; import { CertSigningReq } from '../model/models'; import { ConfigureConnectorStatsPublishingRequest } from '../model/models'; import { Connector } from '../model/models'; import { ConnectorSecureTransfer } from '../model/models'; import { ConnectorService } from '../model/models'; import { EncryptedData } from '../model/models'; import { IpsecConnector } from '../model/models'; import { ListAgentConnectorInstanceResponse } from '../model/models'; import { ListAgentConnectorProxyResponse } from '../model/models'; import { ListAgentConnectorResponse } from '../model/models'; import { ListCertSigningReqResponse } from '../model/models'; import { ListConnectorResponse } from '../model/models'; import { ListConnectorSecureTransferResponse } from '../model/models'; import { ListConnectorServiceResponse } from '../model/models'; import { ListConnectorStatsResponse } from '../model/models'; import { ListGuidMetadataResponse } from '../model/models'; import { ListIpsecConnectorResponse } from '../model/models'; import { UsageMetrics } from '../model/models'; import { Configuration } from '../configuration'; export interface CreateAgentConnectorRequestParams { AgentConnector: AgentConnector; } export interface CreateAgentCsrRequestParams { connector_id: string; CertSigningReq: CertSigningReq; private_key_id?: string; target_issuer?: Array; } export interface CreateAgentStatsRequestParams { connector_id: string; AgentConnectorStats: AgentConnectorStats; } export interface CreateConfigurePublishingRequestRequestParams { ConfigureConnectorStatsPublishingRequest: ConfigureConnectorStatsPublishingRequest; } export interface CreateConnectorProxyRequestParams { AgentConnectorProxy: AgentConnectorProxy; } export interface CreateCsrRequestParams { CertSigningReq: CertSigningReq; } export interface CreateInstanceRequestParams { connector_id: string; AgentConnectorInstance: AgentConnectorInstance; } export interface CreateIpsecConnectorRequestParams { IpsecConnector: IpsecConnector; } export interface CreateQueueRequestParams { connector_id: string; AgentConnectorQueue: AgentConnectorQueue; limit?: number; page_at_id?: string; } export interface CreateServiceRequestParams { connector_id: string; ConnectorService: ConnectorService; } export interface CreateTransferRequestParams { connector_id: string; ConnectorSecureTransfer: ConnectorSecureTransfer; } export interface DeleteAgentConnectorRequestParams { connector_id: string; org_id?: string; } export interface DeleteConnectorRequestParams { connector_id: string; org_id?: string; } export interface DeleteConnectorQueueRequestParams { connector_id: string; queue_id: string; org_id?: string; } export interface DeleteInstanceRequestParams { connector_id: string; connector_instance_id: string; org_id?: string; } export interface DeleteIpsecConnectorRequestParams { connector_id: string; org_id?: string; } export interface DeleteProxyRequestParams { connector_proxy_id: string; org_id?: string; } export interface DeleteServiceRequestParams { connector_id: string; connector_service: string; org_id?: string; } export interface DeleteTransferRequestParams { connector_id: string; transfer_id: string; org_id?: string; } export interface GetAgentConnectorRequestParams { connector_id: string; org_id?: string; } export interface GetAgentConnectorDynamicStatsRequestParams { connector_id: string; org_id?: string; collected_by?: Date; collected_since?: Date; } export interface GetAgentCsrRequestParams { connector_id: string; csr_id: string; org_id?: string; limit_csr_certificates?: number; } export interface GetAgentInfoRequestParams { connector_id: string; org_id?: string; allow_list?: boolean; service_forwarders?: boolean; authz_public_key?: boolean; active_transfers?: boolean; instance_id?: string; } export interface GetAgentStatsRequestParams { connector_id: string; org_id?: string; } export interface GetConnectorRequestParams { connector_id: string; org_id?: string; } export interface GetConnectorQueueRequestParams { connector_id: string; queue_id: string; org_id?: string; } export interface GetConnectorQueuesRequestParams { connector_id: string; limit?: number; page_at_id?: string; org_id?: string; } export interface GetConnectorUsageMetricsRequestParams { org_id?: string; org_ids?: Array; } export interface GetEncryptedDataRequestParams { connector_id: string; transfer_id: string; org_id?: string; } export interface GetInstanceRequestParams { connector_id: string; connector_instance_id: string; org_id?: string; } export interface GetIpsecConnectorRequestParams { connector_id: string; org_id?: string; } export interface GetIpsecConnectorInfoRequestParams { connector_id: string; org_id?: string; } export interface GetProxyRequestParams { connector_proxy_id: string; org_id?: string; } export interface GetQueuesRequestParams { org_id?: string; limit?: number; page_at_id?: string; } export interface GetServiceRequestParams { connector_id: string; connector_service: string; org_id?: string; } export interface GetStatsConfigRequestParams { connector_id: string; org_id?: string; } export interface GetTransferRequestParams { connector_id: string; transfer_id: string; org_id?: string; } export interface ListAgentConnectorRequestParams { limit?: number; org_id?: string; name?: string; show_stats?: boolean; page_at_id?: string; admin_status?: AdminStatus; show_deleted?: boolean; page_at_name?: string; allow_partial_match?: boolean; page_on?: Array; page_at_key?: Array; page_sort?: Array<'asc' | 'desc'>; search_direction?: 'backwards' | 'forwards'; } export interface ListAgentCsrRequestParams { connector_id: string; private_key_id?: string; target_issuer?: Array; limit?: number; org_id?: string; reason?: CSRReasonEnum; not_valid_after?: string; limit_csr_certificates?: number; auto_renew?: boolean; } export interface ListConnectorRequestParams { limit?: number; org_id?: string; name?: string; type?: 'agent' | 'ipsec'; show_stats?: boolean; admin_status?: AdminStatus; show_deleted?: boolean; page_at_id?: string; page_at_name?: string; allow_partial_match?: boolean; page_on?: Array; page_at_key?: Array; page_sort?: Array<'asc' | 'desc'>; search_direction?: 'backwards' | 'forwards'; } export interface ListConnectorGuidMappingRequestParams { org_id?: string; connector_id?: string; limit?: number; previous_guid?: string; updated_since?: Date; } export interface ListConnectorStatsRequestParams { org_id?: string; connector_id_list?: Array; collected_since?: Date; show_dynamic?: boolean; show_static?: boolean; } export interface ListInstancesRequestParams { connector_id: string; org_id?: string; limit?: number; } export interface ListIpsecConnectorRequestParams { limit?: number; org_id?: string; name?: string; render_inheritance?: boolean; } export interface ListProxiesRequestParams { limit?: number; org_id?: string; page_at_id?: string; inner_connector_id?: string; outer_connector_id?: string; } export interface ListServicesRequestParams { connector_id: string; org_id?: string; limit?: number; } export interface ListTransfersRequestParams { connector_id: string; org_id?: string; limit?: number; } export interface ReplaceAgentConnectorRequestParams { connector_id: string; org_id?: string; AgentConnector?: AgentConnector; } export interface ReplaceAgentConnectorLocalAuthInfoRequestParams { connector_id: string; AgentLocalAuthInfo?: AgentLocalAuthInfo; } export interface ReplaceAgentCsrRequestParams { connector_id: string; csr_id: string; org_id?: string; CertSigningReq?: CertSigningReq; } export interface ReplaceEncryptedDataRequestParams { connector_id: string; transfer_id: string; EncryptedData?: EncryptedData; } export interface ReplaceInstanceRequestParams { connector_id: string; connector_instance_id: string; org_id?: string; AgentConnectorInstance?: AgentConnectorInstance; } export interface ReplaceIpsecConnectorRequestParams { connector_id: string; org_id?: string; IpsecConnector?: IpsecConnector; } export interface ReplaceProxyRequestParams { connector_proxy_id: string; AgentConnectorProxy?: AgentConnectorProxy; } export interface ReplaceTransferRequestParams { connector_id: string; transfer_id: string; org_id?: string; ConnectorSecureTransfer?: ConnectorSecureTransfer; } export interface ConnectorsServiceInterface { defaultHeaders: HttpHeaders; configuration: Configuration; /** * Create an agent connector * Create an agent connector * @param requestParameters */ createAgentConnector(requestParameters: CreateAgentConnectorRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Creates a CertSigningReq * Creates a CertSigningReq * @param requestParameters */ createAgentCsr(requestParameters: CreateAgentCsrRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Creates an AgentConnectorStats record. * Publishes the most recent stats collected by the AgentConnector. Currently only the most recent AgentCollectorStats is retained, but in the future some history may be recorded. * @param requestParameters */ createAgentStats(requestParameters: CreateAgentStatsRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Configure stats publishing for a group of connectors * Applies the provided publishing configuration to a group of connectors. * @param requestParameters */ createConfigurePublishingRequest(requestParameters: CreateConfigurePublishingRequestRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Creates a connector proxy * Creates a connector proxy * @param requestParameters */ createConnectorProxy(requestParameters: CreateConnectorProxyRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Creates a CertSigningReq * Creates a CertSigningReq * @param requestParameters */ createCsr(requestParameters: CreateCsrRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Creates an AgentConnectorInstance * Create an AgentConnectorInstance of an AgentConnector * @param requestParameters */ createInstance(requestParameters: CreateInstanceRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Create an IPsec connector * Create an IPsec connector * @param requestParameters */ createIpsecConnector(requestParameters: CreateIpsecConnectorRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Creates an AgentConnectorQueue for receiving updates. * Agent Connectors are notified on changes to its configuration via a AMQ Stomp queue. The agent connector may create queues for various purposes, such as receiving notifications about configuration updates. * @param requestParameters */ createQueue(requestParameters: CreateQueueRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Creates an ConnectorServices * Create an ConnectorService of an Connector * @param requestParameters */ createService(requestParameters: CreateServiceRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Creates an ConnectorSecureTransfer * Create an ConnectorSecureTransfer of an Connector * @param requestParameters */ createTransfer(requestParameters: CreateTransferRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Delete a agent * Delete a agent * @param requestParameters */ deleteAgentConnector(requestParameters: DeleteAgentConnectorRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable<{}>; /** * Delete a connector * Delete a connector * @param requestParameters */ deleteConnector(requestParameters: DeleteConnectorRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable<{}>; /** * Delete a connector queue * Delete a connector queue * @param requestParameters */ deleteConnectorQueue(requestParameters: DeleteConnectorQueueRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable<{}>; /** * * Delete an agent connector instance * @param requestParameters */ deleteInstance(requestParameters: DeleteInstanceRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable<{}>; /** * Delete an IPsec connector * Delete an IPsec connector * @param requestParameters */ deleteIpsecConnector(requestParameters: DeleteIpsecConnectorRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable<{}>; /** * * Delete an AgentConnectorProxy * @param requestParameters */ deleteProxy(requestParameters: DeleteProxyRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable<{}>; /** * Delete a connector service * Delete a connector service * @param requestParameters */ deleteService(requestParameters: DeleteServiceRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable<{}>; /** * * Delete an ConnectorSecureTransfer * @param requestParameters */ deleteTransfer(requestParameters: DeleteTransferRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable<{}>; /** * Get an agent * Get an agent * @param requestParameters */ getAgentConnector(requestParameters: GetAgentConnectorRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get the AgentConnector dynamic stats for many instances * Gets the most recent dynamic stats published by the AgentConnector * @param requestParameters */ getAgentConnectorDynamicStats(requestParameters: GetAgentConnectorDynamicStatsRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Update a CertSigningReq * Update a CertSigningReq * @param requestParameters */ getAgentCsr(requestParameters: GetAgentCsrRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get information associated with connector * Get information associated with connector * @param requestParameters */ getAgentInfo(requestParameters: GetAgentInfoRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get the AgentConnector stats * Gets the most recent stats published by the AgentConnector * @param requestParameters */ getAgentStats(requestParameters: GetAgentStatsRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get a connector * Get a connector * @param requestParameters */ getConnector(requestParameters: GetConnectorRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get a connector queue * Get a connector queue * @param requestParameters */ getConnectorQueue(requestParameters: GetConnectorQueueRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get all AgentConnectorQueues for a connector_id * Get all AgentConnectorQueues for a connector_id * @param requestParameters */ getConnectorQueues(requestParameters: GetConnectorQueuesRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get all connector metrics * Retrieves all connector metrics for a specified the org_id. * @param requestParameters */ getConnectorUsageMetrics(requestParameters: GetConnectorUsageMetricsRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * * Retrieve the EncryptedData data for a given connector_id and transfer_id. * @param requestParameters */ getEncryptedData(requestParameters: GetEncryptedDataRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * * Retrieve the AgentConnectorInstance for a given connector_id and connector_instance_id. * @param requestParameters */ getInstance(requestParameters: GetInstanceRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get an IPsec connector * Get an IPsec connector * @param requestParameters */ getIpsecConnector(requestParameters: GetIpsecConnectorRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get IPsec connector runtime information * Get IPsec connector runtime information. * @param requestParameters */ getIpsecConnectorInfo(requestParameters: GetIpsecConnectorInfoRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * * Retrieve a AgentConnectorProxy * @param requestParameters */ getProxy(requestParameters: GetProxyRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get all AgentConnectorQueues * Get all AgentConnectorQueues * @param requestParameters */ getQueues(requestParameters: GetQueuesRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get ConnectorService * Get ConnectorService * @param requestParameters */ getService(requestParameters: GetServiceRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get the Connector stats configuration * Gets the current stats configuration for the Connector * @param requestParameters */ getStatsConfig(requestParameters: GetStatsConfigRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * * Retrieve the ConnectorSecureTransfer for a given connector_id and transfer_id. * @param requestParameters */ getTransfer(requestParameters: GetTransferRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * list agent connectors * list agent connectors. By default, an AgentConnector will not show stats when listed to speed up the query. Setting the show_stats parameter to true retrieve the stats for every AgentConnector. * @param requestParameters */ listAgentConnector(requestParameters: ListAgentConnectorRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * list agent connector certificate signing requests * List agent connector certificate signing requests. * @param requestParameters */ listAgentCsr(requestParameters: ListAgentCsrRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * List connectors * List connectors. By default, Connectors will not show stats when listed to speed up the query. Set the show_stats parameter to true to retrieve the stats for every Connector. * @param requestParameters */ listConnector(requestParameters: ListConnectorRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get all connector guids and a unique name mapping * Get all connector guids and a unique name mapping * @param requestParameters */ listConnectorGuidMapping(requestParameters: ListConnectorGuidMappingRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get the Connector stats for many connectors * Gets the most recent stats published by many instances. Use `collected_since` to filter out any stale stats. Use show_dynamic and show_static to choose the type of information to show. * @param requestParameters */ listConnectorStats(requestParameters: ListConnectorStatsRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get all AgentConnectorInstances for a connector_id * Get all AgentConnectorInstances for a connector_id * @param requestParameters */ listInstances(requestParameters: ListInstancesRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * list IPsec connectors * list IPsec connectors. * @param requestParameters */ listIpsecConnector(requestParameters: ListIpsecConnectorRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * List connector proxies * List connector proxies * @param requestParameters */ listProxies(requestParameters: ListProxiesRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get all ConnectorServices for a connector_id * Get all ConnectorServices for a connector_id * @param requestParameters */ listServices(requestParameters: ListServicesRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get all ConnectorSecureTransfers for a connector_id * Get all ConnectorSecureTransfers for a connector_id * @param requestParameters */ listTransfers(requestParameters: ListTransfersRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Update an agent * Update an agent * @param requestParameters */ replaceAgentConnector(requestParameters: ReplaceAgentConnectorRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Update an agent\'s local authentication information * Update an agent\'s local authentication information. This is typically modified by the agent itself. * @param requestParameters */ replaceAgentConnectorLocalAuthInfo(requestParameters: ReplaceAgentConnectorLocalAuthInfoRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Update a CertSigningReq * Update a CertSigningReq * @param requestParameters */ replaceAgentCsr(requestParameters: ReplaceAgentCsrRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * * Update EncryptedData * @param requestParameters */ replaceEncryptedData(requestParameters: ReplaceEncryptedDataRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * * Update an agent connector instance * @param requestParameters */ replaceInstance(requestParameters: ReplaceInstanceRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Update an IPsec connector * Update an IPsec connector * @param requestParameters */ replaceIpsecConnector(requestParameters: ReplaceIpsecConnectorRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * * Update an AgentConnectorProxy * @param requestParameters */ replaceProxy(requestParameters: ReplaceProxyRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * * Update an ConnectorSecureTransfer * @param requestParameters */ replaceTransfer(requestParameters: ReplaceTransferRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; }