Sso Reserved Domain

The sso reserved domain resource.

Basehttps://rest.carbon.ms/ssoReservedDomain

GET/ssoReservedDomain

List sso reserved domains

Retrieve a paginated list of sso reserved domains. 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/ssoReservedDomain

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

Response

[
  {
    "domain": "string"
  }
]

GET/ssoReservedDomain

Retrieve a sso reserved domain

Fetch a single sso reserved domain by filtering on `domain`.

Query parameters

domainstring

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

GEThttps://rest.carbon.ms/ssoReservedDomain

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

Response

{
  "domain": "string"
}

POST/ssoReservedDomain

Create a sso reserved domain

Create a new sso reserved domain.

POSThttps://rest.carbon.ms/ssoReservedDomain

curl --request POST \
  --url https://rest.carbon.ms/ssoReservedDomain \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"domain":"string"}'

Response

{
  "domain": "string"
}

PATCH/ssoReservedDomain

Update a sso reserved domain

Update an existing sso reserved domain, matched on `domain`.

PATCHhttps://rest.carbon.ms/ssoReservedDomain

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

Response

{
  "domain": "string"
}

DELETE/ssoReservedDomain

Delete a sso reserved domain

Delete a sso reserved domain, matched on `domain`. Returns 204 No Content.

Query parameters

domainstring

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

DELETEhttps://rest.carbon.ms/ssoReservedDomain

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

204 No Content