Read Authenticated Portal User
Intent
Reads the authenticated portal user without changing it.
When to call it
Call this after your application has received or stored the identifier for the authenticated portal user.
Access boundary
Authorize the request with a token that carries customer_portal:read or customer_portal:write.
Successful result
A successful request returns 200. The response schema below defines the body your integration receives.
Operational notes
Get information about the currently authenticated portal user.
Scopes: customer_portal:read customer_portal:write
Authorizations
Customer session tokens are specific tokens that are used to authenticate customers on your organization. You can create those sessions programmatically using the Create Customer Session endpoint.
Response
Successful Response
Information about the authenticated portal user.
Type of authenticated user: 'customer' or 'member'
User's name, if available.
User's email address.
Associated customer ID.
Member ID. Only set for members.
Member role (owner, billing_manager, member). Only set for members.