Skip to content

by Startups.Studio

Product Domains and access SSO Connection

SSOConnection.activate

POST /{namespace}/sso-connections/{connection}/activate

Activate turns an SSO Connection on after a test sign-in passes, so the Tenant’s people sign in through it.

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

You, to your agent

Activate the latest SSO connection.

curl -X POST https://api.sb/quietcopy.com/sso-connections/sso_connection_1/activate \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const connection = await $.SSOConnection.activate({ connection: 'sso_connection_1' })

npx startup-builder do SSOConnection.activate --json '{"connection":"sso_connection_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.SSOConnection.activate({ connection: 'sso_connection_1' })"
  }
}

Inputs

Input	Type	Required	Description
`connection`	SSO Connection	required	The SSO Connection to turn on.

Outputs

Output	Type	Required	Description
`connection`	SSO Connection	required	The SSO Connection, now active.

Effects

Emits SSOConnection.activated.
Performed by the Security Engineer.
Two-way: it runs at once, in the try, send and do modes.
A failing connection or a certificate 30 days from expiry emits an Event to the Startup and a notice to the admin.

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.activate

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`.

SSO Connection

Previous Page

SSOConnection.create

Next Page