Register Access Federation

Description: Registers a new federation target.

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: POST /api/v1/system/federation

Produces: text/plain

Sample usage:

curl -H "Authorization: Bearer <Token>" http://localhost:8082/access/api/v1/system/federation/" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"name\": \"access-2\", \"url\": \"https://access.example.com/access/\", \"entities\": [ \"users\", \"groups\", \"permissions\" ], \"permissionFilters\": { \"includePatterns\": [ \"team_a_*\" ], \"excludePatterns\": [ \"none_federated_*\" ] }, \"active\": true}"

Response Codes:

201 Successfully registered

 {
  "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

404 Already exists