/api/admin/send-daily-reportAdminSend the daily admin report (administrators)
Builds the last 24 hours' activity report (new users, organizations, organization MFA enforcement, captured server errors, summary statistics of the client error reports received, most active users, most popular apps and APIs, with links into the admin console) and e-mails it to the administrator mailing list. Lets a platform administrator run the job by hand; the scheduled job calls GET with the cron secret instead.
post_api_admin_send_daily_reportAdministrationAuthentication & permissionsAdmin
Platform administrators only
- Accepted credentials
- Auth server session (refresh token cookie)
cookie "refresh_token_<auth_server_app_id>" - Access token (cookie)
cookie "access_token_<auth_server_app_id>" - Access token (Bearer)
Authorization: Bearer <JWT>
- Auth server session (refresh token cookie)
- Who may call
- Platform administrators only
- Notes
- Only platform administrators may run the job by hand; the cron secret is not accepted here (it is GET's credential).
Responses
| Property | Type | Description |
|---|---|---|
| ok* | true | |
| users_count* | integer | |
| organizations_count* | integer | |
| errors_count* | integer | |
| active_users_count* | integer | Users with any activity (a sign-in or an issued token) during the window |
| top_most_active_users_count* | integer | Most active users the report lists (at most 10 of |
| active_apps_count* | integer | Applications that issued a token (access or refresh) during the window |
| top_most_popular_apps_count* | integer | Most popular applications the report lists (at most 10 of |
| active_apis_count* | integer | API servers (token audiences) that received a token during the window |
| top_most_popular_apis_count* | integer | Most popular APIs the report lists (at most 10 of |
| client_errors_count* | integer | Client error reports received during the window |
| client_error_groups_count* | integer | Distinct client error groups (fingerprints) among those reports |
| organization_mfa_removals_count* | integer | Members the organization MFA enforcement removed from organizations during the window |
| window_start* | string (date-time) | Start of the 24h reporting window |
| window_end* | string (date-time) | End of the 24h reporting window (now) |
Example request
curl -X POST 'https://auth.schemavaults.com/api/admin/send-daily-report' \
-b 'refresh_token_<auth_server_app_id>=<value>'