Legend
Element | Description |
|---|---|
| Mandatory element in create/replace queries; optional in "update" queries |
| Optional element in create/replace queries. |
| Read-only element |
| The default value when left unspecified in create/replace queries. |
application/vnd.org.jfrog.artifactory.security.User+json
{
- "name": "davids",
+ "email" : "davids@jfrog.com",
+ "password": "***" (write-only, never returned),
- "admin": false (default),
- "profileUpdatable": true (default),
- "disableUIAccess" : false (default),
- "internalPasswordDisabled": false (default),
! "lastLoggedIn": ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ),
! "lastLoggedInMillis": 1735682400000,
! "realm": "Realm name (e.g. internal, saml, oauth, ldap, crowd, scim)",
! "groups" : [ "deployers", "users" ],
- "watchManager": false(default),
- "policyManager": false(default),
- "policyViewer": false(default),
- "reportsManager": false(default),
! "mfaStatus": "NONE" | "ENROLL" | "VERIFY",
! "status": "INVITED" | "ENABLED" | "DISABLED" | "LOCKED"
}Property | Required | Description |
|---|---|---|
| optional | The user name. |
| mandatory | The user's email address. |
| mandatory | The user's password. |
| optional | Defines whether the user is an administrator. The default value is |
| optional | Defines whether the user has permission to change their profile details (except their password, which can be changed only by an administrator). The default value is |
| optional | Defines whether the platform UI is disabled for this user. The default value is |
| optional | When set to The default value is |
| read-only | The timestamp of the last login by this user (ISO 8601 format). |
| read-only | The timestamp of the last login by this user (in milliseconds). |
| read-only | The authentication realm that manages this user's credentials. |
| optional | The defined groups to which this user belongs. |
| optional | [Xray users only] Defines whether the user can manage watches. The default value is |
| optional | [Xray users only] Defines whether the user can manage policies. The default value is |
| optional | [Xray users only] Defines whether the user can view policies. The default value is |
| optional | [Xray users only} Defines whether the user can manage Xray Reports on any resource type. The default value is |
| read-only | Defines the multi-factor authentication (MFA) status of this user:
|
| read-only | Defines the current status of the user:
|
application/vnd.org.jfrog.artifactory.security.Group+json
{
- "name": "dev-leads",
- "description" : "The development leads group",
- "autoJoin" : false (default, must be false if adminPrivileges is true),
- "adminPrivileges" : false (default),
! "realm": "Realm name (e.g. internal, saml, ldap, crowd, scim)",
! "realmAttributes": "Realm attributes for use by LDAP"
- "userNames" : [ "user1", "user2", "user3" ] //available from version 6.13 only for Update Group requests
- "watchManager": false (default),
- "policyManager": false (default),
- "reportsManager": false (default)
- "externalId" : "123"
}Property | Required | Description |
|---|---|---|
| optional | The name of the group. |
| optional | An optional description of the group. |
| optional | Defines whether new users should join this group automatically. The default value is NoteThis property must be set to |
| optional | Defines whether the members of this group have administrator privileges. The default value is |
| read-only | The authentication realm that manages this group's credentials. |
| optional | Defines the configuration settings used to define how this group connects to and interacts with an LDAP server. |
| optional | An array of users to add as members to this group. |
| optional | [Xray users only] Defines whether the users in this group can manage watches. The default value is |
| optional | [Xray users only] Defines whether the users in this group can manage policies. The default value is |
| optional | [Xray users only} Defines whether the users in this group can manage Xray Reports on any resource type. The default value is |
| optional | If the group is managed by an external identity provider, this is the unique id generated by that provider. The |
application/vnd.org.jfrog.artifactory.security.PermissionTarget+json
Permissions are set/returned according to the following conventions:
m=admin; d=delete; w=deploy; n=annotate; r=read; mxm=managedXrayMeta; x=distribute
name is limited to 64 characters
includePattern/excludePattern are limited to 1024 characters
{
- "name": "populateCaches",
- "includesPattern": "**" (default),
- "excludesPattern": "" (default),
+ "repositories": ["local-rep1", "local-rep2", "remote-rep1"], // Permission targets are not supported for Virtual repositories.
- "principals": {
"users" : {
"bob": ["r","w","m"],
"alice" : ["d","w","n", "r"]
},
"groups" : {
"dev-leads" : ["m","r","n"],
"readers" : ["r"]
}
}
}
Property | Required | Description |
|---|---|---|
| optional | The name of the permission target. |
| optional | A regex pattern that defines which repositories to include in this permission. The default is |
| optional | A regex pattern that defines which repositories to explicitly exclude from this permission. The default is |
| mandatory | Defines the local and remote repositories included as resources for this permission. NoteVirtual repositories are not supported. |
| optional | Defines the actions permitted to each user and group. |
application/vnd.org.jfrog.artifactory.security.PermissionTargetV2+json
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": "java-developers",
- "repo": {
- "include-patterns": ["**"] (default),
- "exclude-patterns": [""] (default),
+ "repositories": ["local-rep1", "local-rep2", "remote-rep1"],
- "actions": {
"users": {
"bob": ["read","write","manage"],
"alice": ["write","annotate", "read"]
},
"groups": {
"dev-leads": ["manage","read","annotate"],
"readers": ["read"]
}
}
}
- "build": {
- "include-patterns": [""] (default),
- "exclude-patterns": [""] (default),
+ "repositories": ["artifactory-build-info"] (default, can't be changed),
- "actions": {
"users": {
"bob": ["read","manage"],
"alice": ["write"]
},
"groups": {
"dev-leads": ["manage","read","write","annotate","delete"],
"readers": ["read"]
}
}
}
- "releaseBundle":{
- "include-patterns": ["**"],
- "exclude-patterns": [],
+ "repositories": ["release-bundles"],
- "actions": {
"users": {
"user_name":["read", “write” etc..]
},
"groups":{
"group_name":[“read”, “write” etc..]
}
}
}
Property | Required | Description |
|---|---|---|
| optional | The name of the permission target. |
| optional | Defines which repositories are included in this permission and the actions that can be performed by each user and group. Include and exclude patterns are supported. |
| optional | Defines which builds are included in this permission and the actions that can be performed by each user and group. Include and exclude patterns are supported. |
| optional | Defines which Release Bundles are included in this permission and the actions that can be performed by each user and group. Include and exclude patterns are supported. |