/** * 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 { Application } from '../model/models'; import { Environment } from '../model/models'; import { EnvironmentConfig } from '../model/models'; import { ListApplicationSummaryResponse } from '../model/models'; import { ListApplicationsResponse } from '../model/models'; import { ListCombinedRulesResponse } from '../model/models'; import { ListConfigsResponse } from '../model/models'; import { ListEnvironmentConfigsResponse } from '../model/models'; import { ListRoleToRuleEntries } from '../model/models'; import { ListRoles } from '../model/models'; import { ListRules } from '../model/models'; import { OrgScopePatchDocument } from '../model/models'; import { RoleToRuleEntry } from '../model/models'; import { RoleV2 } from '../model/models'; import { RuleScopeEnum } from '../model/models'; import { RuleV2 } from '../model/models'; import { RuntimeStatus } from '../model/models'; import { UsageMetric } from '../model/models'; import { UsageMetrics } from '../model/models'; import { Configuration } from '../configuration'; export interface AddConfigRequestParams { app_id: string; env_name: string; EnvironmentConfig: EnvironmentConfig; } export interface AddRoleRequestParams { app_id: string; RoleV2: RoleV2; } export interface AddRoleToRuleEntryRequestParams { app_id: string; RoleToRuleEntry: RoleToRuleEntry; } export interface AddRuleRequestParams { app_id: string; RuleV2: RuleV2; } export interface CreateApplicationRequestParams { Application: Application; } export interface DeleteApplicationRequestParams { app_id: string; org_id?: string; } export interface DeleteConfigRequestParams { app_id: string; env_name: string; env_config_id: string; maintenance_org_id: string; } export interface DeleteRoleRequestParams { app_id: string; role_id: string; org_id?: string; } export interface DeleteRoleToRuleEntryRequestParams { app_id: string; role_to_rule_entry_id: string; org_id?: string; } export interface DeleteRuleRequestParams { app_id: string; rule_id: string; org_id?: string; } export interface GetAllUsageMetricsRequestParams { org_id: string; org_ids?: Array; } export interface GetApplicationRequestParams { app_id: string; org_id?: string; assigned_org_id?: string; include_migrated_environments?: boolean; get_scopes?: boolean; } export interface GetApplicationUsageMetricsRequestParams { org_id: string; } export interface GetConfigRequestParams { app_id: string; env_name: string; env_config_id: string; maintenance_org_id: string; } export interface GetEnvironmentRequestParams { app_id: string; env_name: string; org_id: string; get_scopes?: boolean; } export interface GetRoleRequestParams { app_id: string; role_id: string; org_id?: string; } export interface GetRoleToRuleEntryRequestParams { app_id: string; role_to_rule_entry_id: string; org_id?: string; } export interface GetRuleRequestParams { app_id: string; rule_id: string; org_id?: string; } export interface ListApplicationSummariesRequestParams { org_id?: string; assigned_org_ids?: Array; resource_id?: string; limit?: number; } export interface ListApplicationsRequestParams { org_id?: string; assigned_org_id?: string; maintained?: boolean; assigned?: boolean; owned?: boolean; updated_since?: Date; show_status?: boolean; application_type?: Array<'user_defined' | 'internal'>; include_migrated_environments?: boolean; resource_id?: string; limit?: number; page_on?: Array; page_at_key?: Array; page_sort?: Array<'asc' | 'desc'>; search_direction?: 'backwards' | 'forwards'; } export interface ListCombinedRulesRequestParams { org_id?: string; scopes?: Array; app_id?: string; limit?: number; assigned?: boolean; } export interface ListConfigsRequestParams { app_id: string; env_name: string; maintenance_org_id: string; } export interface ListEnvironmentConfigsAllAppsRequestParams { maintenance_org_id: string; limit?: number; } export interface ListRoleToRuleEntriesRequestParams { app_id: string; org_id?: string; limit?: number; } export interface ListRolesRequestParams { app_id: string; org_id?: string; limit?: number; } export interface ListRulesRequestParams { app_id: string; org_id?: string; scope?: RuleScopeEnum; limit?: number; } export interface ListRuntimeStatusRequestParams { app_id: string; env_name: string; org_id: string; } export interface ReplaceApplicationRequestParams { app_id: string; Application?: Application; } export interface ReplaceConfigRequestParams { app_id: string; env_name: string; env_config_id: string; EnvironmentConfig: EnvironmentConfig; } export interface ReplaceEnvironmentRequestParams { app_id: string; env_name: string; get_scopes?: boolean; Environment?: Environment; } export interface ReplaceRoleRequestParams { app_id: string; role_id: string; RoleV2?: RoleV2; } export interface ReplaceRoleToRuleEntryRequestParams { app_id: string; role_to_rule_entry_id: string; RoleToRuleEntry?: RoleToRuleEntry; } export interface ReplaceRuleRequestParams { app_id: string; rule_id: string; RuleV2?: RuleV2; } export interface ReplaceRuntimeStatusRequestParams { app_id: string; env_name: string; RuntimeStatus: RuntimeStatus; } export interface UpdatePatchApplicationRequestParams { app_id: string; OrgScopePatchDocument?: OrgScopePatchDocument; } export interface ApplicationsServiceInterface { defaultHeaders: HttpHeaders; configuration: Configuration; /** * Add an environment configuration row * Add an environment configuration row * @param requestParameters */ addConfig(requestParameters: AddConfigRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Add a role to the application. * Add a role to the application. * @param requestParameters */ addRole(requestParameters: AddRoleRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Add a rule to a role in the application. * Add a rule to a role in the application. * @param requestParameters */ addRoleToRuleEntry(requestParameters: AddRoleToRuleEntryRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Add a rule to the application. * Add a rule to the application. * @param requestParameters */ addRule(requestParameters: AddRuleRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Create an application * Create an application according to spec * @param requestParameters */ createApplication(requestParameters: CreateApplicationRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Remove an application * Remove an application * @param requestParameters */ deleteApplication(requestParameters: DeleteApplicationRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable<{}>; /** * Remove an environment configuration * Remove an environment configuration * @param requestParameters */ deleteConfig(requestParameters: DeleteConfigRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable<{}>; /** * Remove a role * Remove a role * @param requestParameters */ deleteRole(requestParameters: DeleteRoleRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable<{}>; /** * Remove a role_to_rule_entry * Remove a role_to_rule_entry * @param requestParameters */ deleteRoleToRuleEntry(requestParameters: DeleteRoleToRuleEntryRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable<{}>; /** * Remove a rule * Remove a rule * @param requestParameters */ deleteRule(requestParameters: DeleteRuleRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable<{}>; /** * Get all resource metrics for the Applications API * Retrieves all resource metrics for the Applications API for a specified the org_id. * @param requestParameters */ getAllUsageMetrics(requestParameters: GetAllUsageMetricsRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get a application * Get a application * @param requestParameters */ getApplication(requestParameters: GetApplicationRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get application metrics * Retrieves all application metrics related to the org_id. * @param requestParameters */ getApplicationUsageMetrics(requestParameters: GetApplicationUsageMetricsRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get environment configuration * Retrieve environment configuration * @param requestParameters */ getConfig(requestParameters: GetConfigRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get an environment * This allows an environment maintainer to get an environment they maintain. * @param requestParameters */ getEnvironment(requestParameters: GetEnvironmentRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get a role * Retrieves a given role by ID * @param requestParameters */ getRole(requestParameters: GetRoleRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get a role_to_rule_entry * Retrieves a given role_to_rule_entry by ID * @param requestParameters */ getRoleToRuleEntry(requestParameters: GetRoleToRuleEntryRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get a rule * Retrieves a given rule by ID * @param requestParameters */ getRule(requestParameters: GetRuleRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * List application summaries * Retrieve all application summaries corresponding to the provided parameters. One summary will exist per organisation assigned to the application. If a single org id is provided in the `org_id` parameter, then all assignments for all applications owned by that org will be listed. If a list of org ids are provided via the `assigned_org_ids` parameter, then the assignments will be constrained to ones for those org ids. Note that these two org id parameters can work together. One constrains the applications, and the other the assignments, so the combination of the two could be used to show a subset of the assignments for a given organisation\'s applications. * @param requestParameters */ listApplicationSummaries(requestParameters: ListApplicationSummariesRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get applications * Retrieves all applications related to the org_id. Different types of relationship may be queried by setting the appropriate flags: - assigned: Has an Environment assigned to the organisation. - owned: Owned by the organisation. - maintained: Has an Environment maintained by the organisation. Any combination of the relationship flags may be set. Note that if the organisation does not own the Application, but maintains or is assigned an environment only those assignments and environments for the querying organisation will be shown. * @param requestParameters */ listApplications(requestParameters: ListApplicationsRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * List rules combined by scope or role * Retrieve all role_to_rule_entries for an application. If assigned is true, this will list all role_to_rule_entries for applications assigned to the given org_id * @param requestParameters */ listCombinedRules(requestParameters: ListCombinedRulesRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get all environment configuration * Retrieve all environment configuration * @param requestParameters */ listConfigs(requestParameters: ListConfigsRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get all environment configuration for a given organisation. * Retrieve all environment configuration for a organisation. * @param requestParameters */ listEnvironmentConfigsAllApps(requestParameters: ListEnvironmentConfigsAllAppsRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get all RoleToRuleEntries * Retrieve all role_to_rule_entries for an application * @param requestParameters */ listRoleToRuleEntries(requestParameters: ListRoleToRuleEntriesRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get all roles * Retrieve all roles for an application * @param requestParameters */ listRoles(requestParameters: ListRolesRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get all rules * Retrieve all rules for an application * @param requestParameters */ listRules(requestParameters: ListRulesRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get an environment\'s runtime status * Get an environment\'s runtime status * @param requestParameters */ listRuntimeStatus(requestParameters: ListRuntimeStatusRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Create or update an application * Create or update an application * @param requestParameters */ replaceApplication(requestParameters: ReplaceApplicationRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Update environment configuration * Update environment configuration * @param requestParameters */ replaceConfig(requestParameters: ReplaceConfigRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Update an environment * This allows an environment maintainer to update the environment. Note that the maintenence_organisation in the body must match the existing one. * @param requestParameters */ replaceEnvironment(requestParameters: ReplaceEnvironmentRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Update a role * Updates a role with a new specification. * @param requestParameters */ replaceRole(requestParameters: ReplaceRoleRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Update a role_to_rule_entry * Updates a role_to_rule_entry with a new specification. * @param requestParameters * @deprecated */ replaceRoleToRuleEntry(requestParameters: ReplaceRoleToRuleEntryRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Update a rule * Updates a rule with a new specification. * @param requestParameters */ replaceRule(requestParameters: ReplaceRuleRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * update an environemnt\'s runtime status * update an environemnt\'s runtime status * @param requestParameters */ replaceRuntimeStatus(requestParameters: ReplaceRuntimeStatusRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * patch application * patch application * @param requestParameters */ updatePatchApplication(requestParameters: UpdatePatchApplicationRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; }