PortalAuthenticatedUser

February 25, 2026 ยท View on GitHub

Information about the authenticated portal user.

Fields

FieldTypeRequiredDescription
typestr:heavy_check_mark:Type of authenticated user: 'customer' or 'member'
nameNullable[str]:heavy_check_mark:User's name, if available.
emailstr:heavy_check_mark:User's email address.
customer_idstr:heavy_check_mark:Associated customer ID.
member_idOptionalNullable[str]:heavy_minus_sign:Member ID. Only set for members.
roleOptionalNullable[str]:heavy_minus_sign:Member role (owner, billing_manager, member). Only set for members.