Static analyticsRetrieve aggregated user analytics for the admin directory.
Supported params include search, is_site_admin, is_verified,
user_type, start_date, end_date, period, sort_by, and
sort_order.
Optional params: Record<string, any>Optional query parameters.
promise
Static impersonateImpersonate a user. Issues a JWT for the target account so a Super Administrator can operate as that user. Administrator accounts cannot be impersonated, and every call is written to the impersonation audit log.
The id of the user to impersonate.
promise resolving to an access token and the impersonated user summary.
Static listList and search all users in the system.
Supported params include search (matches name, username, email, or id),
is_site_admin, is_verified, sort_by, sort_order, per_page, and
page.
Optional params: Record<string, any>Optional query parameters.
promise
Static viewRetrieve a comprehensive profile for a single user, including communities, administered titles, games played, roles, billing status, social presence, and activity counts.
The id of the user to view.
Optional params: Record<string, any>Optional query parameters.
promise
Generated using TypeDoc
Site-administrator user management.
These endpoints back the admin dashboard user directory. They require a site-admin auth token (Super Administrator or Administrator), and impersonation additionally requires a Super Administrator token.