Federation Connections

Federation connections are part of Enterprise login. They represent a way to authenticate with a remote Identity Provider (IdP) using SAML or OIDC. You can set up different types of connections and assign them to individual or groups of tenants.

---

List All Connections

HTTP Request

GET https://api.thebridge.dev/account/federation/connection

Response HTTP 200

HTTP 200 — Array of Federation Connection objects.

Request example

cURL ▼

Copy

curl --request GET 'https://api.thebridge.dev/account/federation/connection' \
--header 'x-api-key: YOUR_APP_API_KEY'

Response example:

[
    {
        "id": "6571edf9dc018000227ac448",
        "type": "saml",
        "name": "ACME SAML",
        "clientId": "client_1234",
        "loginUrl": "https://mocksaml.com/api/saml/sso",
        "certificate": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----",
        "requestMethod": "GET",
        "signedRequest": false,
        "createdAt": "2023-12-07T16:08:25.061Z"
    }
]

▶ GET Try it out

GET https://api.thebridge.dev/account/federation/connection

x-api-key required Stored in session memory only. Never persisted.

Send Request Copy as cURL

---

Get Connection by ID

HTTP Request

GET https://api.thebridge.dev/account/federation/connection/:CONNECTION_ID

Response HTTP 200

HTTP 200 — Returns the connection object.

▶ GET Try it out

GET https://api.thebridge.dev/account/federation/connection/:CONNECTION_ID

x-api-key required Stored in session memory only. Never persisted.

CONNECTION_ID URL parameter The ID of the connection

Send Request Copy as cURL

---

Create New Connection

HTTP Request

POST https://api.thebridge.dev/account/federation/connection

Body Parameters

Parameter	Type	Required	Description
name	string	Required	Connection name. Visible to users when logging in
clientId	string	Optional	The identifier assigned by the IdP
loginUrl	string	Required	The URL where the IdP expects SAML requests
certificate	string	Required	Public key certificate from the IdP
requestMethod	string	Optional	HTTP GET Redirect (most common) or HTTP POST
signedRequest	boolean	Optional	Whether the IdP requires signed SAML requests
signedRequestAlgorithm	string	Optional	sha256 or sha512. Required if signedRequest is true
privateKey	string	Optional	Request signing private key. Required if signedRequest is true

Response HTTP 201

Returns the created Federation Connection model.

Request example

cURL ▼

Copy

curl --request POST 'https://api.thebridge.dev/account/federation/connection' \
--header 'x-api-key: YOUR_APP_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "type": "saml",
  "name": "My connection",
  "clientId": "client_1234",
  "loginUrl": "https://mocksaml.com/api/saml/sso",
  "certificate": "MIIC4jCCAco...",
  "requestMethod": "GET",
  "signedRequest": false
}'

▶ POST Try it out

POST https://api.thebridge.dev/account/federation/connection

x-api-key required Stored in session memory only. Never persisted.

Request Body (JSON) { "type": "saml", "name": "My connection", "clientId": "client_1234", "loginUrl": "https://mocksaml.com/api/saml/sso", "certificate": "MIIC4jCCAco...", "requestMethod": "GET", "signedRequest": false }

Send Request Copy as cURL

---

Update Connection

HTTP Request

PUT https://api.thebridge.dev/account/federation/connection/:CONNECTION_ID

Response HTTP 200

▶ PUT Try it out

PUT https://api.thebridge.dev/account/federation/connection/:CONNECTION_ID

x-api-key required Stored in session memory only. Never persisted.

CONNECTION_ID URL parameter The ID of the connection

Request Body (JSON) { "requestMethod": "POST" }

Send Request Copy as cURL

---

Delete a Connection

HTTP Request

DELETE https://api.thebridge.dev/account/federation/connection/:CONNECTION_ID

Response HTTP 200

▶ DELETE Try it out

DELETE https://api.thebridge.dev/account/federation/connection/:CONNECTION_ID

x-api-key required Stored in session memory only. Never persisted.

CONNECTION_ID URL parameter The ID of the connection

Send Request Copy as cURL