Skip to content

by Startups.Studio

Product Domains and access SSO Connection

SSOConnection.create

POST /{namespace}/sso-connections

Creates a SSO Connection.

Noun: SSO Connection
Mode: do
Event: SSOConnection.created

You, to your agent

Add a SSO connection to LedgerLark.

curl -X POST https://api.sb/ledgerlark.com/sso-connections \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"protocol":"saml"}'

import { $ } from 'startup-builder'

const ssoConnection = await $.SSOConnection.create({ protocol: 'saml' })

npx startup-builder do SSOConnection.create --json '{"protocol":"saml"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.SSOConnection.create({ protocol: 'saml' })"
  }
}

Create makes a new SSO Connection from the inputs below. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`protocol`	`string`	required	How sign-in is asserted: `saml` or `oidc`.
`certificateExpiresAt`	`datetime`		When the signing certificate expires; the Customer’s admin hears 30 days before.
`testedAt`	`datetime`		When the Customer’s admin last completed a test sign-in.
`tenant`	Tenant		A Tenant’s people sign in through its SSO Connections; the Customer’s admin owns each one.

Outputs

Output	Type	Required	Description
`ssoConnection`	SSO Connection	required	The SSO Connection.

Effects

Emits SSOConnection.created.
Two-way: try, send, do.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	SSOConnection.create

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

SSOConnection.activate

Previous Page

SSOConnection.deactivate

Next Page