Skip to content
This repository has been archived by the owner on Apr 23, 2024. It is now read-only.

Latest commit

 

History

History
131 lines (125 loc) · 28.1 KB

ROADMAP.md

File metadata and controls

131 lines (125 loc) · 28.1 KB
Raw

Roadmap

FusionAuth provides many resources and APIs which all need to be documented and built in Terraform's expected data schema.

Resources

Based on FusionAuth 1.36.8 the following API Endpoints are available. This does not mean that each endpoint provides a manageable resource. As such, each endpoint will need to be cross-referenced with the API documentation to check if it provides a candidate to come under the management of terraform.

Legend Description
✔️ Yes. Can be developed.
❌ No: Either not technically possible, or provides no benefit to being under Terraform management.
❓ To be decided.
Endpoint Supported Methods Paid Feature Resource Candidate Data Source Candidate API Documentation Link
/api/api-key C R U D ✔️ ❓ https://fusionauth.io/docs/v1/tech/apis/api-keys
/api/application C R U D ✔️ ✔️ https://fusionauth.io/docs/v1/tech/apis/applications
/api/application/oauth-configuration - R - - ❌ ❓ https://fusionauth.io/docs/v1/tech/apis/applications#retrieve-oauth-configuration
/api/application/role C - U D ✔️ ❌ https://fusionauth.io/docs/v1/tech/apis/applications#create-an-application-role
/api/cleanspeak/notify - - - - ❌ ❌ ❓
/api/connector C R U D 💲 ✔️ ❓ https://fusionauth.io/docs/v1/tech/apis/connectors
/api/consent C R U D ✔️ ❓ https://fusionauth.io/docs/v1/tech/apis/consents
/api/email/send C - - - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/emails#send-an-email
/api/email/template C R U D ✔️ ❓ https://fusionauth.io/docs/v1/tech/apis/emails#create-an-email-template
/api/email/template/preview C - - - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/emails#preview-an-email-template
/api/entity C R U D 💲 ✔️ ❓ https://fusionauth.io/docs/v1/tech/apis/entity-management/entities
/api/entity/grant C R U D 💲 ✔️ ❓ https://fusionauth.io/docs/v1/tech/apis/entity-management/grants
/api/entity/grant/search - R - - 💲 ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/entity-management/grants#search-for-grants
/api/entity/search - R - - 💲 ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/entity-management/entities#search-for-entities
/api/entity/type C R U D 💲 ✔️ ❓ https://fusionauth.io/docs/v1/tech/apis/entity-management/entity-types
/api/entity/type/permission C R U D 💲 ✔️ ❓ https://fusionauth.io/docs/v1/tech/apis/entity-management/entity-types#create-an-entity-type-permission
/api/entity/type/search - R - - 💲 ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/entity-management/entity-types#search-for-an-entity-type
/api/form C R U D ✔️ ❓ https://fusionauth.io/docs/v1/tech/apis/forms
/api/form/field C R U D ✔️ ❓ https://fusionauth.io/docs/v1/tech/apis/form-fields
/api/group C R U D ✔️ ❓ https://fusionauth.io/docs/v1/tech/apis/groups
/api/group/member C - U D ✔️ ❓ https://fusionauth.io/docs/v1/tech/apis/groups#add-users-to-a-group
/api/group/member/search - R - - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/groups#search-for-group-members
/api/identity-provider C R U D ❌ ✔️ https://fusionauth.io/docs/v1/tech/apis/identity-providers/
/api/identity-provider (Apple) C R U D ✔️ ❌ https://fusionauth.io/docs/v1/tech/apis/identity-providers/apple
/api/identity-provider (Epic Games) C R U D 💲 ✔️ ❌ https://fusionauth.io/docs/v1/tech/apis/identity-providers/epicgames
/api/identity-provider (External JWT) C R U D ✔️ ❌ https://fusionauth.io/docs/v1/tech/apis/identity-providers/external-jwt
/api/identity-provider (Facebook) C R U D ✔️ ❌ https://fusionauth.io/docs/v1/tech/apis/identity-providers/facebook
/api/identity-provider (Google) C R U D ✔️ ❌ https://fusionauth.io/docs/v1/tech/apis/identity-providers/google
/api/identity-provider (HYPR) C R U D ✔️ ❌ https://fusionauth.io/docs/v1/tech/apis/identity-providers/hypr
/api/identity-provider (LinkedIn) C R U D ✔️ ❌ https://fusionauth.io/docs/v1/tech/apis/identity-providers/linkedin
/api/identity-provider (Nintendo) C R U D 💲 ✔️ ❌ https://fusionauth.io/docs/v1/tech/apis/identity-providers/nintendo
/api/identity-provider (OpenID Connect) C R U D ✔️ ❌ https://fusionauth.io/docs/v1/tech/apis/identity-providers/openid-connect
/api/identity-provider (SAMLv2) C R U D ✔️ ❌ https://fusionauth.io/docs/v1/tech/apis/identity-providers/samlv2
/api/identity-provider (SAMLv2 IDP Initiated) C R U D 💲 ✔️ ❌ https://fusionauth.io/docs/v1/tech/apis/identity-providers/samlv2-idp-initiated
/api/identity-provider (Sony PSN) C R U D 💲 ✔️ ❌ https://fusionauth.io/docs/v1/tech/apis/identity-providers/sonypsn
/api/identity-provider (Steam) C R U D 💲 ✔️ ❌ https://fusionauth.io/docs/v1/tech/apis/identity-providers/steam
/api/identity-provider (Twitch) C R U D 💲 ✔️ ❌ https://fusionauth.io/docs/v1/tech/apis/identity-providers/twitch
/api/identity-provider (Twitter) C R U D ✔️ ❌ https://fusionauth.io/docs/v1/tech/apis/identity-providers/twitter
/api/identity-provider (Xbox) C R U D 💲 ✔️ ❌ https://fusionauth.io/docs/v1/tech/apis/identity-providers/xbox
/api/identity-provider/link C R - D ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/identity-providers/links
/api/integration - R U - ✔️ ❓ https://fusionauth.io/docs/v1/tech/apis/integrations
/api/ip-acl C R U D 💲1 ✔️ ❓ https://fusionauth.io/docs/v1/tech/apis/ip-acl
/api/ip-acl/search - R - - ❌ ❓ https://fusionauth.io/docs/v1/tech/apis/ip-acl#search-for-ip-acls
/api/jwt/issue - R - - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/jwt#issue-a-jwt
/api/jwt/refresh C - - - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/jwt#refresh-a-jwt
/api/jwt/validate - R - - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/jwt#validate-a-jwt
/api/jwt/vend C - - - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/jwt#vend-a-jwt
/api/key - R U* D ✔️ ❓ https://fusionauth.io/docs/v1/tech/apis/keys
/api/key/generate C - - - ✔️ ❓ https://fusionauth.io/docs/v1/tech/apis/keys#generate-a-key
/api/key/import C - - - ✔️ ❓ https://fusionauth.io/docs/v1/tech/apis/keys#import-a-key
/api/lambda C R U D ✔️ ❓ https://fusionauth.io/docs/v1/tech/apis/lambdas
/api/logger - R U - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/system#retrieve-the-logging-level
/api/login - - - - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/login
/api/message/template C R U D ✔️ ❓ https://fusionauth.io/docs/v1/tech/apis/message-templates
/api/message/template/preview - R - - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/message-templates#preview-a-message-template
/api/messenger - R - - ❌ ✔️ https://fusionauth.io/docs/v1/tech/apis/messengers/
/api/messenger/generic C R U D ✔️ ❌ https://fusionauth.io/docs/v1/tech/apis/messengers/generic
/api/messenger/kafka C R U D ✔️ ❌ https://fusionauth.io/docs/v1/tech/apis/messengers/kafka
/api/messenger/twilio C R U D ✔️ ❌ https://fusionauth.io/docs/v1/tech/apis/messengers/twilio
/api/passwordless/start C - - - 💲 ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/passwordless
/api/prometheus/metrics - R - - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/system#retrieve-system-metrics-using-prometheus
/api/reactor C R - D 💲 ✔️ ❓ https://fusionauth.io/docs/v1/tech/apis/reactor
/api/reactor/metrics - R - - 💲 ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/reactor#retrieve-reactor-metrics
/api/report/daily-active-user - R - - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/reports#generate-daily-active-users-report
/api/report/login - R - - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/reports#generate-login-report
/api/report/monthly-active-user - R - - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/reports#generate-monthly-active-users-report
/api/report/registration - R - - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/reports#generate-registration-report
/api/report/totals - R - - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/reports#generate-totals-report
/api/scim/resource/v2/EnterpriseUsers C R U D 💲 ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/scim/SCIMEnterpriseUser
/api/scim/resource/v2/Groups C R U D 💲 ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/scim/SCIMGroup
/api/scim/resource/v2/Users C R U D 💲 ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/scim/SCIMUser
/api/status C R U D ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/system#retrieve-system-status
/api/system-configuration - R U - ✔️ ❌ https://fusionauth.io/docs/v1/tech/apis/system#update-the-system-configuration
/api/system/audit-log C R - - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/audit-logs
/api/system/audit-log/export - R - - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/audit-logs#export-audit-logs
/api/system/audit-log/search - R - - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/audit-logs#search-the-audit-log
/api/system/event-log C R U D ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/event-logs
/api/system/event-log/search - R - - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/event-logs#search-event-logs
/api/system/log/export - R - - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/system#export-system-logs
/api/system/login-record/export - R - - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/login#export-login-records
/api/system/login-record/search - R - - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/login#search-login-records
/api/system/reindex C - - - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/system#rebuild-the-elasticsearch-index
/api/system/version - R - - ❌ ✔️ https://fusionauth.io/docs/v1/tech/apis/system#retrieve-system-version
/api/tenant C R U D ✔️ ✔️ https://fusionauth.io/docs/v1/tech/apis/tenants
/api/theme C R U D ✔️ ❓ https://fusionauth.io/docs/v1/tech/apis/themes
/api/two-factor/secret - R - - 💲 ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/two-factor#generate-a-secret
/api/two-factor/send C - - - 💲 ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/two-factor#send-a-multi-factor-code-when-enabling-mfa
/api/two-factor/start C - - - 💲 ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/two-factor#start-multi-factor
/api/user C R U D ✔️ ✔️ https://fusionauth.io/docs/v1/tech/apis/users
/api/user-action C R U D ✔️ ❓ https://fusionauth.io/docs/v1/tech/apis/user-actions
/api/user-action-reason C R U D ✔️ ❓ https://fusionauth.io/docs/v1/tech/apis/user-action-reasons
/api/user/action C R U D ✔️ ❓ https://fusionauth.io/docs/v1/tech/apis/actioning-users
/api/user/bulk - - - D ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/users#bulk-delete-users
/api/user/change-password C - - - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/users#change-a-users-password
/api/user/comment C R - - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/user-comments
/api/user/consent C R U D ✔️ ❓ https://fusionauth.io/docs/v1/tech/apis/consents#grant-a-user-consent
/api/user/family C R U D ✔️ ❓ https://fusionauth.io/docs/v1/tech/apis/families
/api/user/family/pending - R - - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/families#retrieve-pending-family-members
/api/user/family/request C - - - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/families#request-parental-approval
/api/user/forgot-password C - - - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/users#start-forgot-password-workflow
/api/user/import C - - - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/users#import-users
/api/user/recent-login - R - - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/users#retrieve-recent-logins
/api/user/refresh-token/import C - - - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/users#import-refresh-tokens
/api/user/registration C R U D ✔️ ❓ https://fusionauth.io/docs/v1/tech/apis/registrations
/api/user/search - R - - ❌ ✔️ https://fusionauth.io/docs/v1/tech/apis/users#search-for-users
/api/user/two-factor C - - D ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/two-factor#enable-multi-factor
/api/user/two-factor/recovery-code C R - - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/two-factor#generate-recovery-codes
/api/user/verify-email C - U - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/users#verify-a-users-email
/api/user/verify-registration C - U - ❌ ❌ https://fusionauth.io/docs/v1/tech/apis/registrations#verify-a-user-registration
/api/webhook C R U D ✔️ ❓ https://fusionauth.io/docs/v1/tech/apis/webhooks
  1. while you can create and manage IP ACLs, you can't apply an ACL to a Tenant without having a paid FusionAuth license