Introduction
The JFrog Access service bundles an interactive Swagger UI and a downloadable OpenAPI (Swagger) specification that documents the Access REST API (users, groups, tokens, permissions, projects, federation, SCIM, certificates, system, and more). The Swagger UI is disabled by default as a security-hardening measure and can be enabled only in a self-hosted instance.
The interactive Swagger UI is served by the Access service under the /access/ context. It is controlled by the ‘security.disable-swagger-ui’ parameter in the Access configuration, which defaults to ‘true’ (disabled).
To enable the Swagger UI in the Access configuration
-
Navigate to: ‘$JFROG_HOME/artifactory/var/etc/access’
-
Copy the current configuration, i.e access.config.latest.yml, to a new backup import file. If ‘access.config.latest.yml’ does not exist, create ‘access.config.import.yml’ with only the block shown in the next step.
-
Edit ‘access.config.import.yml’ so the ‘security’ section contains:
security:
disable-swagger-ui: false
-
Restart the Artifactory instance for the changes to take effect.
Note:
When the import file is consumed on restart, the file access.config.import.yml is deleted, and the change is merged. Verify the changes in access.config.latest.yml.
Access the Swagger UI
Browse to: https://<JPD_URL>/access/api-docs/ (This redirects to /access/api-docs/index.html). When prompted for a JWT access token, paste a valid admin access token.
The "JFrog Access Server" API page loads and reads its specification from /access/api/swagger.json.
Alternatively, download the OpenAPI specification directly via the command below. The returned document is a Swagger 2.0 (OpenAPI 2.0) specification titled "JFrog Access Server" with base path ‘/access/api’.
# YAML
curl -H "Authorization: Bearer <ADMIN_ACCESS_TOKEN>" \
"https://<JPD_URL>/access/api/swagger.yaml" -o access-openapi.yaml
# JSON
curl -H "Authorization: Bearer <ADMIN_ACCESS_TOKEN>" \
"https://<JPD_URL>/access/api/swagger.json" -o access-openapi.json
Related References