SSO connections

Use the connection client to configure enterprise SSO (SAML/OIDC) for an organization.

Enable SSO after the organization exists: create a connection, complete IdP setup, and test sign-in for that org.

getConnection

clientConnectionshttps://github.com/scalekit-inc/scalekit-sdk-node/blob/main/src/connection.ts

#asyncgetConnection

Retrieves complete configuration and status details for a specific SSO connection.

paramorganizationIdstring

Organization ID.

paramidstring

The connection identifier to retrieve (format: “conn_…”)

returnsGetConnectionResponse

The connection.

const response = await scalekit.connection.getConnection(
  'org_123456',
  'conn_abc123'
);

const conn = response.connection;
console.log('Provider:', conn.provider);
console.log('Type:', conn.type);
console.log('Status:', conn.enabled ? 'Enabled' : 'Disabled');

listConnectionsByDomain

clientConnectionshttps://github.com/scalekit-inc/scalekit-sdk-node/blob/main/src/connection.ts

#asynclistConnectionsByDomain

Lists all SSO connections associated with a specific email domain.

paramdomainstring

The email domain to search for (e.g., “acme.com”)

returnsListConnectionsResponse

Paginated connections.

const response = await scalekit.connection.listConnectionsByDomain('acme.com');

if (response.connections.length > 0) {
  console.log('SSO available for domain acme.com');
  const connection = response.connections[0];
  console.log('Organization:', connection.organizationId);
}

listConnections

clientConnectionshttps://github.com/scalekit-inc/scalekit-sdk-node/blob/main/src/connection.ts

#asynclistConnections

Lists all SSO connections configured for an organization.

paramorganizationIdstring

The organization ID

returnsListConnectionsResponse

Paginated connections.

const response = await scalekit.connection.listConnections('org_123456');

console.log(`Found ${response.connections.length} connections`);
response.connections.forEach(conn => {
  console.log(`- ${conn.provider} (${conn.type}): ${conn.enabled ? 'Enabled' : 'Disabled'}`);
});

listAppConnections

clientConnectionshttps://github.com/scalekit-inc/scalekit-sdk-node/blob/main/src/connection.ts

#asynclistAppConnections

Lists app-level connections configured for the account (not scoped to an organization).

paramparamsobject

Required or common fields: pageSize, pageToken, provider.

pageSize, pageToken, provider

returnsListAppConnectionsResponse

Paginated connections.

enableConnection

clientConnectionshttps://github.com/scalekit-inc/scalekit-sdk-node/blob/main/src/connection.ts

#asyncenableConnection

Enables an SSO connection for an organization.

paramorganizationIdstring

The organization ID

paramidstring

The connection ID to enable

returnsToggleConnectionResponse

Response with updated connection status

const response = await scalekit.connection.enableConnection(
  'org_123456',
  'conn_abc123'
);

console.log('Connection enabled:', response.connection.enabled);

disableConnection

clientConnectionshttps://github.com/scalekit-inc/scalekit-sdk-node/blob/main/src/connection.ts

#asyncdisableConnection

Disables an SSO connection for an organization.

paramorganizationIdstring

The organization ID

paramidstring

The connection ID to disable

returnsToggleConnectionResponse

Response with updated connection status

const response = await scalekit.connection.disableConnection(
  'org_123456',
  'conn_abc123'
);

console.log('Connection disabled:', !response.connection.enabled);