← All resources

Resource

portal

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

GraphQL reference →

Configuration

idempotencyKeyStringRequiredSet on creation

Stable caller key for retry-safe generated domain allocation.

set once, at creation

nameString!Required

Display name of the Portal.

isActiveBoolean!Optional

Whether the Portal serves visitors once ready; omit for the default.

landingPathString!Optional

Path visitors land on at the Portal root; omit for the default.

policyIds[IAMPolicyID!]!Optional

IAM policies forming the Portal ceiling. Requires permission to attach each policy.

References iam_policy

guestPolicyIds[IAMPolicyID!]!Optional

IAM policies granted to anonymous visitors, intersected with the ceiling. Omit to grant nothing.

References iam_policy

audiences[PortalAudience!]!Optional

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

View PortalAudience fields →

written by `setPortalAudiences`, not by this resource's update

Input types

Fields for the structured values used in this resource’s configuration.

PortalAudience

Routes one audience of a Portal to one of its sites.

audiencePortalAudienceKind!Required

Which visitors the binding applies to.

Allowed values

GUEST — Anonymous visitors without a Portal session.

AUTHENTICATED — Signed-in PortalUsers, with or without a selected customer membership.

CUSTOMER_ROLE — Signed-in members whose current customer membership carries the binding's role.

roleStringOptional

Membership role a CUSTOMER_ROLE binding requires; null for other audiences.

siteIdPortalSiteID!Required

Site served to visitors matching the binding.

Read-only values

Show values
idPortalID!Read only

Unique Portal identifier.

computed by the platform

hostnameString!Read only

Generated hostname assigned by Control; clients never choose it.

computed by the platform

canonicalHostnameString!Read only

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

computed by the platform

publicURLStringRead only

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

computed by the platform

portalHandleStringRead only

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

computed by the platform

provisioningIDPortalAddressAllocationIDRead only

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

computed by the platform

domainStatusPortalDomainProvisioningStatus!Read only

Whether Control has assigned the generated address.

Allowed values

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

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

computed by the platform

revisionInt!Read only

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

computed by the platform

Lifecycle

The CLI can create this resource. The platform assigns its id.

When replacement is needed, the existing resource is removed before its replacement is created.