Platform Provider

platform 2.2.1 published on Friday, Mar 7, 2025 by jfrog

Generate Provider

The Platform provider must be installed as a Local Package by following the instructions for Any Terraform Provider:

pulumi package add terraform-provider jfrog/platform

Overview

The JFrog Platform provider is used to interact with the features from JFrog Platform REST API. The provider needs to be configured with the proper credentials before it can be used.

Links to documentation for specific resources can be found in the table of contents to the left.

This provider requires access to JFrog Platform APIs, which are only available in the licensed pro and enterprise editions. You can determine which license you have by accessing the following URL ${host}/artifactory/api/system/licenses/

You can either access it via API, or web browser - it requires admin level credentials.

curl -sL ${host}/artifactory/api/system/licenses/ | jq .
{
  "type" : "Enterprise Plus Trial",
  "validThrough" : "Jan 29, 2022",
  "licensedTo" : "JFrog Ltd"
}

Example Usage

# Pulumi.yaml provider configuration file
name: configuration-example
runtime: nodejs
config:
    artifactory:url:
        value: 'TODO: "${var.jfrog_url}"'
    platform:url:
        value: 'TODO: "${var.jfrog_url}"'

import * as pulumi from "@pulumi/pulumi";
import * as artifactory from "@pulumi/artifactory";
import * as platform from "@pulumi/platform";

const config = new pulumi.Config();
const jfrogUrl = config.get("jfrogUrl") || "http://localhost:8081";
const my_global_role = new platform.index/globalRole.GlobalRole("my-global-role", {
    name: "my-global-role",
    description: "Test description",
    type: "CUSTOM_GLOBAL",
    environments: ["DEV"],
    actions: [
        "READ_REPOSITORY",
        "READ_BUILD",
    ],
});
const my_generic_local = new artifactory.index.LocalGenericRepository("my-generic-local", {key: "my-generic-local"});
const my_workers_service = new platform.index/workersService.WorkersService("my-workers-service", {
    key: "my-workers-service",
    enabled: true,
    description: "My workers service",
    sourceCode: "export default async (context: PlatformContext, data: BeforeDownloadRequest): Promise<BeforeDownloadResponse> => { console.log(await context.clients.platformHttp.get('/artifactory/api/system/ping')); console.log(await axios.get('https://my.external.resource')); return { status: 'DOWNLOAD_PROCEED', message: 'proceed', } }",
    action: "BEFORE_DOWNLOAD",
    filterCriteria: {
        artifactFilterCriteria: {
            repoKeys: [my_generic_local.key],
        },
    },
    secrets: [
        {
            key: "my-secret-key-1",
            value: "my-secret-value-1",
        },
        {
            key: "my-secret-key-2",
            value: "my-secret-value-2",
        },
    ],
});

# Pulumi.yaml provider configuration file
name: configuration-example
runtime: python
config:
    artifactory:url:
        value: 'TODO: "${var.jfrog_url}"'
    platform:url:
        value: 'TODO: "${var.jfrog_url}"'

import pulumi
import pulumi_artifactory as artifactory
import pulumi_platform as platform

config = pulumi.Config()
jfrog_url = config.get("jfrogUrl")
if jfrog_url is None:
    jfrog_url = "http://localhost:8081"
my_global_role = platform.index.global_role.GlobalRole("my-global-role",
    name=my-global-role,
    description=Test description,
    type=CUSTOM_GLOBAL,
    environments=[DEV],
    actions=[
        READ_REPOSITORY,
        READ_BUILD,
    ])
my_generic_local = artifactory.index.LocalGenericRepository("my-generic-local", key=my-generic-local)
my_workers_service = platform.index.workers_service.WorkersService("my-workers-service",
    key=my-workers-service,
    enabled=True,
    description=My workers service,
    source_code=export default async (context: PlatformContext, data: BeforeDownloadRequest): Promise<BeforeDownloadResponse> => { console.log(await context.clients.platformHttp.get('/artifactory/api/system/ping')); console.log(await axios.get('https://my.external.resource')); return { status: 'DOWNLOAD_PROCEED', message: 'proceed', } },
    action=BEFORE_DOWNLOAD,
    filter_criteria={
        artifactFilterCriteria: {
            repoKeys: [my_generic_local.key],
        },
    },
    secrets=[
        {
            key: my-secret-key-1,
            value: my-secret-value-1,
        },
        {
            key: my-secret-key-2,
            value: my-secret-value-2,
        },
    ])

# Pulumi.yaml provider configuration file
name: configuration-example
runtime: dotnet
config:
    artifactory:url:
        value: 'TODO: "${var.jfrog_url}"'
    platform:url:
        value: 'TODO: "${var.jfrog_url}"'

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Artifactory = Pulumi.Artifactory;
using Platform = Pulumi.Platform;

return await Deployment.RunAsync(() =>
{
    var config = new Config();
    var jfrogUrl = config.Get("jfrogUrl") ?? "http://localhost:8081";
    var my_global_role = new Platform.Index.GlobalRole.GlobalRole("my-global-role", new()
    {
        Name = "my-global-role",
        Description = "Test description",
        Type = "CUSTOM_GLOBAL",
        Environments = new[]
        {
            "DEV",
        },
        Actions = new[]
        {
            "READ_REPOSITORY",
            "READ_BUILD",
        },
    });

    var my_generic_local = new Artifactory.Index.LocalGenericRepository("my-generic-local", new()
    {
        Key = "my-generic-local",
    });

    var my_workers_service = new Platform.Index.WorkersService.WorkersService("my-workers-service", new()
    {
        Key = "my-workers-service",
        Enabled = true,
        Description = "My workers service",
        SourceCode = "export default async (context: PlatformContext, data: BeforeDownloadRequest): Promise<BeforeDownloadResponse> => { console.log(await context.clients.platformHttp.get('/artifactory/api/system/ping')); console.log(await axios.get('https://my.external.resource')); return { status: 'DOWNLOAD_PROCEED', message: 'proceed', } }",
        Action = "BEFORE_DOWNLOAD",
        FilterCriteria =
        {
            { "artifactFilterCriteria",
            {
                { "repoKeys", new[]
                {
                    my_generic_local.Key,
                } },
            } },
        },
        Secrets = new[]
        {

            {
                { "key", "my-secret-key-1" },
                { "value", "my-secret-value-1" },
            },

            {
                { "key", "my-secret-key-2" },
                { "value", "my-secret-value-2" },
            },
        },
    });

});

# Pulumi.yaml provider configuration file
name: configuration-example
runtime: go
config:
    artifactory:url:
        value: 'TODO: "${var.jfrog_url}"'
    platform:url:
        value: 'TODO: "${var.jfrog_url}"'

package main

import (
	"github.com/pulumi/pulumi-artifactory/sdk/go/artifactory"
	"github.com/pulumi/pulumi-platform/sdk/go/platform"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		jfrogUrl := "http://localhost:8081"
		if param := cfg.Get("jfrogUrl"); param != "" {
			jfrogUrl = param
		}
		_, err := index / globalrole.NewGlobalRole(ctx, "my-global-role", &index/globalrole.GlobalRoleArgs{
			Name:        "my-global-role",
			Description: "Test description",
			Type:        "CUSTOM_GLOBAL",
			Environments: []string{
				"DEV",
			},
			Actions: []string{
				"READ_REPOSITORY",
				"READ_BUILD",
			},
		})
		if err != nil {
			return err
		}
		_, err = artifactory.NewLocalGenericRepository(ctx, "my-generic-local", &artifactory.LocalGenericRepositoryArgs{
			Key: "my-generic-local",
		})
		if err != nil {
			return err
		}
		_, err = index / workersservice.NewWorkersService(ctx, "my-workers-service", &index/workersservice.WorkersServiceArgs{
			Key:         "my-workers-service",
			Enabled:     true,
			Description: "My workers service",
			SourceCode:  "export default async (context: PlatformContext, data: BeforeDownloadRequest): Promise<BeforeDownloadResponse> => { console.log(await context.clients.platformHttp.get('/artifactory/api/system/ping')); console.log(await axios.get('https://my.external.resource')); return { status: 'DOWNLOAD_PROCEED', message: 'proceed', } }",
			Action:      "BEFORE_DOWNLOAD",
			FilterCriteria: map[string]interface{}{
				"artifactFilterCriteria": map[string]interface{}{
					"repoKeys": []interface{}{
						my_generic_local.Key,
					},
				},
			},
			Secrets: []map[string]interface{}{
				map[string]interface{}{
					"key":   "my-secret-key-1",
					"value": "my-secret-value-1",
				},
				map[string]interface{}{
					"key":   "my-secret-key-2",
					"value": "my-secret-value-2",
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

# Pulumi.yaml provider configuration file
name: configuration-example
runtime: yaml
config:
    artifactory:url:
        value: 'TODO: "${var.jfrog_url}"'
    platform:url:
        value: 'TODO: "${var.jfrog_url}"'

configuration:
  jfrogUrl:
    type: string
    default: http://localhost:8081
resources:
  my-global-role:
    type: platform:GlobalRole
    properties:
      name: my-global-role
      description: Test description
      type: CUSTOM_GLOBAL
      environments:
        - DEV
      actions:
        - READ_REPOSITORY
        - READ_BUILD
  my-generic-local:
    type: artifactory:LocalGenericRepository
    properties:
      key: my-generic-local
  my-workers-service:
    type: platform:WorkersService
    properties:
      key: my-workers-service
      enabled: true
      description: My workers service
      sourceCode: 'export default async (context: PlatformContext, data: BeforeDownloadRequest): Promise<BeforeDownloadResponse> => { console.log(await context.clients.platformHttp.get(''/artifactory/api/system/ping'')); console.log(await axios.get(''https://my.external.resource'')); return { status: ''DOWNLOAD_PROCEED'', message: ''proceed'', } }'
      action: BEFORE_DOWNLOAD
      filterCriteria:
        artifactFilterCriteria:
          repoKeys:
            - ${["my-generic-local"].key}
      secrets:
        - key: my-secret-key-1
          value: my-secret-value-1
        - key: my-secret-key-2
          value: my-secret-value-2

# Pulumi.yaml provider configuration file
name: configuration-example
runtime: java
config:
    artifactory:url:
        value: 'TODO: "${var.jfrog_url}"'
    platform:url:
        value: 'TODO: "${var.jfrog_url}"'

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.platform.GlobalRole;
import com.pulumi.platform.GlobalRoleArgs;
import com.pulumi.artifactory.LocalGenericRepository;
import com.pulumi.artifactory.LocalGenericRepositoryArgs;
import com.pulumi.platform.WorkersService;
import com.pulumi.platform.WorkersServiceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var config = ctx.config();
        final var jfrogUrl = config.get("jfrogUrl").orElse("http://localhost:8081");
        var my_global_role = new GlobalRole("my-global-role", GlobalRoleArgs.builder()
            .name("my-global-role")
            .description("Test description")
            .type("CUSTOM_GLOBAL")
            .environments("DEV")
            .actions(
                "READ_REPOSITORY",
                "READ_BUILD")
            .build());

        var my_generic_local = new LocalGenericRepository("my-generic-local", LocalGenericRepositoryArgs.builder()
            .key("my-generic-local")
            .build());

        var my_workers_service = new WorkersService("my-workers-service", WorkersServiceArgs.builder()
            .key("my-workers-service")
            .enabled(true)
            .description("My workers service")
            .sourceCode("export default async (context: PlatformContext, data: BeforeDownloadRequest): Promise<BeforeDownloadResponse> => { console.log(await context.clients.platformHttp.get('/artifactory/api/system/ping')); console.log(await axios.get('https://my.external.resource')); return { status: 'DOWNLOAD_PROCEED', message: 'proceed', } }")
            .action("BEFORE_DOWNLOAD")
            .filterCriteria(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
            .secrets(
                %!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
                %!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
            .build());

    }
}

Authentication

The JFrog Platform provider supports for the following types of authentication:

Scoped token
Pulumi Cloud OIDC provider

Scoped Token

JFrog scoped tokens may be used via the HTTP Authorization header by providing the accessToken field to the provider configuration. Getting this value from the environment is supported with the JFROG_ACCESS_TOKEN environment variable.

Usage:

# Pulumi.yaml provider configuration file
name: configuration-example
runtime:
config:
    platform:accessToken:
        value: abc...xy
    platform:url:
        value: my.jfrog.io

Configuration Reference

accessToken (String, Sensitive) This is a access token that can be given to you by your admin under Platform Configuration > User Management > Access Tokens. This can also be sourced from the JFROG_ACCESS_TOKEN environment variable.
oidcProviderName (String) OIDC provider name. See Configure an OIDC Integration for more details.
tfcCredentialTagName (String) Pulumi Cloud Workload Identity Token tag name. Use for generating multiple TFC workload identity tokens. When set, the provider will attempt to use env var with this tag name as suffix. Note: this is case sensitive, so if set to JFROG, then env var TFC_WORKLOAD_IDENTITY_TOKEN_JFROG is used instead of TFC_WORKLOAD_IDENTITY_TOKEN. See Generating Multiple Tokens on HCP Pulumi for more details.
url (String) JFrog Platform URL. This can also be sourced from the JFROG_URL environment variable.

platform 2.2.1 published on Friday, Mar 7, 2025 by jfrog

jfrog/terraform-provider-platform

Platform Provider

On this page

On this page

Generate Provider

Overview

Example Usage

Authentication

Scoped Token

Configuration Reference

On this page

On this page