canonical: https://jentic.com/apis/swaggerhub.hypatos.ai/swaggerhub-hypatos

# Hypatos Auth Service

Auth Service provides programmatic access to identity auth functionality. The API exposes 1 endpoints secured with basic, oauth2 authentication.

## For AI agents

Programmatically request an access token. Covers 1 operations with basic, oauth2 authentication.

## Scope

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

## Capabilities

- Request an access token
- Manage identity auth data programmatically
- Integrate Auth Service into automated workflows
- Query and filter Auth Service records by parameters
- Monitor Auth Service operational status and events

## Use cases

### Identity and Authentication Operations

Use the Auth Service to perform identity auth operations programmatically. The API provides 1 endpoints covering core functionality including request an access token.

Example prompt: Call POST `/auth/token` to request an access token

### Data Retrieval and Monitoring

Query Auth Service 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 Auth Service endpoint, compare response to last known state, and alert if changed

### AI Agent Integration via Jentic

AI agents discover and call Auth Service 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, oauth2 tokens manually.

Example prompt: Search Jentic for 'request an access token', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/auth/token` | Request an access token |

## Key resources

- **Authorization** — Endpoints for handling the [OAuth 2.0 Client Credentials Grant](https://www.rfc-editor.org/rfc/rfc67

## Why Jentic

- **Setup:** Wiring the Hypatos Auth Service by hand means handling its OAuth2 client-credentials and basic auth, choosing the right EU (api.cloud.hypatos.ai) or US (api.cloud.hypatos.com) host, and requesting tokens yourself. Through Jentic you install once, import the Auth Service from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** The token request travels in the request body against `/auth/token`, so scope the agent to the operations it needs, such as requesting an access token, rather than to a single resource. You choose the operations it may call, so only that request is included unless you add more.
- **Credential handling:** Your Hypatos client credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'request an access token', and Jentic returns the matching Auth Service 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 Auth Service use?

The Auth Service uses basic, oauth2 authentication. 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 request an access token with the Auth Service?

Yes. Use the POST `/auth/token` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Auth Service?

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 request an access token through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'request an access token'. Jentic returns the matching Auth Service operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Auth Service have?

The Auth Service exposes 1 endpoints covering authorization operations.

### Can I limit what my agent is allowed to do with the Auth Service API?

Yes. Because Jentic One is self-hosted, you set the rules that decide which operations and credentials your agent may use. The Auth Service exposes a single operation, POST `/auth/token` to request an access token, so you scope the agent to just that call and it can do nothing more unless you allow it. Your Hypatos client credentials stay stored in your own Jentic One instance and are injected only when a permitted operation runs.