/** * 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 { AdminStatus } from './adminStatus'; import { AutoCreateStatus } from './autoCreateStatus'; import { OperationalStatus } from './operationalStatus'; export interface _LocalAuthUpstreamIdentityProvider { /** * A name used to uniquely refer to the upstream identity provider configuration. This is the text that will be displayed when presenting the upstream identity for login. */ name?: string; /** * The upstream issuer uri. This is the URI which identifies the issuer against which users selecting this upstream will authenticate. */ issuer?: string; /** * The type of upstream. For instance an OpenID Connector Upstream. */ upstream_type?: LocalAuthUpstreamIdentityProvider.UpstreamTypeEnum; /** * The icon file to be used, limited to: numbers, letters, underscores, hyphens and periods. It is part of a css class (with the periods replaced by underscores). To use a custom icon than the provided default you will need to add the icon the static/img folder and update the static css file to add a new css button like below ```json .dex-btn-icon-- { background-image: url(../static/img/); } ``` To use a default icon simply enter an icon name from the pre-provided defaults found in the static/img folder The default icons are - bitbucket - coreos - email - github - gitlab - google - ldap - linkedin - microsoft - oidc - saml */ icon?: string; auto_create_status?: AutoCreateStatus; admin_status?: AdminStatus; /** * Inidicates whether traps (notifications) should be disabled for this entity. A true state indicates notifications will not be sent on transition. */ trap_disabled?: boolean; operational_status?: OperationalStatus; /** * Uniquely identifies the upstream resource providing the local authentication for instance an Agilicus Agent Connector ID. */ upstream_id: string; /** * If The domain this local upstream provides is incorrect, use this to overide it to some known correct value */ upstream_domain_name?: string; } export interface LocalAuthUpstreamIdentityProvider extends _LocalAuthUpstreamIdentityProvider { _builtin_original?: _LocalAuthUpstreamIdentityProvider; _remove_builtin_extensions?: () => void; } export declare class LocalAuthUpstreamIdentityProviderImpl implements _LocalAuthUpstreamIdentityProvider { _builtin_original?: _LocalAuthUpstreamIdentityProvider; name: string | undefined; issuer: string | undefined; upstream_type: LocalAuthUpstreamIdentityProvider.UpstreamTypeEnum | undefined; icon: string | undefined; auto_create_status: AutoCreateStatus | undefined; admin_status: AdminStatus | undefined; trap_disabled: boolean | undefined; operational_status: OperationalStatus | undefined; upstream_id: string; upstream_domain_name: string | undefined; constructor(base: _LocalAuthUpstreamIdentityProvider); _remove_builtin_extensions(): void; } export declare namespace LocalAuthUpstreamIdentityProvider { type UpstreamTypeEnum = 'oidc' | 'local_auth' | 'application' | 'kerberos'; const UpstreamTypeEnum: { oidc: UpstreamTypeEnum; local_auth: UpstreamTypeEnum; application: UpstreamTypeEnum; kerberos: UpstreamTypeEnum; }; } export declare function newLocalAuthUpstreamIdentityProviderImpl(base: _LocalAuthUpstreamIdentityProvider): LocalAuthUpstreamIdentityProviderImpl;