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 Artifactory Security API

Users, groups, permissions, and tokens

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

This API exposes 4 JSON Schema definitions.

Tagged areas include Security. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, code examples, and 4 JSON Schemas.

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

Requests are made against a single base URL, https://{server}/artifactory.

16 operations 8 paths 8 schemas 4 DELETE7 GET1 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
7.x
Base URL
https://artifactory.example.com/artifactory/api
Authentication
HTTP Bearer, API Key, HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 3

JFrog Artifactory Security API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). An API key is passed in the header as X-JFrog-Art-Api (ApiKeyAuth). It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

  • BearerAuth — Access token authentication
  • ApiKeyAuth — API key authentication via header
  • BasicAuth — HTTP Basic authentication

Paths & Operations 16

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

Security 16

Users, groups, permissions, and tokens

GET
/api/security/users
JFrog Artifactory List Users
listUsers → 200401403
GET
/api/security/users/{username}
JFrog Artifactory Get User Details
getUser 1 param → 200401404
PUT
/api/security/users/{username}
JFrog Artifactory Create or Replace User
createOrReplaceUser 1 param body → 201200400401
DELETE
/api/security/users/{username}
JFrog Artifactory Delete User
deleteUser 1 param → 200401404
GET
/api/security/groups
JFrog Artifactory List Groups
listGroups → 200401
GET
/api/security/groups/{groupName}
JFrog Artifactory Get Group Details
getGroup 1 param → 200401404
PUT
/api/security/groups/{groupName}
JFrog Artifactory Create or Replace Group
createOrReplaceGroup 1 param body → 201200400401
DELETE
/api/security/groups/{groupName}
JFrog Artifactory Delete Group
deleteGroup 1 param → 200401404
GET
/api/security/permissions
JFrog Artifactory List Permission Targets
listPermissionTargets → 200401
GET
/api/security/permissions/{permissionName}
JFrog Artifactory Get Permission Target
getPermissionTarget 1 param → 200401404
PUT
/api/security/permissions/{permissionName}
JFrog Artifactory Create or Replace Permission Target
createOrReplacePermissionTarget 1 param body → 201200400401
DELETE
/api/security/permissions/{permissionName}
JFrog Artifactory Delete Permission Target
deletePermissionTarget 1 param → 200401404
POST
/api/security/token
JFrog Artifactory Create Access Token
createAccessToken body → 200400401
GET
/api/security/apiKey
JFrog Artifactory Get API Key
getApiKey → 200401
PUT
/api/security/apiKey
JFrog Artifactory Create API Key
createApiKey → 201401
DELETE
/api/security/apiKey
JFrog Artifactory Revoke API Key
revokeApiKey → 200401

Schemas 8

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

PermissionTargetListItem
object
2 properties
UserListItem
object
4 properties
Group
object
8 properties
AccessToken
object
5 properties
ErrorResponse
object
1 property
GroupListItem
object
2 properties
PermissionTarget
object
3 properties
User
object
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

artifactory-security-api-openapi.yml Raw ↑

Other APIs JFrog Artifactory publishes across the network.

JFrog Artifactory AQL Search API
JFrog Artifactory Artifactory Extensions API
JFrog Artifactory Artifacts & Storage API
JFrog Artifactory Base API
JFrog Artifactory Blobs API
JFrog Artifactory Build Diff API
JFrog Artifactory Build Info API
JFrog Artifactory Build Management API
JFrog Artifactory Build Promotion API
JFrog Artifactory Catalog API
JFrog Artifactory Manifests API
JFrog Artifactory Replication API