Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

JFrog Security API

Users, groups, permissions, and access tokens

JFrog Security API is one of 53 APIs that JFrog publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Security. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, an API reference, and an engineering blog.

This API exposes 13 operations across 7 paths, and defines 7 schemas. It is described by OpenAPI 3.1.0, at version 2.x.

Requests are made against 2 base URLs: https://{server}.jfrog.io/access, https://{host}/access.

13 operations 7 paths 7 schemas 3 DELETE6 GET1 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.x
Base URL
https://myserver.jfrog.io/artifactory/api
Authentication
HTTP Bearer, HTTP Basic
Contact
Terms of Service
Resource Areas
1

Authentication & Security 2

JFrog Security API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • bearerAuth — Access token authentication
  • basicAuth — Basic username/password authentication

Paths & Operations 13

Across 7 paths, the API surfaces 13 operations — 3 DELETE, 6 GET, 1 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Security 13

Users, groups, permissions, and access tokens

GET
/api/security/users
JFrog List Users
listUsers → 200
GET
/api/security/users/{username}
JFrog Get User Details
getUser 1 param → 200404
PUT
/api/security/users/{username}
JFrog Create or Replace User
createOrReplaceUser 1 param body → 201200
DELETE
/api/security/users/{username}
JFrog Delete User
deleteUser 1 param → 200404
GET
/api/security/groups
JFrog List Groups
listGroups → 200
GET
/api/security/groups/{groupName}
JFrog Get Group Details
getGroup 1 param → 200
PUT
/api/security/groups/{groupName}
JFrog Create or Replace Group
createOrReplaceGroup 1 param body → 201200
DELETE
/api/security/groups/{groupName}
JFrog Delete Group
deleteGroup 1 param → 200
GET
/api/security/permissions
JFrog List Permission Targets
listPermissionTargets → 200
GET
/api/security/permissions/{permissionTargetName}
JFrog Get Permission Target
getPermissionTarget 1 param → 200
PUT
/api/security/permissions/{permissionTargetName}
JFrog Create or Replace Permission Target
createOrReplacePermissionTarget 1 param body → 200
DELETE
/api/security/permissions/{permissionTargetName}
JFrog Delete Permission Target
deletePermissionTarget 1 param → 200
POST
/api/security/token
JFrog Create Access Token
createToken body → 200

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are User (8 properties), Group (7 properties), AccessToken (5 properties), UserSummary (4 properties). Each schema is shown below with its type and property counts.

Group
object
7 properties 1 required
AccessToken
object
5 properties
PermissionTargetSummary
object
2 properties
GroupSummary
object
2 properties
PermissionTarget
object
3 properties
User
object
8 properties 3 required
UserSummary
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jfrog-security-api-openapi.yml Raw ↑

Other APIs JFrog publishes across the network.

JFrog Access Tokens API
JFrog Artifacts & Storage API
JFrog Audit API
JFrog Builds API
JFrog Commands API
JFrog Components API
JFrog Deployments API
JFrog Device Groups API
JFrog Devices API
JFrog Distribution API
JFrog Evidence API
JFrog Execution API