Update Access Federation

Updates federation target configurations.

Note: Server name and URL cannot be altered.

Security: Requires admin privileges.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Sample Usage

curl -H "Authorization: Bearer <Token>" -X 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}'

204

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

The federation target server name

Body Params
entities
array of strings

List of entities to federate

entities
Allowed:
permission_filters
object

Filter patterns for federation

group_filters
object

Filter patterns for federation

boolean

Whether the federation target is active

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

400

Bad Request - Invalid input (e.g., attempting to alter name or url)

401

Bad Credentials - Invalid credentials

403

Permission Denied - Insufficient permissions

404

Not Found - Federation target not found

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Choose an example:
application/json