SSO Connection methods: update
The SSO Connection Verbs update as typed SDK methods, with inputs, result, refusals and an example.
Reference for SSO Connection, one group of SSO Connection methods.
SSOConnection.update
Changes the given properties of a SSO Connection. Verb page.
interface SSOConnectionVerbs {
update(input: SSOConnectionUpdateInput, options?: SB.CallOptions): SB.Call<SSOConnection>
}Emits SSOConnection.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the SSO Connection. |
protocol | string | 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. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
ssoConnection | SSO Connection | required | The SSO Connection. |
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
import { $ } from 'startup-builder'
const ssoConnection = await $.SSOConnection.update({ id: 'sso_gFlPhZJ7A7', protocol: 'saml' })