Update a permission target with jf rt permission-target-update

Update a permission target in the JFrog Platform from a template file.

🚧

Warning

This command replaces the entire permission target definition with the contents of the template file. It is not a partial patch. Ensure your template includes all fields you want to retain — any field omitted from the template will be removed from the permission target.

Synopsis

jf rt permission-target-update <template-path> [options]

Aliases: rt ptu

Arguments

Options

Template Format

The template is a JSON file that describes the full permission target definition. Generate one interactively with jf rt ptt, or write one manually using the format below.

📘

Note

jf rt ptt is an interactive command that requires a TTY. It cannot be run in CI/CD pipelines or non-interactive shells. In those environments, create the template JSON file manually.

{
  "name": "my-permission-target",
  "repo": {
    "repositories": "libs-release",
    "actions": {
      "users": {
        "alice": ["read", "write"]
      },
      "groups": {
        "developers": ["read", "write", "annotate", "delete", "manage"]
      }
    }
  },
  "build": {
    "repositories": "artifactory-build-info",
    "actions": {
      "groups": {
        "developers": ["read", "manage"]
      }
    }
  }
}

Key schema notes:

• repositories must be a string (a single repository key), not a JSON array.
• Supported permission values: read, write, annotate, delete, manage, managedXrayMeta, distribute.
• The build section is optional. Omit any top-level section (repo, build, releaseBundle) if it is not needed.
• To use variable substitution, replace any value with ${variableName} and pass the variable via --vars.

Examples

Update a permission target from a template file

To update a permission target from a template file:

1. Run:

jf rt permission-target-update <template-path>

Where:

• <template-path> — path to the JSON template (see Arguments).

Full example:

jf rt permission-target-update ./template.json

Expected output:

[Info] Updating permission target...

A clean exit with this message confirms the permission target was updated successfully.

Update with variable substitution

Use --vars to inject values into ${placeholder} fields in your template at runtime. This is useful for reusing a single template across multiple environments or permission targets.

To update a permission target with variable substitution:

1. Run:

jf rt permission-target-update <template-path> --vars "<key1>=<value1>;<key2>=<value2>"

Full example:

jf rt permission-target-update ./template.json --vars "groupName=developers;repoName=libs-release"

Given a template containing "repositories": "${repoName}" and "${groupName}": [...], this command substitutes the values before submitting. Expected output:

[Info] Updating permission target...

View command usage

To view command usage:

1. Run:

jf rt permission-target-update --help

Important Notes

• Requires admin privileges on the Artifactory instance.
• The template format used by jf rt permission-target-update is the same as the one created by jf rt ptt (permission-target-template). Always use jf rt ptt to generate your initial template to ensure the correct schema.
• The permission target identified by the name field in the template must already exist. This command updates an existing target — it does not create one. To create a new permission target, use jf rt permission-target-create.

Troubleshooting