Skip to main content

OrganizationDomain

A host name the organization's portal answers on.

type OrganizationDomain {
  createdAt: DateTime!
  hostname: String!
  id: ID!
  isPrimary: Boolean!
  kind: PortalDomainKind!
  status: PortalDomainStatus!
  statusMessage: String
  validationRecord: JSON
  verifiedAt: DateTime
}

Fields​

OrganizationDomain.createdAt ● DateTime! non-null scalar​

When the record was created.

OrganizationDomain.hostname ● String! non-null scalar​

The host name.

OrganizationDomain.id ● ID! non-null scalar​

The unique ID of this record.

OrganizationDomain.isPrimary ● Boolean! non-null scalar​

True when this is the main address of the portal.

OrganizationDomain.kind ● PortalDomainKind! non-null enum​

Whether it is the platform subdomain or a custom domain.

OrganizationDomain.status ● PortalDomainStatus! non-null enum​

Where the domain stands.

OrganizationDomain.statusMessage ● String scalar​

Human-readable detail for the current status (e.g. why a domain FAILED).

OrganizationDomain.validationRecord ● JSON scalar​

DNS validation record the customer must publish (CNAME/TXT) for a CUSTOM domain — populated once the control plane responds.

OrganizationDomain.verifiedAt ● DateTime scalar​

When the domain was verified.

Returned By​

addOrganizationDomain mutation ● organizationDomains query ● retryOrganizationDomainProvisioning mutation ● setPrimaryOrganizationDomain mutation