Connections

Disable SSO connection

Deactivate an existing connection for the specified organization. When disabled, users cannot authenticate using this connection. This endpoint changes the connection state from enabled to disabled without modifying other configuration settings

patch/api/v1/organizations/{organization_id}/connections/{id}:disable

Request

Base URL
https://$SCALEKIT_ENVIRONMENT_URL
Auth
OAuth 2
Client credentials
Token URLhttps://$SCALEKIT_ENVIRONMENT_URL/oauth/token
TypeScript
https://skmtc.dev/scalekit/apis/scalekit-api-reference/docs/api/v1/organizations/:organization_id/connections/:id:disable/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

organization_idstring required

Unique identifier of the organization associated with the connection

idstring required

Unique identifier for the connection to be toggled

Response

Connection disabled successfully

enabledboolean

Current state of the connection after the operation. True means the connection is now enabled and can be used for authentication.

error_messagestring

Error message if the operation fails

Example response

{
  "enabled": true,
  "error_message": "placeholder"
}

Changes

No recorded changes to this operation across all 16 revisions of this API.