# Janssen Config API

**Canonical:** https://apis.io/apis/gluu/jans-config-api/  
**Provider:** Gluu — https://apis.io/providers/gluu/  
**Base URL:** https://{host}/jans-config-api  
**Documentation:** https://docs.jans.io/stable/janssen-server/config-guide/

Janssen Config API is one of 10 APIs that [Gluu](https://apis.io/providers/gluu/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Administration, Configuration, IAM, and Authentication. The published artifact set on APIs.io includes an OpenAPI specification.

The Janssen Config API is the OAuth-protected administrative REST API for every Janssen Server and Gluu Flex component — clients, scopes, custom scripts, Agama flows, attributes, SMTP, persistence, logging, SAML and more. 133 operations across 78 paths in the core spec, plus seven plugin specs covering FIDO2, the Admin UI, user management, Jans Lock audit, metrics, Jans Link and SCIM config.

## Operations (60 of 133)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v1/health/app-version` | Returns application version |
| GET | `/api/v1/health` | Returns application health status |
| GET | `/api/v1/health/live` | Returns application liveness status |
| GET | `/api/v1/health/ready` | Returns application readiness status |
| GET | `/api/v1/health/server-stat` | Returns application server status |
| GET | `/api/v1/health/service-status` | Fetch service status |
| GET | `/api/v1/acrs` | Gets default authentication method. |
| PUT | `/api/v1/acrs` | Updates default authentication method. |
| GET | `/api/v1/agama-deployment/{name}` | Retrieve details of a single deployment by name. |
| POST | `/api/v1/agama-deployment/{name}` | Add or replace an Agama project to the server. |
| DELETE | `/api/v1/agama-deployment/{name}` | Undeploy an Agama project from the server. |
| GET | `/api/v1/agama-deployment/configs/{name}` | Retrieve the configurations associated to flows that belong to the project of interest. The project must have been already processed fully. |
| PUT | `/api/v1/agama-deployment/configs/{name}` | Set or replace the configurations associated to flows that belong to the project. The project must have been already processed fully. |
| GET | `/api/v1/agama-deployment` | Retrieve the list of projects deployed currently. |
| GET | `/api/v1/agama-repo/download` | Download agama project. |
| GET | `/api/v1/agama-repo` | Gets all agama repositories. |
| POST | `/api/v1/agama/syntax-check/{qname}` | Determine if the text passed is valid Agama code |
| GET | `/api/v1/jans-assets/{inum}` | Gets an asset by inum - unique identifier |
| DELETE | `/api/v1/jans-assets/{inum}` | Delete an asset |
| GET | `/api/v1/jans-assets/name/{name}` | Fetch asset by name |
| GET | `/api/v1/jans-assets/asset-dir-mapping` | Get valid asset types |
| GET | `/api/v1/jans-assets` | Gets all Jans assets. |
| GET | `/api/v1/jans-assets/services` | Gets asset services |
| GET | `/api/v1/jans-assets/asset-type` | Get valid asset types |
| POST | `/api/v1/jans-assets/service/{service-name}` | Load assets on server for a service |
| PUT | `/api/v1/jans-assets/upload` | Update existing asset |
| POST | `/api/v1/jans-assets/upload` | Upload new asset |
| GET | `/api/v1/attributes` | Gets a list of Jans attributes. |
| PUT | `/api/v1/attributes` | Updates an existing attribute |
| POST | `/api/v1/attributes` | Adds a new attribute |
| GET | `/api/v1/attributes/{inum}` | Gets an attribute based on inum |
| DELETE | `/api/v1/attributes/{inum}` | Deletes an attribute based on inum |
| PATCH | `/api/v1/attributes/{inum}` | Partially modify a JansAttribute |
| GET | `/api/v1/audit` | Get audit details. |
| GET | `/api/v1/jans-auth-server/config` | Gets all Jans authorization server configuration properties. |
| PATCH | `/api/v1/jans-auth-server/config` | Partially modifies Jans authorization server Application configuration properties. |
| GET | `/api/v1/jans-auth-server/config/feature-flags` | Returns feature flags type configured for Jans authorization server. |
| GET | `/api/v1/jans-auth-server/config/persistence` | Returns persistence type configured for Jans authorization server. |
| GET | `/api/v1/config/cache` | Returns cache configuration. |
| PATCH | `/api/v1/config/cache` | Patch cache configuration. |
| GET | `/api/v1/config/cache/in-memory` | Returns in-Memory cache configuration. |
| PUT | `/api/v1/config/cache/in-memory` | Updates in-Memory cache configuration. |
| PATCH | `/api/v1/config/cache/in-memory` | Patch In-Memory cache configuration. |
| GET | `/api/v1/config/cache/memcached` | Returns memcached cache configuration. |
| PUT | `/api/v1/config/cache/memcached` | Updates memcached cache configuration. |
| PATCH | `/api/v1/config/cache/memcached` | Patch memcached cache configuration. |
| GET | `/api/v1/config/cache/native-persistence` | Returns native persistence cache configuration. |
| PUT | `/api/v1/config/cache/native-persistence` | Updates native persistence cache configuration. |
| PATCH | `/api/v1/config/cache/native-persistence` | Patch native persistence cache configuration. |
| GET | `/api/v1/config/cache/redis` | Returns Redis cache configuration. |
| PUT | `/api/v1/config/cache/redis` | Updates Redis cache configuration. |
| PATCH | `/api/v1/config/cache/redis` | Patch Redis cache configuration. |
| DELETE | `/api/v1/clients/authorizations/{userId}/{clientId}/{username}` | Revoke client authorization |
| GET | `/api/v1/clients/authorizations/{userId}` | Gets list of client authorization |
| GET | `/api/v1/openid/clients` | Gets list of OpenID Connect clients |
| PUT | `/api/v1/openid/clients` | Update OpenId Connect client |
| POST | `/api/v1/openid/clients` | Create new OpenId Connect client |
| GET | `/api/v1/openid/clients/{inum}` | Get OpenId Connect Client by Inum |
| DELETE | `/api/v1/openid/clients/{inum}` | Delete OpenId Connect client |
| PATCH | `/api/v1/openid/clients/{inum}` | Patch OpenId Connect client |

…and 73 more operations. They are listed in full on the page.

## Machine-readable artifacts (11)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/gluu/refs/heads/main/openapi/gluu-jans-config-api-openapi.yml
- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/gluu/refs/heads/main/openapi/gluu-jans-config-api-admin-ui-plugin-openapi.yml
- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/gluu/refs/heads/main/openapi/gluu-jans-config-api-fido2-plugin-openapi.yml
- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/gluu/refs/heads/main/openapi/gluu-jans-config-api-user-mgt-plugin-openapi.yml
- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/gluu/refs/heads/main/openapi/gluu-jans-config-api-lock-plugin-openapi.yml
- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/gluu/refs/heads/main/openapi/gluu-jans-config-api-metric-plugin-openapi.yml
- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/gluu/refs/heads/main/openapi/gluu-jans-config-api-link-plugin-openapi.yml
- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/gluu/refs/heads/main/openapi/gluu-jans-config-api-scim-plugin-openapi.yml
- **OAuthScopes** — https://raw.githubusercontent.com/api-evangelist/gluu/refs/heads/main/scopes/gluu-scopes.yml
- **Webhooks** — https://raw.githubusercontent.com/api-evangelist/gluu/refs/heads/main/asyncapi/gluu-webhooks.yml
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/gluu/refs/heads/main/overlays/gluu-jans-config-api-overlay.yaml

## Other Gluu APIs (9)

- [Gluu Flex](https://apis.io/apis/gluu/gluu-flex/)
- [Gluu Solo](https://apis.io/apis/gluu/gluu-solo/)
- [Janssen Project](https://apis.io/apis/gluu/janssen-project/)
- [Janssen Auth Server API](https://apis.io/apis/gluu/jans-auth-server-api/)
- [Janssen SCIM API](https://apis.io/apis/gluu/jans-scim-api/)
- [Janssen FIDO2 API](https://apis.io/apis/gluu/jans-fido2-api/)
- [Janssen Lock API](https://apis.io/apis/gluu/jans-lock-api/)
- [Cedarling](https://apis.io/apis/gluu/cedarling/)
- [Agama Lab](https://apis.io/apis/gluu/agama-lab/)

## Tags

Administration, Configuration, IAM, Authentication

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/gluu/jans-config-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/gluu/.