Domains

Use the domain client to manage verified email domains for an organization (SSO routing and domain-based policies).

Add a domain, complete verification, then use it with SSO and organization policies.

createDomain

clientDomainshttps://github.com/scalekit-inc/scalekit-sdk-node/blob/main/src/domain.ts

#asynccreateDomain

Adds a new domain configuration to an organization for SSO routing or user suggestions.

paramorganizationIdstring

The organization ID (format: “org_…”)

paramnamestring

The domain name (e.g., “acme.com”, “example.org”)

paramoptionsobject

Optional fields: domainType.

domainType

returnsCreateDomainResponse

The created domain with ID and verification status

// domainType: Domain type filter
const response = await scalekit.domain.createDomain(
  'org_123456',
  'acme.com',
  { domainType: 'ORGANIZATION_DOMAIN' }
);

console.log('Domain created:', response.domain.id);

getDomain

clientDomainshttps://github.com/scalekit-inc/scalekit-sdk-node/blob/main/src/domain.ts

#asyncgetDomain

Retrieves detailed information about a specific domain configuration.

paramorganizationIdstring

The organization ID (format: “org_…”)

paramdomainIdstring

The domain ID (format: “domain_…”)

returnsGetDomainResponse

Complete domain configuration and status

const response = await scalekit.domain.getDomain(
  'org_123456',
  'domain_abc123'
);

console.log('Domain:', response.domain.domain);
console.log('Type:', response.domain.domainType);
console.log('Verified:', response.domain.verificationStatus);

listDomains

clientDomainshttps://github.com/scalekit-inc/scalekit-sdk-node/blob/main/src/domain.ts

#asynclistDomains

Retrieves all domain configurations for an organization.

paramorganizationIdstring

The organization ID (format: “org_…”)

paramoptionsobject

Optional fields: domainType.

domainType

returnsListDomainResponse

List of all domains with their configurations

// domainType: Domain type filter
const response = await scalekit.domain.listDomains('org_123456');

console.log(`Found ${response.domains.length} domains`);
response.domains.forEach(domain => {
  console.log(`- ${domain.domain} (${domain.domainType}): ${domain.verificationStatus}`);
});

deleteDomain

clientDomainshttps://github.com/scalekit-inc/scalekit-sdk-node/blob/main/src/domain.ts

#asyncdeleteDomain

Deletes a domain from an organization.

paramorganizationIdstring

The organization ID

paramdomainIdstring

The domain ID to delete

returnsobject

Empty response on successful deletion

MessageShape(typeof EmptySchema)

await scalekit.domain.deleteDomain('org_123456', 'domain_abc123');
console.log('Domain deleted successfully');