canonical: https://jentic.com/apis/swaggerhub.anexya/basic-audit-plugin-apis

# Anexya Basic Audit Plugin APIs

APIs to authenticate and manipulate audit operations. The API exposes 3 endpoints secured with apiKey authentication.

## For AI agents

Programmatically authenticates to the audit plugin., create and start an audit operation. Covers 3 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for identity and authentication only.

## Capabilities

- Authenticates to the Audit plugin.
- Create and start an audit operation
- Complete and stop an already running audit operation
- Query and filter Basic Audit Plugin APIs records by parameters
- Monitor Basic Audit Plugin APIs operational status and events

## Use cases

### Identity and Authentication Operations

Use the Basic Audit Plugin APIs to perform identity auth operations programmatically. The API provides 3 endpoints covering core functionality including authenticates to the audit plugin., create and start an audit operation, complete and stop an already running audit operation.

Example prompt: Call PUT /audit/api/v1/auth to authenticates to the audit plugin.

### Automated authentication Management

Automate authentication operations by combining multiple Basic Audit Plugin APIs endpoints. Agents can create and start an audit operation and then complete and stop an already running audit operation in a single workflow.

Example prompt: Call POST /audit/api/v1/audit/logicaldevices/{logicalDeviceName}/types/audit to create and start an audit operation, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Basic Audit Plugin APIs endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'authenticates to the audit plugin.', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| PUT | /audit/api/v1/auth | Authenticates to the Audit plugin. |
| POST | /audit/api/v1/audit/logicaldevices/{logicalDeviceName}/types/audit | Create and start an audit operation |
| POST | /audit/api/v1/audit/logicaldevices/{logicalDeviceName}/types/audit/complete | Complete and stop an already running audit operation |

## Key resources

- **authentication** — Calls to authenticate the user
- **audit** — Calls to manupulate the audit operations

## Why Jentic

- **Setup:** Wiring the Basic Audit Plugin APIs by hand means authenticating for its JSESSIONID session cookie, tracking the logical device paths, and sequencing the audit and audit-complete calls yourself. Through Jentic you install once, import the Basic Audit Plugin APIs from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** This API puts the logical device name in the URL path (/audit/api/v1/audit/logicaldevices/{logicalDeviceName}/...), so a rule can pin your agent to one logical device: it can run and complete audits for that device and nothing else. You choose the operations it may call, so ones you leave out stay unavailable.
- **Credential handling:** Your Basic Audit session credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'run an audit for a logical device' or 'authenticate to the audit plugin', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Auth0** — Alternative identity auth API
- **Okta** — Alternative identity auth API

## FAQ

### What authentication does the Basic Audit Plugin APIs use?

The Basic Audit Plugin APIs uses an API key passed in the `JSESSIONID` cookie. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I authenticates to the audit plugin. with the Basic Audit Plugin APIs?

Yes. Use the PUT /audit/api/v1/auth endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Basic Audit Plugin APIs?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I authenticates to the audit plugin. through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'authenticates to the audit plugin.'. Jentic returns the matching Basic Audit Plugin APIs operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Basic Audit Plugin APIs have?

The Basic Audit Plugin APIs exposes 3 endpoints covering authentication, audit operations.

### Can I limit what my agent is allowed to do with the Basic Audit Plugin APIs?

Yes. Because you run Jentic One yourself, your own rules decide which operations and credentials the agent may use. Since this API carries the logical device name in the URL path, you can pin the agent to a single logical device so it can only authenticate, start audits, and complete audits for that device. Any operation you leave out of your rules stays unavailable to the agent.