Register Access Federation

Registers a new federation target.

Note: This endpoint manages Access Federation directly on the JPD you are connected to. For centralized federation management across multiple JPDs, we recommend using the Mission Control Access Federation APIs.

Security: Requires admin privileges.

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

Federation target name

string
required

Federation target URL

entities
array of strings
Defaults to users,groups,permissions,tokens

List of entities to federate

entities
permission_filters
object

Filter patterns for federation

group_filters
object

Filter patterns for federation

boolean
Defaults to true

Whether the federation target is active

boolean
Defaults to false

Force override existing federation target

Responses

400

Bad Request - Invalid input (e.g., missing name or url)

401

Bad Credentials - Invalid credentials

403

Permission Denied - Insufficient permissions

409

Conflict - A federation target with the same name already exists

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