Get Access Federation

Description: Returns the name of the federation target to unregister.

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: GET /api/v1/system/federation/{server_name}

Produces: text/plain

Sample Usage

curl -H "Authorization: Bearer <Token>" GET "http://localhost:8082/access/api/v1/system/federation/{server_name}" -H "accept: application/json"

Response Codes:

200 Successful operation

200 Successful operation

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

401 Unauthorized

403 Forbidden

404 No such federation target