Skip to main content

JFrog Artifactory

JFrog Artifactory is an application security tool that manages and tracks your artifacts throughout the development lifecycle. You can bring file, folder, project, repository, and user data from JFrog Artifactory into Brinqa to gain insights into the security and compliance of your software components to construct a detailed view of your application environment.

This document details the information you must provide for the connector to authenticate with JFrog Artifactory and how to obtain that information from JFrog. See create a data integration for step-by-step instructions on setting up the integration.

Required connection settings

When setting up a data integration, select JFrog Artifactory from the Connector drop-down. If you cannot find the connector in the drop-down, make sure that you have installed it first. You must provide the following information to authenticate JFrog Artifactory with Brinqa:

  • API URL: The JFrog API server URL.

  • Access token: The JFrog access token associated with the JFrog account, which must have permissions to log in to the API server and return data.

Generate a JFrog access token

For the JFrog Artifactory connector to use the JFrog API, you must provide an access token. JFrog does not allow retrieving the access token for an existing user. To generate a new token, follow these steps:

  1. Log in to your organization's JFrog server as an administrator.

  2. Click Platform configuration > User Management.

  3. Click Access Tokens.

  4. Click Generate Token, select Scoped Token, and then complete the following fields:

    • Description: Provide a description for the token.

    • Token scope: Click the drop-down and select the appropriate scope for your integration. You have three options:

      • Admin: Grants full administrative access. Use this option if retrieving your data requires complete control over all aspects of Artifactory. Proceed with caution, as this option provides extensive permissions.

      • User: Grants access based on a specific user's permissions. Use this option if retrieving your data requires performing actions that a typical user would require.

      • Group: Grants access based on a group of users' permissions. Use this option if retrieving your data needs permissions common to a specific group.

      note

      While all three options can be used to authenticate API requests, Brinqa recommends that you use the User or Group scope, as these can provide more controlled access. Consult the JFrog documentation to better understand which scope may better suit your needs.

    • Service: Click the drop-down and select Artifactory.

    • Expiration time: If desired, click the drop-down and set an expiry for the token. Options include: Never, 1 day, 3 days, 1 week, 1 month, or a custom time.

    • Create reference token: Not checked by default. Leave as is.

  5. Click Generate.

    A window displays with your access token. You cannot view the token after this, so copy the token and save it to a secure location.

note

For additional information on access tokens and permissions, see JFrog documentation.

Types of data to retrieve

The JFrog Artifactory connector can retrieve the following types of data from the JFrog Artifactory API:

Table 1: Data retrieved from JFrog Artifactory

Connector ObjectRequiredMaps to Data Model
FileNoNot mapped
ProjectYesCode Project
RepositoryYesCode Repository
UserNoNot mapped
info

The JFrog Artifactory connector does not currently support operation options for the types of data it retrieves.

For detailed steps on how to view the data retrieved from JFrog Artifactory in the Brinqa Platform, see How to view your data.

Attribute mappings

Click the tabs below to view the mappings between the source and the Brinqa data model attributes.

Table 2: Project attribute mappings

Source Field NameMaps to Attribute
descriptiondescription
display_namename
soft_limitLocal variable
storage_quota_bytesLocal variable
storage_quota_email_notificationLocal variable
sys_iduid
info

Local variable indicates that the field is processed within a specific context, such as a particular workflow or calculation. Unlike other attributes, local variables aren't mapped to the unified data models. They only exist on the source data model.

APIs

The JFrog Artifactory connector uses the Artifactory REST API. Specifically, it uses the following endpoints:

Table 4: JFrog Artifactory REST API Endpoints

Connector ObjectAPI Endpoints
FileGET /artifactory/api/storage/{repo}/{path}
ProjectGET /access/api/v1/projects
RepositoryGET /artifactory/api/repositories
UserGET /artifactory/api/security/users

Changelog

The JFrog Artifactory connector has undergone the following changes:

3.0.0