Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIProductDomains and accessSSO Connection

SSO Connection routes: create, get, list

The SSO Connection Verbs create, get, list as api.sb routes, with inputs, result, refusals and an example.

Reference for SSO Connection, one group of SSO Connection routes.

SSOConnection.create

Creates a SSO Connection. Verb page.

Text
POST /{namespace}/sso-connections

Body, as JSON: the inputs. Emits SSOConnection.created.

Inputs

InputTypeRequiredDescription
protocolstringrequiredHow sign-in is asserted: saml or oidc.
certificateExpiresAtdatetimeWhen the signing certificate expires; the Customer’s admin hears 30 days before.
testedAtdatetimeWhen the Customer’s admin last completed a test sign-in.
tenantTenantA Tenant’s people sign in through its SSO Connections; the Customer’s admin owns each one.

Returns

OutputTypeRequiredDescription
ssoConnectionSSO ConnectionrequiredThe SSO Connection.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/sso-connections \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"protocol":"saml"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "ssoConnection": {
    "$id": "https://api.sb/leaseline.app/sso-connections/sso_gFlPhZJ7A7",
    "$type": "SSOConnection",
    "protocol": "saml",
    "state": "draft"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "SSOConnection.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

SSOConnection.get

Returns one SSO Connection by id. Verb page.

Text
GET /{namespace}/sso-connections/{id}

Path: id. Query: the other inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the SSO Connection.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

Returns

OutputTypeRequiredDescription
ssoConnectionSSO ConnectionrequiredThe SSO Connection.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl https://api.sb/leaseline.app/sso-connections/sso_gFlPhZJ7A7 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "SSOConnection",
  "$id": "https://api.sb/leaseline.app/sso-connections/sso_gFlPhZJ7A7",
  "ssoConnection": {
    "$id": "https://api.sb/leaseline.app/sso-connections/sso_gFlPhZJ7A7",
    "$type": "SSOConnection",
    "protocol": "saml",
    "state": "draft"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/sso-connections/sso_gFlPhZJ7A7",
    "up": "https://api.sb/leaseline.app/sso-connections"
  },
  "actions": {
    "activate": "https://api.sb/leaseline.app/sso-connections/sso_gFlPhZJ7A7/activate",
    "deactivate": "https://api.sb/leaseline.app/sso-connections/sso_gFlPhZJ7A7/deactivate"
  }
}

SSOConnection.list

Returns SSO Connections, newest first, one page at a time. Verb page.

Text
GET /{namespace}/sso-connections

Query: the inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
limitintegerAt most this many records, up to 100. The default is 20.
afterstringThe cursor from the previous page.
wherestringA filter over the properties, such as paidAt = null and total.amount > 500.
sortstringProperties to sort by, comma-separated; a leading minus sorts descending.
totalbooleanTrue adds the match count as meta.total, exact up to 10,000 matches and estimated above.
facetsstringProperties to count by value, comma-separated, returned as meta.facets.
fieldsstringProperties to return on each record, comma-separated; $id and $type always return.
includestringRelated records to embed in place of their URLs, comma-separated.
depthintegerHow many levels of related records to embed. The default is 1.
qstringWords to match across the text properties, ranked by relevance.
matchstringRanks the search by words, or meaning; words is the default.

Returns

OutputTypeRequiredDescription
ssoConnectionslist of SSO ConnectionrequiredOne page of SSO Connections.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl "https://api.sb/leaseline.app/sso-connections?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "SSOConnection",
  "ssoConnections": [
    {
      "$id": "https://api.sb/leaseline.app/sso-connections/sso_gFlPhZJ7A7",
      "$type": "SSOConnection",
      "protocol": "saml",
      "state": "draft"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "sso_gFlPhZJ7A7"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/sso-connections?limit=20",
    "next": "https://api.sb/leaseline.app/sso-connections?after=sso_gFlPhZJ7A7"
  }
}

SSO Connection

Previous

update

Next