SSO Connection routes: update

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

SSOConnection.update

Changes the given properties of a SSO Connection. Verb page.

Text

PATCH /{namespace}/sso-connections/{id}

Path: id. Body, as JSON: the other inputs. 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

Terminal

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

JSON

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

SSOConnection.updateCopy Anchor Link

SSOConnection.update