/** * 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 { AuditAttribute } from './auditAttribute'; export interface _Audit { /** * The id of the user performing the action */ readonly user_id?: string; /** * The name of the resource type which was affected by the event which generated this record. The `target_id` field will uniquely identify, if possible, the record within the resource type. */ readonly target_resource_type?: string; /** * The org_id associated with the target_id/target_resource_type. */ readonly target_resource_org_id?: string; /** * The human friendly name assigned to the resource. */ target_resource_name?: string | null; /** * The name of the API which generated the event. This will typically be a single value for many different target_resource_types. */ readonly api_name?: string; /** * The organization of the user performing the action */ readonly org_id?: string; /** * the time at which the log was generated */ readonly time?: Date; /** * The type of action performed on the target */ action?: string; /** * The IP address of the host initating the action */ readonly source_ip?: string; /** * The id of the resource affected by the action */ readonly target_id?: string; /** * The id of the bearer token used to authenticate when performing the action */ readonly token_id?: string; /** * A correlation ID associated with requests related to this action */ readonly trace_id?: string; /** * The session associated with this action. Sessions typically span multiple tokens. */ readonly session?: string; /** * The secondary id of the resource affected by the action if one exists. This can occur if the resource\'s primary key is a composite key. APIs whose resources are not referenced by a GUID in the path make use of these fields for example the replace_user_role endpoint uses the user_id, and application to identify a resource. */ readonly secondary_id?: string; /** * The tertiary id of the resource affected by the action if one exists. This can occur if the resource\'s primary key is a composite key. */ readonly tertiary_id?: string; /** * The id of the parent resource for the resource affected by the action. An example of this is the path /v1/collection/2jkdcmwB97jh3kiglnz/subcollection/idabc123. The resource belongs to the `subcollection` which falls under the parent in this case `collection`. As a resulti idabc123 is the target_id, 2jkdCmwB9u7Jh3KIglNZ is the parent ID */ readonly parent_id?: string; /** * The id of the grandparent resource for the resource affected by the action. An example of this is the path /v1/collection/2jkdcmwB97jh3kiglnz/subcollection/2334115135/subsubcolletion/aaabbbccc Similar to the parent id example aaabbbccc is the target_id, 2334115135 is the parent ID and 2jkdcmwB97jh3kiglnz is the grandparent_id */ readonly grandparent_id?: string; /** * A list of AuditAttributes */ audit_attributes?: Array; /** * A human readable summary of this audit. */ description?: string; } export interface Audit extends _Audit { _builtin_original?: _Audit; _remove_builtin_extensions?: () => void; } export declare class AuditImpl implements _Audit { _builtin_original?: _Audit; readonly user_id: string | undefined; readonly target_resource_type: string | undefined; readonly target_resource_org_id: string | undefined; target_resource_name: string | null | undefined; readonly api_name: string | undefined; readonly org_id: string | undefined; readonly time: Date | undefined; action: string | undefined; readonly source_ip: string | undefined; readonly target_id: string | undefined; readonly token_id: string | undefined; readonly trace_id: string | undefined; readonly session: string | undefined; readonly secondary_id: string | undefined; readonly tertiary_id: string | undefined; readonly parent_id: string | undefined; readonly grandparent_id: string | undefined; audit_attributes: Array | undefined; description: string | undefined; constructor(base: _Audit); _remove_builtin_extensions(): void; } export declare function newAuditImpl(base: _Audit): AuditImpl;