Resource
portal
A customer-facing web Portal: its address, IAM ceiling and audience-to-site routing.
Configuration
idempotencyKeyStringRequiredSet on creationStable caller key for retry-safe generated domain allocation.
set once, at creation
nameString!RequiredDisplay name of the Portal.
isActiveBoolean!OptionalWhether the Portal serves visitors once ready; omit for the default.
landingPathString!OptionalPath visitors land on at the Portal root; omit for the default.
policyIds[IAMPolicyID!]!OptionalIAM policies forming the Portal ceiling. Requires permission to attach each policy.
References iam_policy
guestPolicyIds[IAMPolicyID!]!OptionalIAM policies granted to anonymous visitors, intersected with the ceiling. Omit to grant nothing.
References iam_policy
audiences[PortalAudience!]!OptionalAudience bindings choosing which site each kind of visitor is served.
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!RequiredWhich 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.
roleStringOptionalMembership role a CUSTOMER_ROLE binding requires; null for other audiences.
siteIdPortalSiteID!RequiredSite served to visitors matching the binding.
Read-only values
Show values
idPortalID!Read onlyUnique Portal identifier.
computed by the platform
hostnameString!Read onlyGenerated hostname assigned by Control; clients never choose it.
computed by the platform
canonicalHostnameString!Read onlyHostname the Portal treats as canonical: the generated hostname or a READY custom alias.
computed by the platform
publicURLStringRead onlyPublic URL of the generated address, once Control has assigned it.
computed by the platform
portalHandleStringRead onlyControl-assigned handle within the generated address, once assigned.
computed by the platform
provisioningIDPortalAddressAllocationIDRead onlyControl's address allocation as a paa_ TypeID, once assigned.
computed by the platform
domainStatusPortalDomainProvisioningStatus!Read onlyWhether 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 onlyRevision 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.