/** * 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 { OrganisationSystemOptions } from './organisationSystemOptions'; import { OrganisationCapabilities } from './organisationCapabilities'; import { FeatureFlag } from './featureFlag'; import { OrganisationOwnerConfig } from './organisationOwnerConfig'; import { OrganisationStatus } from './organisationStatus'; import { OrganisationStateSelector } from './organisationStateSelector'; export interface _Organisation { /** * Unique identifier */ readonly id?: string; /** * group id of group containing this organisations all users */ all_users_group_id?: string; /** * group id of group containing this organisations all users including all sub organisations */ all_users_all_suborgs_group_id?: string; /** * group id of group containing this organisations all users including only direct sub organisations */ all_users_direct_suborgs_group_id?: string; /** * group id of group containing users automatically created when they logged in */ auto_created_users_group_id?: string; /** * External unique identifier */ external_id?: string; /** * organisation name */ organisation?: string; /** * openid connect issuer */ issuer?: string; /** * Unique identifier */ issuer_id?: string; /** * Organisations subdomain. Note this must be unique accross all organisations */ subdomain?: string; /** * A human readable slug to identify a resource and that is rfc1035 label compliant. The length has been restricted to 20 characters such that this name can be concatenated with other names or slugs. A slug is readOnly as it is generated by the backend resource. */ name_slug?: string; /** * Creation time */ readonly created?: Date; /** * Update time */ readonly updated?: Date; /** * GUID of the organisation admin */ contact_id?: string; /** * The email address of the contact. */ readonly contact_email?: string; /** * parent organisation id */ parent_id?: string; /** * The id of the organisation at the root of this organisation hierarchy. For example, if A is the parent of B, and B is the parent of C, then A would be the root organisation of A, B and C. Note that this field will be ignored if changed. */ root_org_id?: string; /** * Auto-creates a user */ auto_create?: boolean; /** * The time window in seconds which represents the period of time for which a new user is eligible for trust on first use enrollment. The duration will be applied from the user\'s created date, or if the user\'s enrollment period was reset by an administrator. */ trust_on_first_use_duration?: number; /** * A list of features to enable or disable. This is mostly for advanced use. No guarantees exist that a given feature will always exist by a given name, or that it will be configurable. */ feature_flags?: Array; admin_state?: OrganisationStateSelector; status?: OrganisationStatus; /** * The billing account id */ billing_account_id?: string; /** * The billing subscription id */ billing_subscription_id?: string; /** * The shard to use on the agilicus platform. This provides logical seperation on the agilicus platform. This can be used to prevent access to applications between suborgs in the same organisation. */ shard?: string; /** * The agilicus cluster/region to host the platform on. This provides information to determine what physical location any services provided should run from. Consult the list of Regions for the possible values to set here. Changing this value will cause resources to move to the new cluster. Changing the setting will cause a few minutes of downtime while resources are moved. You will have to change the cname for your domain in order to attract traffic to the correct location. */ cluster?: string; configured_capabilities?: OrganisationCapabilities; owner_config?: OrganisationOwnerConfig; /** * Override the default product label. */ product_label_override?: string; system_options?: OrganisationSystemOptions; /** * Global rules bundle id (see StandaloneRulesetBundle) applied globally across the organisation. */ ruleset_bundle_id?: string; /** * Unique identifier */ point_of_presence_id?: string; /** * The name of a tag. Tag names are case sensitive. */ point_of_presence_name?: string; /** * Unique identifier */ region_id?: string; /** * The region name this organisation is associated with */ readonly region_name?: string; } export interface Organisation extends _Organisation { _builtin_original?: _Organisation; _remove_builtin_extensions?: () => void; } export declare class OrganisationImpl implements _Organisation { _builtin_original?: _Organisation; readonly id: string | undefined; all_users_group_id: string | undefined; all_users_all_suborgs_group_id: string | undefined; all_users_direct_suborgs_group_id: string | undefined; auto_created_users_group_id: string | undefined; external_id: string | undefined; organisation: string | undefined; issuer: string | undefined; issuer_id: string | undefined; subdomain: string | undefined; name_slug: string | undefined; readonly created: Date | undefined; readonly updated: Date | undefined; contact_id: string | undefined; readonly contact_email: string | undefined; parent_id: string | undefined; root_org_id: string | undefined; auto_create: boolean | undefined; trust_on_first_use_duration: number | undefined; feature_flags: Array | undefined; admin_state: OrganisationStateSelector | undefined; status: OrganisationStatus | undefined; billing_account_id: string | undefined; billing_subscription_id: string | undefined; shard: string | undefined; cluster: string | undefined; configured_capabilities: OrganisationCapabilities | undefined; owner_config: OrganisationOwnerConfig | undefined; product_label_override: string | undefined; system_options: OrganisationSystemOptions | undefined; ruleset_bundle_id: string | undefined; point_of_presence_id: string | undefined; point_of_presence_name: string | undefined; region_id: string | undefined; readonly region_name: string | undefined; constructor(base: _Organisation); _remove_builtin_extensions(): void; } export declare function newOrganisationImpl(base: _Organisation): OrganisationImpl;