Create or Replace / Update Permission Target (V2)

put

https://{jfrog_url}/artifactory/api/v2/security/permissions/{permissionTargetName}

Creates a new permission target in the JFrog Unified Platform or replaces / updates an existing permission target.

Since: 6.6.0

Notes: Requires Artifactory Pro.

Missing values will be set to the default values as defined by the consumed type.
The values defined in the request payload will replace what currently exists in the permission target entity. In case the request is missing one of the permission target entities (repo/build), the entity will be deleted. This means that if an update request is sent to an entity that contains both repo and builds, with only repo, the build values will be removed from the entity.
Please note when adding Release Bundles permission targets:
- Requires an Edge/Enterprise+ license.
- On Edge nodes, the repositories section in the request body can be left empty or contain the 'release-bundles' default repository. No other repositories are allowed. An Enterprise+ license allows you to add any repository.
- The default repository in the repository section is "release-bundles" for both Edge/EntPlus licenses. (If the user creates a permission target with an empty repositories section, the repository set is "release-bundles".)
To support spaces in the User or Group or Permission names, a Plus symbol ('+') is automatically placed when there is a space. This is set by default as the artifactory.security.api.plus.insteadof.space property is set to true. If you want to use the + (plus) symbol, set the artifactory.security.api.plus.insteadof.space to false.

Security: Requires an admin user, or a user with Manage permission on the permission target (a user with Manage permission can only edit the actions).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

permissionTargetName

string

required

The name of the permission target

Body Params

Permission target V2 definition including repo, build, and releaseBundle sections with include/exclude patterns, repositories, and user/group actions.

Permission Target V2 schema.

Permissions are set/returned according to the following conventions: read, write, annotate, delete, manage, managedXrayMeta, distribute.

You can specify the name "ANY" in the repositories section in order to apply to all repositories, "ANY REMOTE" for all remote repositories and "ANY LOCAL" for all local repositories.

Name is limited to 64 characters. include-patterns/exclude-patterns are limited to 1024 characters.

name

string

The name of the permission target (limited to 64 characters).

repo

object

build

object

Build permission section. The repositories field defaults to ["artifactory-build-info"] and cannot be changed.

releaseBundle

object

Release bundle permission section. The repositories field defaults to ["release-bundles"].

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

200

Permission target updated successfully.

400Bad Request - Invalid permission target configuration.

401Bad Credentials - The provided authentication is invalid.

403Permission Denied - This operation requires an admin user or a user with Manage permission on permission target.

404Not Found - The specified permission target was not found.

500Internal Server Error