JFrog Security API

Users, groups, permissions, and access tokens

Business capability
Identity & Access Management BC-620.20

Operations 13

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/security/users List all Artifactory users · JFrog List Users #
Ask an LLM
“Who are all the users set up in my Artifactory instance?”
“Can I pull a full list of Artifactory user accounts from the security API?”
Tell an agent
List every user in Artifactory security.
Show me all Artifactory user accounts.
GET /api/security/users/{username} Get an Artifactory user's details · JFrog Get User Details #
Ask an LLM
“What groups and admin rights does a given Artifactory user have?”
“How can I look up one Artifactory user's email and settings?”
Tell an agent
Show the Artifactory details for user {username}.
Look up whether {username} is an Artifactory admin.
PUT /api/security/users/{username} Create or replace an Artifactory user · JFrog Create or Replace User #
Ask an LLM
“How do I add a new user to Artifactory with a password and email?”
“Can I overwrite an existing Artifactory user's whole definition in one call?”
Tell an agent
Create Artifactory user {username} with email {email} and password {password}.
Replace Artifactory user {username}, display name {name}, email {email}, password {password}, in groups {groups}.
DELETE /api/security/users/{username} Delete an Artifactory user · JFrog Delete User #
Ask an LLM
“How do I remove a user account from Artifactory security?”
“What happens when I delete a user through the Artifactory security endpoint?”
Tell an agent destructive · confirm first
Delete Artifactory user {username}.
Remove {username} from Artifactory security users.
GET /api/security/groups List all Artifactory groups · JFrog List Groups #
Ask an LLM
“Which user groups exist in my Artifactory instance?”
“Can I see every security group defined in Artifactory?”
Tell an agent
List all Artifactory groups.
Show me every security group in Artifactory.
GET /api/security/groups/{groupName} Get an Artifactory group's details · JFrog Get Group Details #
Ask an LLM
“What realm and auto-join settings does an Artifactory group have?”
“How do I see who belongs to a specific Artifactory group?”
Tell an agent
Show the details of Artifactory group {groupName}.
List the members of group {groupName}.
PUT /api/security/groups/{groupName} Create or replace an Artifactory group · JFrog Create or Replace Group #
Ask an LLM
“How do I create a group that new users join automatically?”
“Can I give an entire group admin privileges when I define it?”
Tell an agent
Create group {groupName} named {name} with description {description}.
Replace group {groupName} so its members are {userNames}.
DELETE /api/security/groups/{groupName} Delete an Artifactory group · JFrog Delete Group #
Ask an LLM
“How do I get rid of a security group I no longer use?”
“Is there a way to delete an Artifactory group by name?”
Tell an agent destructive · confirm first
Delete Artifactory group {groupName}.
Remove the {groupName} group from security.
GET /api/security/permissions List Artifactory permission targets · JFrog List Permission Targets #
Ask an LLM
“What permission targets are configured in Artifactory?”
“Can I list the access rules that cover my repositories and builds?”
Tell an agent
List all Artifactory permission targets.
Show every permission target in the security API.
GET /api/security/permissions/{permissionTargetName} Get a permission target's configuration · JFrog Get Permission Target #
Ask an LLM
“Which repositories and users does a given permission target cover?”
“How do I inspect the rules inside one Artifactory permission target?”
Tell an agent
Show permission target {permissionTargetName}.
Get the repo and build rules of permission target {permissionTargetName}.
PUT /api/security/permissions/{permissionTargetName} Create or replace a permission target · JFrog Create or Replace Permission Target #
Ask an LLM
“How do I grant a group access to certain repositories in Artifactory?”
“Can I overwrite a permission target's repo and build rules at once?”
Tell an agent
Create permission target {permissionTargetName} with repo rules {repo}.
Replace permission target {permissionTargetName} with build rules {build}.
DELETE /api/security/permissions/{permissionTargetName} Delete a permission target · JFrog Delete Permission Target #
Ask an LLM
“How do I remove an Artifactory permission target?”
“Will deleting a permission target revoke the access it granted?”
Tell an agent destructive · confirm first
Delete permission target {permissionTargetName}.
Remove the {permissionTargetName} permission target from Artifactory.
POST /api/security/token Create an Artifactory access token · JFrog Create Access Token #
Ask an LLM
“How do I generate an access token for a user through the security endpoint?”
“Can I make a refreshable token that expires after a set time?”
Tell an agent
Create an access token for {username} that expires in {expires_in} seconds.
Issue a refreshable token for {username} with scope {scope}.

Documentation

📖
Documentation
https://www.jfrog.com/confluence/display/JFROG/Artifactory+REST+API
📖
Authentication
https://www.jfrog.com/confluence/display/JFROG/Access+Tokens
📖
GettingStarted
https://jfrog.com/help/r/jfrog-artifactory-documentation/use-the-rest-api
📖
Documentation
https://jfrog.com/help/r/jfrog-rest-apis/artifactory-rest-api-v2
📖
Authentication
https://jfrog.com/help/r/jfrog-platform-administration-documentation/access-tokens
📖
Documentation
https://www.jfrog.com/confluence/display/JFROG/Xray+REST+API
📖
GettingStarted
https://jfrog.com/help/r/xray-rest-apis/introduction-to-the-xray-rest-apis
📖
Documentation
https://www.jfrog.com/confluence/display/JFROG/Distribution+REST+API
📖
Documentation
https://www.jfrog.com/confluence/display/JFROG/Pipelines+REST+API
📖
GettingStarted
https://jfrog.com/help/r/jfrog-rest-apis/introduction-to-the-pipelines-rest-apis
📖
Documentation
https://www.jfrog.com/confluence/display/JFROG/JFrog+Platform+REST+API
📖
GettingStarted
https://jfrog.com/help/r/jfrog-rest-apis/introduction-to-the-jfrog-platform-rest-apis
📖
Documentation
https://jfrog.com/help/r/jfrog-platform-administration-documentation/access-token-rest-api
📖
GettingStarted
https://jfrog.com/help/r/jfrog-platform-administration-documentation/introduction-to-access-tokens
📖
Documentation
https://jfrog.com/help/r/jfrog-rest-apis/jfrog-curation-rest-apis
📖
Documentation
https://jfrog.com/help/r/jfrog-rest-apis/mission-control-rest-apis
📖
Documentation
https://jfrog.com/help/r/jfrog-rest-apis/release-lifecycle-management
📖
Documentation
https://jfrog.com/help/r/jfrog-rest-apis/workers-rest-apis
📖
Documentation
https://jfrog.com/help/r/jfrog-ml-documentation/jfrog-ml-rest-api
📖
Documentation
https://docs.connect.jfrog.io/rest-api-v2/connect-api-reference
📖
Authentication
https://docs.connect.jfrog.io/developers
📖
Documentation
https://jfrog.com/help/r/jfrog-security-user-guide/products/catalog
📖
Documentation
https://jfrog.com/help/r/jfrog-artifactory-documentation/create-evidence-using-rest-apis

Specifications

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/jfrog:jfrog-security-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

jfrog-security-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: JFrog Artifactory REST Security API
  description: REST API for managing artifacts, repositories, security, and system configuration in JFrog Artifactory. Artifactory is a universal binary repository manager that integrates with all major CI/CD and DevOps tools to provide an end-to-end automated solution for tracking artifacts from development to production.
  version: 7.x
  contact:
    name: JFrog
    url: https://jfrog.com
  license:
    name: Proprietary
    url: https://jfrog.com/terms-of-service/
  termsOfService: https://jfrog.com/terms-of-service/
servers:
- url: https://{server}.jfrog.io/artifactory
  description: JFrog Cloud
  variables:
    server:
      default: myserver
      description: Your JFrog server name
- url: https://{host}/artifactory
  description: Self-hosted JFrog instance
  variables:
    host:
      default: localhost:8082
      description: Your self-hosted JFrog server host
security:
- bearerAuth: []
- apiKeyAuth: []
- basicAuth: []
tags:
- name: Security
  description: Users, groups, permissions, and access tokens
paths:
  /api/security/users:
    get:
      operationId: listUsers
      summary: JFrog List Users
      description: Returns a list of all users.
      tags:
      - Security
      responses:
        '200':
          description: Users list retrieved
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserSummary'
  /api/security/users/{username}:
    get:
      operationId: getUser
      summary: JFrog Get User Details
      description: Returns details for a specific user.
      tags:
      - Security
      parameters:
      - name: username
        in: path
        required: true
        schema:
          type: string
        description: Username
      responses:
        '200':
          description: User details retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '404':
          description: User not found
    put:
      operationId: createOrReplaceUser
      summary: JFrog Create or Replace User
      description: Creates a new user or replaces an existing user.
      tags:
      - Security
      parameters:
      - name: username
        in: path
        required: true
        schema:
          type: string
        description: Username
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User'
      responses:
        '201':
          description: User created
        '200':
          description: User replaced
    delete:
      operationId: deleteUser
      summary: JFrog Delete User
      description: Removes a user.
      tags:
      - Security
      parameters:
      - name: username
        in: path
        required: true
        schema:
          type: string
        description: Username
      responses:
        '200':
          description: User deleted
        '404':
          description: User not found
  /api/security/groups:
    get:
      operationId: listGroups
      summary: JFrog List Groups
      description: Returns a list of all groups.
      tags:
      - Security
      responses:
        '200':
          description: Groups list retrieved
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GroupSummary'
  /api/security/groups/{groupName}:
    get:
      operationId: getGroup
      summary: JFrog Get Group Details
      description: Returns details for a specific group.
      tags:
      - Security
      parameters:
      - name: groupName
        in: path
        required: true
        schema:
          type: string
        description: Group name
      responses:
        '200':
          description: Group details retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
    put:
      operationId: createOrReplaceGroup
      summary: JFrog Create or Replace Group
      description: Creates a new group or replaces an existing group.
      tags:
      - Security
      parameters:
      - name: groupName
        in: path
        required: true
        schema:
          type: string
        description: Group name
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Group'
      responses:
        '201':
          description: Group created
        '200':
          description: Group replaced
    delete:
      operationId: deleteGroup
      summary: JFrog Delete Group
      description: Removes a group.
      tags:
      - Security
      parameters:
      - name: groupName
        in: path
        required: true
        schema:
          type: string
        description: Group name
      responses:
        '200':
          description: Group deleted
  /api/security/permissions:
    get:
      operationId: listPermissionTargets
      summary: JFrog List Permission Targets
      description: Returns a list of all permission targets.
      tags:
      - Security
      responses:
        '200':
          description: Permission targets list retrieved
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PermissionTargetSummary'
  /api/security/permissions/{permissionTargetName}:
    get:
      operationId: getPermissionTarget
      summary: JFrog Get Permission Target
      description: Returns configuration details for a specific permission target.
      tags:
      - Security
      parameters:
      - name: permissionTargetName
        in: path
        required: true
        schema:
          type: string
        description: Permission target name
      responses:
        '200':
          description: Permission target details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermissionTarget'
    put:
      operationId: createOrReplacePermissionTarget
      summary: JFrog Create or Replace Permission Target
      description: Creates a new or replaces an existing permission target.
      tags:
      - Security
      parameters:
      - name: permissionTargetName
        in: path
        required: true
        schema:
          type: string
        description: Permission target name
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PermissionTarget'
      responses:
        '200':
          description: Permission target created/replaced
    delete:
      operationId: deletePermissionTarget
      summary: JFrog Delete Permission Target
      description: Removes a permission target.
      tags:
      - Security
      parameters:
      - name: permissionTargetName
        in: path
        required: true
        schema:
          type: string
        description: Permission target name
      responses:
        '200':
          description: Permission target deleted
  /api/security/token:
    post:
      operationId: createToken
      summary: JFrog Create Access Token
      description: Creates a new access token for authentication.
      tags:
      - Security
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                username:
                  type: string
                  description: The user to create the token for
                scope:
                  type: string
                  description: The scope of the token
                expires_in:
                  type: integer
                  description: Token expiry in seconds (0 for non-expiring)
                refreshable:
                  type: boolean
                  description: Whether the token is refreshable
      responses:
        '200':
          description: Token created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessToken'
components:
  schemas:
    Group:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        autoJoin:
          type: boolean
        adminPrivileges:
          type: boolean
        realm:
          type: string
        realmAttributes:
          type: string
        userNames:
          type: array
          items:
            type: string
      required:
      - name
    AccessToken:
      type: object
      properties:
        access_token:
          type: string
        expires_in:
          type: integer
        scope:
          type: string
        token_type:
          type: string
          example: Bearer
        refresh_token:
          type: string
    PermissionTargetSummary:
      type: object
      properties:
        name:
          type: string
        uri:
          type: string
          format: uri
    PermissionTarget:
      type: object
      properties:
        name:
          type: string
        repo:
          type: object
          properties:
            repositories:
              type: array
              items:
                type: string
            actions:
              type: object
              properties:
                users:
                  type: object
                  additionalProperties:
                    type: array
                    items:
                      type: string
                groups:
                  type: object
                  additionalProperties:
                    type: array
                    items:
                      type: string
            includePatterns:
              type: array
              items:
                type: string
            excludePatterns:
              type: array
              items:
                type: string
        build:
          type: object
          properties:
            repositories:
              type: array
              items:
                type: string
            actions:
              type: object
              properties:
                users:
                  type: object
                  additionalProperties:
                    type: array
                    items:
                      type: string
                groups:
                  type: object
                  additionalProperties:
                    type: array
                    items:
                      type: string
    GroupSummary:
      type: object
      properties:
        name:
          type: string
        uri:
          type: string
          format: uri
    UserSummary:
      type: object
      properties:
        name:
          type: string
        uri:
          type: string
          format: uri
        realm:
          type: string
        status:
          type: string
    User:
      type: object
      properties:
        name:
          type: string
        email:
          type: string
          format: email
        password:
          type: string
        admin:
          type: boolean
        profileUpdatable:
          type: boolean
        disableUIAccess:
          type: boolean
        internalPasswordDisabled:
          type: boolean
        groups:
          type: array
          items:
            type: string
      required:
      - name
      - email
      - password
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Access token authentication
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-JFrog-Art-Api
      description: API key authentication
    basicAuth:
      type: http
      scheme: basic
      description: Basic username/password authentication
externalDocs:
  description: JFrog Artifactory REST API Documentation
  url: https://jfrog.com/help/r/jfrog-rest-apis/artifactory-rest-apis