← All types
Ob Object

Portal

A customer-facing web Portal: its address, IAM ceiling and audience-to-site routing.

Fields

id

PortalID!Non-null

Unique Portal identifier.

Caller key the Portal was created with; it identifies the Control address allocation.

name

String!Non-null

Display name of the Portal.

Generated hostname assigned by Control; clients never choose it.

Hostname the Portal treats as canonical: the generated hostname or a READY custom alias.

Public URL of the generated address, once Control has assigned it.

Control-assigned handle within the generated address, once assigned.

Control's address allocation as a paa_ TypeID, once assigned.

Whether Control has assigned the generated address.

Possible values (2)
UNASSIGNED

Control has not yet assigned the Portal's generated address.

ASSIGNED

Control assigned the generated hostname, public URL and provisioning ID.

Whether the Portal serves visitors. An inactive Portal can still be authored and previewed.

Path visitors land on at the Portal root.

IAM policies forming the Portal's ceiling; every Portal grant is intersected with them. Input order round-trips.

IAM policies granted to anonymous visitors, intersected with the ceiling. Empty grants nothing.

Audience bindings choosing which site each kind of visitor is served.

revision

Int!Non-null

Revision incremented on every change; pass it as expectedRevision to reject stale writes.

Referenced by (3)
Exact type SDL
"""
A customer-facing web Portal: its address, IAM ceiling and audience-to-site routing.
"""
type Portal @iac_resource(name: "portal") @iac_ops(create: "createPortal", read: "getPortal", update: "updatePortal", delete: "deletePortal") {
  """Unique Portal identifier."""
  id: PortalID! @iac_identity(assignedBy: SERVER) @iac_computed
  """
  Caller key the Portal was created with; it identifies the Control address allocation.
  """
  idempotencyKey: String @iac_createOnly
  """Display name of the Portal."""
  name: String!
  """Generated hostname assigned by Control; clients never choose it."""
  hostname: String! @iac_computed
  """
  Hostname the Portal treats as canonical: the generated hostname or a READY custom alias.
  """
  canonicalHostname: String! @iac_computed
  """Public URL of the generated address, once Control has assigned it."""
  publicURL: String @iac_computed
  """Control-assigned handle within the generated address, once assigned."""
  portalHandle: String @iac_computed
  """Control's address allocation as a `paa_` TypeID, once assigned."""
  provisioningID: PortalAddressAllocationID @iac_computed
  """Whether Control has assigned the generated address."""
  domainStatus: PortalDomainProvisioningStatus! @iac_computed
  """
  Whether the Portal serves visitors. An inactive Portal can still be authored and previewed.
  """
  isActive: Boolean!
  """Path visitors land on at the Portal root."""
  landingPath: String!
  """
  IAM policies forming the Portal's ceiling; every Portal grant is intersected with them. Input order round-trips.
  """
  policyIds: [IAMPolicyID!]! @iac_ref(resource: "iam_policy")
  """
  IAM policies granted to anonymous visitors, intersected with the ceiling. Empty grants nothing.
  """
  guestPolicyIds: [IAMPolicyID!]! @iac_ref(resource: "iam_policy")
  """Audience bindings choosing which site each kind of visitor is served."""
  audiences: [PortalAudience!]! @iac_writtenBy(operation: "setPortalAudiences", argument: "audiences")
  """
  Revision incremented on every change; pass it as `expectedRevision` to reject stale writes.
  """
  revision: Int! @iac_computed
}