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-go/blob/main/domain.go

#asyncCreateDomain

Runs CreateDomain and returns the result.

paramctxcontext.Context

Request context

paramnamestring

Display name.

paramoptions...*CreateDomainOptions

Optional request settings.

returnsCreateDomainResponse

The created resource.

created, err := scalekitClient.Domain().CreateDomain(ctx, "org_123", "acme.com")
if err != nil {
  // handle
}
_ = created.Domain

// With options
created2, err := scalekitClient.Domain().CreateDomain(ctx, "org_123", "acme.com", &scalekit.CreateDomainOptions{
  DomainType: scalekit.DomainTypeOrganization,
})
if err != nil {
  // handle
}
_ = created2.Domain

GetDomain

clientDomainshttps://github.com/scalekit-inc/scalekit-sdk-go/blob/main/domain.go

#asyncGetDomain

Runs GetDomain and returns the result.

paramctxcontext.Context

Request context

paramidstring

Resource ID.

paramorganizationIdstring

Organization ID.

returnsGetDomainResponse

The response payload for this operation.

domain, err := scalekitClient.Domain().GetDomain(ctx, "dom_123", "org_123")
if err != nil {
  // handle
}
_ = domain.Domain

ListDomains

clientDomainshttps://github.com/scalekit-inc/scalekit-sdk-go/blob/main/domain.go

#asyncListDomains

Runs ListDomains and returns the result.

paramctxcontext.Context

Request context

paramorganizationIdstring

Organization ID.

paramoptions...*ListDomainOptions

Optional request settings.

returnsListDomainResponse

Paginated results.

all, err := scalekitClient.Domain().ListDomains(ctx, "org_123")
if err != nil {
  // handle
}
_ = all.Domains

// Filter by domain type
orgDomains, err := scalekitClient.Domain().ListDomains(ctx, "org_123", &scalekit.ListDomainOptions{
  DomainType: scalekit.DomainTypeOrganization,
})
if err != nil {
  // handle
}
_ = orgDomains.Domains

DeleteDomain

clientDomainshttps://github.com/scalekit-inc/scalekit-sdk-go/blob/main/domain.go

#asyncDeleteDomain

Runs DeleteDomain and returns the result.

paramctxcontext.Context

Request context

paramidstring

Resource ID.

paramorganizationIdstring

Organization ID.

returnserror

error

if err := scalekitClient.Domain().DeleteDomain(ctx, "dom_123", "org_123"); err != nil {
  // handle
}