API Endpoints Guarded by API Keys
FusionAuth exposes a REST API. This page lists API endpoints that leverage API Keys along with the supported HTTP methods.
For full request and response documentation, see the API reference.
Authentication#
The Auth column shows the API key scope required for each endpoint:
API Key Authentication — a tenant-scoped or global API key may be used.
Global API Key Authentication — only a global API key may be used.
Endpoint List#
| Endpoint | GET | POST | PUT | PATCH | DELETE | Auth |
|---|---|---|---|---|---|---|
| /api/application | ✓ | ✓ | ✓ | ✓ | ✓ | |
| /api/application/oauth-configuration | ✓ | – | – | – | – | |
| /api/application/role | – | ✓ | ✓ | ✓ | ✓ | |
| /api/application/scope | ✓ | ✓ | ✓ | ✓ | ✓ | |
| /api/application/search | ✓ | ✓ | – | – | – | |
| /api/cleanspeak/notify | – | ✓ | – | – | – | |
| /api/connector | ✓ | ✓ | ✓ | ✓ | ✓ | |
| /api/consent | ✓ | ✓ | ✓ | ✓ | ✓ | |
| /api/consent/search | ✓ | ✓ | – | – | – | |
| /api/email/send | – | ✓ | – | – | – | |
| /api/email/template | ✓ | ✓ | ✓ | ✓ | ✓ | |
| /api/email/template/preview | – | ✓ | – | – | – | |
| /api/email/template/search | ✓ | ✓ | – | – | – | |
| /api/entity | ✓ | ✓ | ✓ | ✓ | ✓ | |
| /api/entity/grant | ✓ | ✓ | ✓ | – | ✓ | |
| /api/entity/grant/search | ✓ | ✓ | – | – | – | |
| /api/entity/search | ✓ | ✓ | ✓ | – | – | |
| /api/entity/type | ✓ | ✓ | ✓ | ✓ | ✓ | |
| /api/entity/type/permission | – | ✓ | ✓ | ✓ | ✓ | |
| /api/entity/type/search | ✓ | ✓ | – | – | – | |
| /api/form | ✓ | ✓ | ✓ | ✓ | ✓ | |
| /api/form/field | ✓ | ✓ | ✓ | ✓ | ✓ | |
| /api/group | ✓ | ✓ | ✓ | ✓ | ✓ | |
| /api/group/member | – | ✓ | ✓ | – | ✓ | |
| /api/group/member/search | ✓ | ✓ | – | – | – | |
| /api/group/search | ✓ | ✓ | – | – | – | |
| /api/identity-provider | ✓ | ✓ | ✓ | ✓ | ✓ | |
| /api/identity-provider/link | ✓ | ✓ | – | – | ✓ | |
| /api/identity-provider/link/pending | ✓ | – | – | – | – | |
| /api/identity-provider/search | ✓ | ✓ | – | – | – | |
| /api/identity-provider/test | ✓ | ✓ | – | – | – | |
| /api/identity/verify | – | ✓ | – | – | – | |
| /api/identity/verify/complete | – | ✓ | – | – | – | |
| /api/identity/verify/send | – | ✓ | – | – | – | |
| /api/identity/verify/start | – | ✓ | – | – | – | |
| /api/integration | ✓ | – | ✓ | ✓ | – | |
| /api/ip-acl | ✓ | ✓ | ✓ | ✓ | ✓ | |
| /api/ip-acl/search | ✓ | ✓ | – | – | – | |
| /api/jwt/refresh | ✓ | ✓ | – | – | ✓ | |
| /api/jwt/vend | – | ✓ | – | – | – | |
| /api/key | ✓ | – | ✓ | – | ✓ | |
| /api/key/generate | – | ✓ | – | – | – | |
| /api/key/import | – | ✓ | – | – | – | |
| /api/key/search | ✓ | ✓ | – | – | – | |
| /api/lambda | ✓ | ✓ | ✓ | ✓ | ✓ | |
| /api/lambda/search | ✓ | ✓ | – | – | – | |
| /api/logger | ✓ | ✓ | – | – | – | |
| /api/login | – | ✓ | ✓ | – | – | |
| /api/message/template | ✓ | ✓ | ✓ | ✓ | ✓ | |
| /api/message/template/preview | – | ✓ | – | – | – | |
| /api/messenger | ✓ | ✓ | ✓ | ✓ | ✓ | |
| /api/passwordless/start | – | ✓ | – | – | – | |
| /api/prometheus/metrics | ✓ | – | – | – | – | |
| /api/reactor | ✓ | ✓ | ✓ | – | ✓ | |
| /api/reactor/metrics | ✓ | – | – | – | – | |
| /api/report/daily-active-user | ✓ | – | – | – | – | |
| /api/report/login | ✓ | – | – | – | – | |
| /api/report/monthly-active-user | ✓ | – | – | – | – | |
| /api/report/registration | ✓ | – | – | – | – | |
| /api/report/totals | ✓ | – | – | – | – | |
| /api/status | ✓ | – | – | – | – | |
| /api/system-configuration | ✓ | ✓ | ✓ | ✓ | – | |
| /api/system/audit-log | ✓ | ✓ | – | – | – | |
| /api/system/audit-log/export | ✓ | ✓ | – | – | – | |
| /api/system/audit-log/search | ✓ | ✓ | – | – | – | |
| /api/system/event-log | ✓ | – | – | – | – | |
| /api/system/event-log/search | ✓ | ✓ | – | – | – | |
| /api/system/log/export | ✓ | ✓ | – | – | – | |
| /api/system/login-record/export | ✓ | ✓ | – | – | – | |
| /api/system/login-record/search | ✓ | ✓ | – | – | – | |
| /api/system/reindex | ✓ | ✓ | – | – | – | |
| /api/system/version | ✓ | – | – | – | – | |
| /api/system/webhook-attempt-log | ✓ | – | – | – | – | |
| /api/system/webhook-event-log | ✓ | – | – | – | – | |
| /api/system/webhook-event-log/search | ✓ | ✓ | – | – | – | |
| /api/tenant | ✓ | ✓ | ✓ | ✓ | ✓ | |
| /api/tenant-manager | ✓ | ✓ | ✓ | ✓ | – | |
| /api/tenant-manager/identity-provider | – | ✓ | ✓ | ✓ | ✓ | |
| /api/tenant/search | ✓ | ✓ | – | – | – | |
| /api/theme | ✓ | ✓ | ✓ | ✓ | ✓ | |
| /api/theme/search | ✓ | ✓ | – | – | – | |
| /api/two-factor/secret | ✓ | – | – | – | – | |
| /api/two-factor/send | – | ✓ | – | – | – | |
| /api/two-factor/start | – | ✓ | – | – | – | |
| /api/two-factor/status | ✓ | ✓ | – | – | – | |
| /api/user | ✓ | ✓ | ✓ | ✓ | ✓ | |
| /api/user-action | ✓ | ✓ | ✓ | ✓ | ✓ | |
| /api/user-action-reason | ✓ | ✓ | ✓ | ✓ | ✓ | |
| /api/user/action | ✓ | ✓ | ✓ | – | ✓ | |
| /api/user/bulk | – | – | – | – | ✓ | |
| /api/user/change-password | ✓ | ✓ | – | – | – | |
| /api/user/comment | ✓ | ✓ | – | – | – | |
| /api/user/comment/search | ✓ | ✓ | – | – | – | |
| /api/user/consent | ✓ | ✓ | ✓ | ✓ | ✓ | |
| /api/user/family | ✓ | ✓ | ✓ | – | ✓ | |
| /api/user/family/pending | ✓ | – | – | – | – | |
| /api/user/family/request | – | ✓ | – | – | – | |
| /api/user/forgot-password | – | ✓ | – | – | – | |
| /api/user/import | – | ✓ | – | – | – | |
| /api/user/recent-login | ✓ | – | – | – | – | |
| /api/user/refresh-token/import | – | ✓ | – | – | – | |
| /api/user/registration | ✓ | ✓ | ✓ | ✓ | ✓ | |
| /api/user/search | ✓ | ✓ | ✓ | – | – | |
| /api/user/two-factor | – | ✓ | – | – | ✓ | |
| /api/user/two-factor/recovery-code | ✓ | ✓ | – | – | – | |
| /api/user/verify-email | – | ✓ | ✓ | – | – | |
| /api/user/verify-registration | – | ✓ | ✓ | – | – | |
| /api/webauthn | ✓ | – | – | – | ✓ | |
| /api/webauthn/import | – | ✓ | – | – | – | |
| /api/webauthn/register/start | – | ✓ | – | – | – | |
| /api/webauthn/start | – | ✓ | – | – | – | |
| /api/webhook | ✓ | ✓ | ✓ | ✓ | ✓ | |
| /api/webhook/search | ✓ | ✓ | – | – | – | |
| /oauth2/device/user-code | – | ✓ | – | – | – | |
No endpoints match your filter.