/** * 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. */ export interface _AuthAudits { /** * The system-local id of the user performing the action. */ user_id?: string; /** * The id of the user in the upstream system, if available. */ upstream_user_id?: string; /** * The id of the organisation of the issuer against which the user is authenticating. */ org_id?: string; /** * The name of the organisation of the issuer against which the user is authenticating. */ org_name?: string; /** * the time at which the record was generated. */ time?: Date; /** * The event which generated the record. The meaning of the event depends on the stage where it occured. Deprecated: this has been replaced with Result. */ event?: string; /** * The event name which generated the record. The following events are supported: \"Authentication Request\": An OIDC 3-way handshake authentication request flow (RFC6749) \"Identity Provider Authentication\": Authentication with an upstream identity provider. \"Identity Provider Callback\": A callback received during the OIDC 3-way handshake that involves communicating with the upstream identity provider. \"Assertion Request\": Authorization associated with a service account utilizing an authentication document. \"Policy Evaluation\": As part of authentication and authorization, policy is being evaluated. \"Token\": Creation of an Access Token for access to Agilicus resources. \"MFA Challenge\": A Multifactor method is required and this is communicating to the user to invoke their MFA method. */ event_name?: string; /** * The IP address of the host initiating the action */ source_ip?: string; /** * The id of the token issued or reissued as part of the authentication. */ token_id?: string; /** * A correlation ID associated with requests related to this event */ trace_id?: string; /** * The session associated with tokens related to this event. This can be used to tie the actions undertaking by requests bearing tokens with the same session back to the authentication events which created the tokens. */ session?: string; /** * The issuer the user logged in to. */ issuer?: string; /** * The client id of the web application, client, etc. that the user is logging in with. Note that this is not the id of the `IssuerClient`, but rather the id presented to the authentication system to identify that client. This corresponds to `name` in the `IssuerClient`. */ client_id?: string; /** * The name of the application within the system the user is logging in to. */ application_name?: string; /** * The id of the organisation that the user is logging in to. Note that this is disctinct from the `org_id` field, which is tied to the issuer. This id is tied to the application. */ login_org_id?: string; /** * The name of the organisation that the user is logging in to. This corresponds to `login_org_id`. */ login_org_name?: string; /** * The name of the identity provider proving the identity of the user. */ upstream_idp?: string; /** * The stage of the login process. This identifies where in the pipeline the event was generated. Deprecated, this has been replaced with event_name. */ stage?: string; /** * The result of the event. The following results are supported: \"Success\" \"InProgress\" \"Authenticate\" \"DoMfa\" \"Create\" \"Failure\" \"Denied\" \"Timeout\" \"CodeIssued\" \"SessionExpired\" */ result?: string; /** * The user agent of the client used to perform the login. */ user_agent?: string; /** * The unique ID linking multiple parts of an authentication flow together. Use this to correlate multiple audit records to understand the end result of a single login attempt. */ request_id?: string; } export interface AuthAudits extends _AuthAudits { _builtin_original?: _AuthAudits; _remove_builtin_extensions?: () => void; } export declare class AuthAuditsImpl implements _AuthAudits { _builtin_original?: _AuthAudits; user_id: string | undefined; upstream_user_id: string | undefined; org_id: string | undefined; org_name: string | undefined; time: Date | undefined; event: string | undefined; event_name: string | undefined; source_ip: string | undefined; token_id: string | undefined; trace_id: string | undefined; session: string | undefined; issuer: string | undefined; client_id: string | undefined; application_name: string | undefined; login_org_id: string | undefined; login_org_name: string | undefined; upstream_idp: string | undefined; stage: string | undefined; result: string | undefined; user_agent: string | undefined; request_id: string | undefined; constructor(base: _AuthAudits); _remove_builtin_extensions(): void; } export declare function newAuthAuditsImpl(base: _AuthAudits): AuthAuditsImpl;