SSO Connection routes: activate, deactivate

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

SSOConnection.activate

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

Text

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

Path: connection. Emits SSOConnection.activated.

Inputs

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

Returns

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

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

Example

Terminal

curl -X POST https://api.sb/leaseline.app/sso-connections/sso_gFlPhZJ7A7/activate \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

JSON

{
  "api": "https://api.sb/leaseline.app",
  "connection": {
    "$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.activate",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

SSOConnection.deactivate

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