Sso Connection

The sso connection resource.

Basehttps://rest.carbon.ms/ssoConnection

GET/ssoConnection

List sso connections

Retrieve a paginated list of sso connections. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/ssoConnection

curl --request GET \
  --url 'https://rest.carbon.ms/ssoConnection?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "providerId": "xyz789",
    "active": true,
    "requireSso": true,
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "metadataUrl": "string"
  }
]

GET/ssoConnection

Retrieve a sso connection

Fetch a single sso connection by filtering on `id`.

Query parameters

idstring

Match on the sso connection's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/ssoConnection

curl --request GET \
  --url 'https://rest.carbon.ms/ssoConnection?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "providerId": "xyz789",
  "active": true,
  "requireSso": true,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "metadataUrl": "string"
}

POST/ssoConnection

Create a sso connection

Create a new sso connection.

Body parameters

providerIdstringrequired

metadataUrlstring

metadataXmlstring

activebooleanrequired

requireSsobooleanrequired

POSThttps://rest.carbon.ms/ssoConnection

curl --request POST \
  --url https://rest.carbon.ms/ssoConnection \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"providerId":"xyz789","active":true,"requireSso":true}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "providerId": "xyz789",
  "active": true,
  "requireSso": true,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "metadataUrl": "string"
}

PATCH/ssoConnection

Update a sso connection

Update an existing sso connection, matched on `id`.

Body parameters

providerIdstringrequired

metadataUrlstring

metadataXmlstring

activebooleanrequired

requireSsobooleanrequired

PATCHhttps://rest.carbon.ms/ssoConnection

curl --request PATCH \
  --url 'https://rest.carbon.ms/ssoConnection?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"providerId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "providerId": "xyz789",
  "active": true,
  "requireSso": true,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "metadataUrl": "string"
}

DELETE/ssoConnection

Delete a sso connection

Delete a sso connection, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the sso connection to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/ssoConnection

curl --request DELETE \
  --url 'https://rest.carbon.ms/ssoConnection?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content