canonical: https://jentic.com/apis/swaggerhub.csodedge/edge-assessment-connector

# Csodedge Edge Assessment Connector

Edge Assessment API Template. Use this template to help generate your API contracts so that you can connect with CSOD and become an assessment provider. Detailed in this API are endpoints that should be implemented so that the contract can adhere to Edge Assessment Provider standards. The API exposes 2 endpoints secured with basic authentication.

## For AI agents

Programmatically this endpoint is used to retrieve the list of available assessments, this endpoint is used to initiate the selected assessment and retrieve the launc. Covers 2 operations with basic authentication.

## Scope

Does not handle payments, communications, or crm - use for developer tools only.

## Capabilities

- This endpoint is used to retrieve the list of available assessments
- Manage developer tools data programmatically
- Integrate Edge Assessment Connector into automated workflows
- Query and filter Edge Assessment Connector records by parameters
- Monitor Edge Assessment Connector operational status and events

## Use cases

### Developer Tools Operations

Use the Edge Assessment Connector to perform developer tools operations programmatically. The API provides 2 endpoints covering core functionality including this endpoint is used to retrieve the list of available assessments, this endpoint is used to initiate the selected assessment and retrieve the launc.

Example prompt: Call GET `/api/Assessment` to this endpoint is used to retrieve the list of available assessments

### Data Retrieval and Monitoring

Query Edge Assessment Connector resources on a schedule to track changes, generate alerts, or feed downstream dashboards. Agents poll relevant endpoints, compare against previous state, and trigger actions when thresholds are crossed.

Example prompt: Poll the primary Edge Assessment Connector endpoint, compare response to last known state, and alert if changed

### AI Agent Integration via Jentic

AI agents discover and call Edge Assessment Connector 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 basic tokens manually.

Example prompt: Search Jentic for 'this endpoint is used to retrieve the list of available assessments', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/Assessment` | This endpoint is used to retrieve the list of available assessments |
| POST | `/api/InitiateAssessment` | This endpoint is used to initiate the selected assessment and retrieve the launc |

## Key resources

- **Assessment** — Operations for Assessment
- **Initiateassessment** — Operations for InitiateAssessment

## Why Jentic

- **Setup:** Wiring the Edge Assessment Connector by hand means setting up its HTTP basic auth, encoding the credentials on each call, and matching the assessment request formats yourself. Through Jentic you install once, import the Edge Assessment Connector from the API Directory, store the basic-auth credential once, and your agent calls it.
- **Permission scoping:** This connector takes its assessment details in the request body rather than a URL path, so limit the agent to the operations it needs, such as listing available assessments. You choose which operations are allowed, so a write like initiating an assessment is only included if you add it.
- **Credential handling:** Your Edge Assessment Connector basic-auth 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 'list available assessments' or 'initiate an assessment', and Jentic returns the matching Edge Assessment Connector operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the Edge Assessment Connector use?

The Edge Assessment Connector uses HTTP Basic authentication with username and password. 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 this endpoint is used to retrieve the list of available assessments with the Edge Assessment Connector?

Yes. Use the GET `/api/Assessment` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Edge Assessment Connector?

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 this endpoint is used to retrieve the list of available assessments through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'this endpoint is used to retrieve the list of available assessments'. Jentic returns the matching Edge Assessment Connector operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Edge Assessment Connector have?

The Edge Assessment Connector exposes 2 endpoints covering assessment, initiateassessment operations.

### Can I limit what my agent is allowed to do with the Edge Assessment Connector API?

Yes. Because you run Jentic One yourself, your own rules decide which Edge Assessment Connector operations your agent can call. You can allow only the read operation, GET `/api/Assessment` for listing available assessments, and leave out the write operation, POST `/api/InitiateAssessment`, so the agent cannot start an assessment unless you explicitly add it. The stored basic-auth credential is injected only for the operations you permit.
