/** * 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 { ApplicationService } from '../model/models'; import { ApplicationServiceCommonStats } from '../model/models'; import { DatabaseResource } from '../model/models'; import { DesktopClientConfiguration } from '../model/models'; import { DesktopResource } from '../model/models'; import { DesktopServerConfiguration } from '../model/models'; import { FileShareService } from '../model/models'; import { ListApplicationServicesResponse } from '../model/models'; import { ListDatabaseResourcesResponse } from '../model/models'; import { ListDesktopResourcesResponse } from '../model/models'; import { ListFileShareServicesResponse } from '../model/models'; import { ListSSHResourcesResponse } from '../model/models'; import { ListServiceForwardersResponse } from '../model/models'; import { RawToken } from '../model/models'; import { SSHResource } from '../model/models'; import { ServiceForwarder } from '../model/models'; import { UsageMetric } from '../model/models'; import { Configuration } from '../configuration'; export interface CreateApplicationServiceRequestParams { ApplicationService: ApplicationService; } export interface CreateApplicationServiceTokenRequestParams { app_service_id: string; org_id: string; } export interface CreateClientConfigurationRequestParams { resource_id: string; DesktopClientConfiguration?: DesktopClientConfiguration; } export interface CreateDatabaseResourceRequestParams { DatabaseResource: DatabaseResource; } export interface CreateDesktopResourceRequestParams { DesktopResource: DesktopResource; } export interface CreateFileShareServiceRequestParams { FileShareService: FileShareService; } export interface CreateServerConfigurationRequestParams { resource_id: string; DesktopServerConfiguration?: DesktopServerConfiguration; } export interface CreateServiceForwarderRequestParams { ServiceForwarder: ServiceForwarder; } export interface CreateSshResourceRequestParams { SSHResource: SSHResource; } export interface DeleteApplicationServiceRequestParams { app_service_id: string; org_id: string; } export interface DeleteDatabaseResourceRequestParams { resource_id: string; org_id?: string; } export interface DeleteDesktopResourceRequestParams { resource_id: string; org_id?: string; } export interface DeleteFileShareServiceRequestParams { file_share_service_id: string; org_id?: string; } export interface DeleteServiceForwarderRequestParams { service_forwarder_id: string; org_id?: string; } export interface DeleteSshResourceRequestParams { resource_id: string; org_id?: string; } export interface GetApplicationServiceRequestParams { app_service_id: string; org_id: string; } export interface GetApplicationServiceStatsRequestParams { app_service_id: string; org_id: string; } export interface GetApplicationServiceUsageMetricsRequestParams { org_id: string; } export interface GetDatabaseResourceRequestParams { resource_id: string; org_id?: string; } export interface GetDesktopResourceRequestParams { resource_id: string; org_id?: string; } export interface GetFileShareServiceRequestParams { file_share_service_id: string; org_id?: string; } export interface GetFileShareUsageMetricsRequestParams { org_id: string; } export interface GetServiceForwarderRequestParams { service_forwarder_id: string; org_id?: string; } export interface GetSshResourceRequestParams { resource_id: string; org_id?: string; } export interface ListApplicationServicesRequestParams { org_id?: string; updated_since?: Date; protocol_type?: 'ip' | 'fileshare' | 'desktop' | 'ssh' | 'database'; protocol_type_list?: Array<'ip' | 'fileshare' | 'desktop' | 'ssh' | 'database'>; name?: string; hostname?: string; hostname_or_service_name?: string; port?: number; show_status?: boolean; external_hostname_or_service?: string; show_connector_services?: boolean; limit?: number; page_on?: Array; page_at_key?: Array; page_sort?: Array<'asc' | 'desc'>; search_direction?: 'backwards' | 'forwards'; } export interface ListDatabaseResourcesRequestParams { org_id?: string; name?: string; connector_id?: string; updated_since?: Date; limit?: number; org_ids?: Array; resource_id?: string; page_at_id?: string; name_slug?: string; page_on?: Array; page_at_key?: Array; page_sort?: Array<'asc' | 'desc'>; search_direction?: 'backwards' | 'forwards'; } export interface ListDesktopResourcesRequestParams { org_id?: string; name?: string; connector_id?: string; updated_since?: Date; limit?: number; org_ids?: Array; resource_id?: string; page_at_id?: string; name_slug?: string; desktop_type?: 'rdp' | 'vnc'; has_remote_app?: boolean; page_on?: Array; page_at_key?: Array; page_sort?: Array<'asc' | 'desc'>; search_direction?: 'backwards' | 'forwards'; } export interface ListFileShareServicesRequestParams { org_id?: string; name?: string; connector_id?: string; updated_since?: Date; limit?: number; org_ids?: Array; resource_id?: string; page_at_id?: string; page_on?: Array; page_at_key?: Array; page_sort?: Array<'asc' | 'desc'>; search_direction?: 'backwards' | 'forwards'; } export interface ListServiceForwardersRequestParams { org_id?: string; name?: string; app_service_id?: string; connector_id?: string; app_service_connector_id?: string; updated_since?: Date; limit?: number; org_ids?: Array; page_on?: Array; page_at_key?: Array; page_sort?: Array<'asc' | 'desc'>; search_direction?: 'backwards' | 'forwards'; } export interface ListSshResourcesRequestParams { org_id?: string; name?: string; connector_id?: string; updated_since?: Date; limit?: number; org_ids?: Array; resource_id?: string; page_at_id?: string; name_slug?: string; page_on?: Array; page_at_key?: Array; page_sort?: Array<'asc' | 'desc'>; search_direction?: 'backwards' | 'forwards'; } export interface ReplaceApplicationServiceRequestParams { app_service_id: string; ApplicationService?: ApplicationService; } export interface ReplaceDatabaseResourceRequestParams { resource_id: string; DatabaseResource?: DatabaseResource; } export interface ReplaceDesktopResourceRequestParams { resource_id: string; DesktopResource?: DesktopResource; } export interface ReplaceFileShareServiceRequestParams { file_share_service_id: string; FileShareService?: FileShareService; } export interface ReplaceServiceForwarderRequestParams { service_forwarder_id: string; ServiceForwarder?: ServiceForwarder; } export interface ReplaceSshResourceRequestParams { resource_id: string; SSHResource?: SSHResource; } export interface ApplicationServicesServiceInterface { defaultHeaders: HttpHeaders; configuration: Configuration; /** * Create an ApplicationService * It is expected that owners for an organisation will provide connectivity to an ApplicationService by defining one here, then adding a reference to an Application\'s Environment in the ApplicationService\'s `assignments` list. To see the list of ApplicationServices for which a given Application Environment has access, see that Environment\'s read only `applications_services` list. * @param requestParameters */ createApplicationService(requestParameters: CreateApplicationServiceRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * create a token for an application service * Create a token for an application service * @param requestParameters */ createApplicationServiceToken(requestParameters: CreateApplicationServiceTokenRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Create a client configuration * Create a client configuration file. This file may be downloaded and used by the appropriate client to connect to the DesktopResource. If you provide the id of user who wants to connect, the file will contain credentials which may be used to prove their authorization to access the DesktopResource. The DesktopClientConfiguration is not stored in the system. Subsequent calls to create a new DesktopClientConfiguration will lead to a new one being generated. * @param requestParameters */ createClientConfiguration(requestParameters: CreateClientConfigurationRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Create a DatabaseResource * Administrators can allow remote connectivity to a database using a DatabaseResource. Make sure to expose the DatabaseResource through a connector by setting the `connector_id`. You can create multiple DatabaseResource objects for a given database, with different settings. The name of the DatabaseResource uniquely identifies it. * @param requestParameters */ createDatabaseResource(requestParameters: CreateDatabaseResourceRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Create a DesktopResource * Administrators for an organisation can allow remote connectivity to a desktop by creating a DesktopResource using this endpoint. Make sure to expose the DesktopResource through a connector by setting the `connector_id`. You can create multiple DesktopResource objects. for a given desktop. The name of the DesktopResource uniquely identifies it. * @param requestParameters */ createDesktopResource(requestParameters: CreateDesktopResourceRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Create an FileShareService * It is expected that owners for an organisation will provide connectivity to an FileShareService by defining one here, then adding a reference to an Application\'s Environment in the FileShareService\'s `assignments` list. To see the list of FileShareServices for which a given Application Environment has access, see that Environment\'s read only `applications_services` list. * @param requestParameters */ createFileShareService(requestParameters: CreateFileShareServiceRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Create a server configuration * Create a server configuration file. This file may be downloaded and used by the appropriate server to configures itself to expose the DesktopResource. The file is returned immediately in the response. It is not persisted. * @param requestParameters */ createServerConfiguration(requestParameters: CreateServerConfigurationRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Create an ServiceForwarder * Create an ServiceForwarder * @param requestParameters */ createServiceForwarder(requestParameters: CreateServiceForwarderRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Create a SSHResource * Administrators can allow remote connectivity to a machine via the SSH protocol by creating a SSHResource using this endpoint. Make sure to expose the SSHResource through a connector by setting the `connector_id`. You can create multiple SSHResource objects. for a given machine. The name of the SSHResource uniquely identifies it. * @param requestParameters */ createSshResource(requestParameters: CreateSshResourceRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Remove an ApplicationService * Remove an ApplicationService * @param requestParameters */ deleteApplicationService(requestParameters: DeleteApplicationServiceRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable<{}>; /** * Remove a DatabaseResource * Remove a DatabaseResource. After removal, users will no longer be able to access the DatabaseResource. Existing connections to the DatabaseResource may persist for some time afterwards. * @param requestParameters */ deleteDatabaseResource(requestParameters: DeleteDatabaseResourceRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable<{}>; /** * Remove a DesktopResource * Remove a DesktopResource. After removal, users will no longer be able to access the DesktopResource. Existing connections to the DesktopResource may persist for some time afterwards. * @param requestParameters */ deleteDesktopResource(requestParameters: DeleteDesktopResourceRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable<{}>; /** * Remove an FileShareService * Remove an FileShareService * @param requestParameters */ deleteFileShareService(requestParameters: DeleteFileShareServiceRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable<{}>; /** * Remove an ServiceForwarder * Remove an ServiceForwarder * @param requestParameters */ deleteServiceForwarder(requestParameters: DeleteServiceForwarderRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable<{}>; /** * Remove a SSHResource * Remove a SSHResource. After removal, users will no longer be able to access the SSHResource. Existing connections to the SSHResource may persist for some time afterwards. * @param requestParameters */ deleteSshResource(requestParameters: DeleteSshResourceRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable<{}>; /** * Get a single ApplicationService * Get a single ApplicationService * @param requestParameters */ getApplicationService(requestParameters: GetApplicationServiceRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get ApplicationServiceStats * Gets the most recent stats published for an ApplicationService, aggregated across connector intsances. * @param requestParameters */ getApplicationServiceStats(requestParameters: GetApplicationServiceStatsRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get application service metrics * Retrieves all application service metrics related to the org_id. * @param requestParameters */ getApplicationServiceUsageMetrics(requestParameters: GetApplicationServiceUsageMetricsRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get a single DatabaseResource * Get the details of a single DatabaseResource. Specify the id of the organisation which owns this resource to ensure you have permission. * @param requestParameters */ getDatabaseResource(requestParameters: GetDatabaseResourceRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get a single DesktopResource * Get the details of a single DesktopResource. Specify the id of the organisation which owns this resource to ensure you have permission. * @param requestParameters */ getDesktopResource(requestParameters: GetDesktopResourceRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get a single FileShareService * Get a single FileShareService * @param requestParameters */ getFileShareService(requestParameters: GetFileShareServiceRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get file share service metrics * Retrieves all file share service metrics related to the org_id. * @param requestParameters */ getFileShareUsageMetrics(requestParameters: GetFileShareUsageMetricsRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get a single ServiceForwarder * Get a single ServiceForwarder * @param requestParameters */ getServiceForwarder(requestParameters: GetServiceForwarderRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get a single SSHResource * Get the details of a single SSHResource. Specify the id of the organisation which owns this resource to ensure you have permission. * @param requestParameters */ getSshResource(requestParameters: GetSshResourceRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get a subset of the ApplicationServices * Retrieves all ApplicationServices owned by the Organisation. * @param requestParameters */ listApplicationServices(requestParameters: ListApplicationServicesRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get a subset of the DatabaseResource objects. * Retrieves DatabaseResource objects owned by the Organisation. * @param requestParameters */ listDatabaseResources(requestParameters: ListDatabaseResourcesRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get a subset of the DesktopResource objects. * Retrieves DesktopResource objects owned by the Organisation. * @param requestParameters */ listDesktopResources(requestParameters: ListDesktopResourcesRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get a subset of the FileShareServices * Retrieves all FileShareServices owned by the Organisation. * @param requestParameters */ listFileShareServices(requestParameters: ListFileShareServicesRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get a subset of the ServiceForwarder objects * Retrieves all ServiceForwarder objects owned by the Organisation. * @param requestParameters */ listServiceForwarders(requestParameters: ListServiceForwardersRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get a subset of the SSHResource objects. * Retrieves SSHResource objects owned by the Organisation. * @param requestParameters */ listSshResources(requestParameters: ListSshResourcesRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Create or update an Application Service. * Create or update an Application Service. * @param requestParameters */ replaceApplicationService(requestParameters: ReplaceApplicationServiceRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Create or update a DatabaseResource. * Create or update a DatabaseResource. * @param requestParameters */ replaceDatabaseResource(requestParameters: ReplaceDatabaseResourceRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Create or update a DesktopResource. * Create or update a DesktopResource. * @param requestParameters */ replaceDesktopResource(requestParameters: ReplaceDesktopResourceRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Create or update an FileShareService. * Create or update an FileShareService. * @param requestParameters */ replaceFileShareService(requestParameters: ReplaceFileShareServiceRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Create or update an ServiceForwarder. * Create or update an ServiceForwarder. * @param requestParameters */ replaceServiceForwarder(requestParameters: ReplaceServiceForwarderRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Create or update a SSHResource. * Create or update a SSHResource. * @param requestParameters */ replaceSshResource(requestParameters: ReplaceSshResourceRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; }