Update Access Federation

JFrog REST APIs

Products
JFrog Xray
Content Type
REST API
ft:sourceType
Paligo

Description: Updates (patch) federation target configurations.

Security:

  • Prior to release 7.12.0: Requires an admin user (basic credentials only). Requires execution from access localhost.

  • From release 7.12.0: Requires a valid admin-scoped token. The API no longer supports basic authentication.

Usage: PATCH /api/v1/system/federation/{server_name}

Produces: text/plain

Sample usage:

curl -H "Authorization: Bearer <Token>" PATCH {{"http://localhost:8082/access/api/v1/system/federation/ {server_name}
"}} -H "accept: application/json" -H "Content-Type: application/json" -d {{"{ \"entities\": [ \"users\", \"groups\", \"permissions\" ], \"permission_filters\":
 
{ \"include_patterns\": [ \"team_a_*\" ], \"exclude_patterns\": [ \"none_federated_*\" ] }
, \"active\": true}"}}

Response Codes: 204 Successful operation

{
  "name": "access-2",
  "url": "https://access.example.com/access/",
  "entities": [
    "users",
    "groups",
    "permissions"
  ],
  "permissionFilters": {
    "includePatterns": [
      "team_a_*"
    ],
    "excludePatterns": [
      "none_federated_*"
    ]
  },
  "active": true
}

400 Invalid input

401 Unauthorized

403 Forbidden