JFrog Permissions API

Permission target management

Operations 10

GET /api/v2/permissions JFrog List Permissions #
POST /api/v2/permissions JFrog Create Permission #
GET /api/v2/permissions/{permissionName} JFrog Get Permission #
PUT /api/v2/permissions/{permissionName} JFrog Update Permission #
DELETE /api/v2/permissions/{permissionName} JFrog Delete Permission #
GET /access/api/v2/permissions JFrog List Permissions #
POST /access/api/v2/permissions JFrog Create Permission #
GET /access/api/v2/permissions/{permissionName} JFrog Get Permission #
PUT /access/api/v2/permissions/{permissionName} JFrog Update Permission #
DELETE /access/api/v2/permissions/{permissionName} JFrog Delete Permission #

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-permissions-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-permissions-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Jfrog Permissions API
  version: 2.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/
  description: 'Operations tagged Permissions across 2 of this provider''s published API definitions: jfrog-access-openapi.yml, jfrog-platform-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{server}.jfrog.io/access
  description: JFrog Cloud
  variables:
    server:
      default: myserver
      description: Your JFrog server name
- url: https://{host}/access
  description: Self-hosted JFrog instance
  variables:
    host:
      default: localhost:8082
      description: Your self-hosted JFrog server host
- url: https://{server}.jfrog.io
  description: JFrog Cloud
  variables:
    server:
      default: myserver
      description: Your JFrog server name
- url: https://{host}
  description: Self-hosted JFrog instance
  variables:
    host:
      default: localhost:8082
      description: Your self-hosted JFrog server host
security:
- bearerAuth: []
- basicAuth: []
tags:
- name: Permissions
  description: Permission target management
paths:
  /api/v2/permissions:
    get:
      operationId: listPermissions
      summary: JFrog List Permissions
      description: Returns a list of all permission targets configured in the platform.
      tags:
      - Permissions
      responses:
        '200':
          description: Permissions list retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  permissions:
                    type: array
                    items:
                      $ref: '#/components/schemas/Permission'
    post:
      operationId: createPermission
      summary: JFrog Create Permission
      description: Creates a new permission target defining access control rules for repositories, builds, and release bundles.
      tags:
      - Permissions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Permission'
      responses:
        '201':
          description: Permission created
        '400':
          description: Invalid permission configuration
        '409':
          description: Permission already exists
    servers:
    - url: https://{server}.jfrog.io/access
      description: JFrog Cloud
      variables:
        server:
          default: myserver
          description: Your JFrog server name
    - url: https://{host}/access
      description: Self-hosted JFrog instance
      variables:
        host:
          default: localhost:8082
          description: Your self-hosted JFrog server host
  /api/v2/permissions/{permissionName}:
    get:
      operationId: getPermission
      summary: JFrog Get Permission
      description: Returns the full configuration of a specific permission target.
      tags:
      - Permissions
      parameters:
      - name: permissionName
        in: path
        required: true
        schema:
          type: string
        description: Permission name
      responses:
        '200':
          description: Permission details retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Permission'
        '404':
          description: Permission not found
    put:
      operationId: updatePermission
      summary: JFrog Update Permission
      description: Replaces the full configuration of an existing permission target.
      tags:
      - Permissions
      parameters:
      - name: permissionName
        in: path
        required: true
        schema:
          type: string
        description: Permission name
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Permission'
      responses:
        '200':
          description: Permission updated
        '404':
          description: Permission not found
    delete:
      operationId: deletePermission
      summary: JFrog Delete Permission
      description: Removes a permission target and all its access control rules.
      tags:
      - Permissions
      parameters:
      - name: permissionName
        in: path
        required: true
        schema:
          type: string
        description: Permission name
      responses:
        '204':
          description: Permission deleted
        '404':
          description: Permission not found
    servers:
    - url: https://{server}.jfrog.io/access
      description: JFrog Cloud
      variables:
        server:
          default: myserver
          description: Your JFrog server name
    - url: https://{host}/access
      description: Self-hosted JFrog instance
      variables:
        host:
          default: localhost:8082
          description: Your self-hosted JFrog server host
  /access/api/v2/permissions:
    get:
      operationId: listPermissions
      summary: JFrog List Permissions
      description: Returns a list of all permission configurations.
      tags:
      - Permissions
      responses:
        '200':
          description: Permissions list
          content:
            application/json:
              schema:
                type: object
                properties:
                  permissions:
                    type: array
                    items:
                      $ref: '#/components/schemas/Permission_2'
    post:
      operationId: createPermission
      summary: JFrog Create Permission
      description: Creates a new permission configuration.
      tags:
      - Permissions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Permission_2'
      responses:
        '201':
          description: Permission created
    servers:
    - url: https://{server}.jfrog.io
      description: JFrog Cloud
      variables:
        server:
          default: myserver
          description: Your JFrog server name
    - url: https://{host}
      description: Self-hosted JFrog instance
      variables:
        host:
          default: localhost:8082
          description: Your self-hosted JFrog server host
  /access/api/v2/permissions/{permissionName}:
    get:
      operationId: getPermission
      summary: JFrog Get Permission
      description: Returns details for a specific permission.
      tags:
      - Permissions
      parameters:
      - name: permissionName
        in: path
        required: true
        schema:
          type: string
        description: Permission name
      responses:
        '200':
          description: Permission details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Permission_2'
    put:
      operationId: updatePermission
      summary: JFrog Update Permission
      description: Updates a permission configuration.
      tags:
      - Permissions
      parameters:
      - name: permissionName
        in: path
        required: true
        schema:
          type: string
        description: Permission name
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Permission_2'
      responses:
        '200':
          description: Permission updated
    delete:
      operationId: deletePermission
      summary: JFrog Delete Permission
      description: Deletes a permission configuration.
      tags:
      - Permissions
      parameters:
      - name: permissionName
        in: path
        required: true
        schema:
          type: string
        description: Permission name
      responses:
        '204':
          description: Permission deleted
    servers:
    - url: https://{server}.jfrog.io
      description: JFrog Cloud
      variables:
        server:
          default: myserver
          description: Your JFrog server name
    - url: https://{host}
      description: Self-hosted JFrog instance
      variables:
        host:
          default: localhost:8082
          description: Your self-hosted JFrog server host
components:
  schemas:
    Permission:
      type: object
      properties:
        name:
          type: string
          description: Unique permission target name
        resources:
          type: object
          description: Resource-level access control definitions
          properties:
            repository:
              type: object
              description: Repository-level permissions
              additionalProperties:
                type: object
                properties:
                  include_patterns:
                    type: array
                    items:
                      type: string
                  exclude_patterns:
                    type: array
                    items:
                      type: string
                  actions:
                    type: object
                    properties:
                      users:
                        type: object
                        additionalProperties:
                          type: array
                          items:
                            type: string
                            enum:
                            - read
                            - write
                            - annotate
                            - delete
                            - manage
                            - managedXrayMeta
                            - distribute
                      groups:
                        type: object
                        additionalProperties:
                          type: array
                          items:
                            type: string
            build:
              type: object
              description: Build-level permissions
              additionalProperties:
                type: object
                properties:
                  include_patterns:
                    type: array
                    items:
                      type: string
                  exclude_patterns:
                    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
            releaseBundle:
              type: object
              description: Release bundle-level permissions
              additionalProperties:
                type: object
      required:
      - name
    Permission_2:
      type: object
      properties:
        name:
          type: string
        resources:
          type: object
          properties:
            repository:
              type: object
              additionalProperties:
                type: object
                properties:
                  include_patterns:
                    type: array
                    items:
                      type: string
                  exclude_patterns:
                    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
            build:
              type: object
              additionalProperties:
                type: object
      required:
      - name
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Access token authentication
    basicAuth:
      type: http
      scheme: basic
      description: Basic username/password authentication
x-refined-from:
- jfrog-access-openapi.yml
- jfrog-platform-openapi.yml