Skip to content

by Startups.Studio

Product Domains and access SSO Connection

SSOConnection.deactivate

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

Deactivate turns an SSO Connection off, so nobody signs in through it; its configuration is kept.

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

You, to your agent

Deactivate the latest SSO connection.

curl -X POST https://api.sb/routewise.dev/sso-connections/sso_connection_1/deactivate \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

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

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

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

Deactivate turns an SSO Connection off, so nobody signs in through it; its settings are kept.

Inputs

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

Outputs

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

Effects

Emits SSOConnection.deactivated.
Performed by the Security Engineer.
Two-way: it runs at once, in the try, send and do modes.
Ends every session that signed in through it.

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

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

Previous Page

SSOConnection.get

Next Page