PortalLink

A secure, time-limited URL that grants access to the Admin Portal for organization administrators to configure SSO, Directory Sync, and other enterprise settings.

Properties

• id (string): Unique identifier for the portal link.
• organization ([[Organization]]): The organization this portal link is for.
• intent (string): Portal intent (sso, dsync, audit-logs, domain-verification).
• url ([[URL]]): The generated portal URL.
• token (string): Secure token embedded in the URL.
• expiresAt (number): Timestamp when the link expires (Unix timestamp).
• returnUrl ([[URL]]): URL to redirect to after portal session completes.
• email ([[EmailAddress]]): Email of the admin user accessing the portal.
• status (string): Link status (active, used, expired, revoked).
• usedAt (number): Timestamp when link was first used (Unix timestamp).
• created (number): Timestamp when link was created (Unix timestamp).
• createdBy ([[User]]): User who generated the portal link.
• metadata (object): Set of key-value pairs for storing additional information.

Actions

generate

Generate a new admin portal link.

Input: [[PortalLinkRequest]]
Output: [[PortalLink]]

revoke

Revoke an active portal link.

Input: [[PortalLink]]
Output: [[PortalLink]]

verify

Verify the link is valid and not expired.

Input: [[PortalLink]]
Output: boolean

Events

• generated: Triggered when a new portal link is generated.
• used: Triggered when portal link is first accessed.
• expired: Triggered when portal link expires.
• revoked: Triggered when portal link is revoked.