Enums§
- Action
User With IdError - struct for typed errors of method
action_user_with_id
- Activate
Reactor With IdError - struct for typed errors of method
activate_reactor_with_id
- Approve
Device With IdError - struct for typed errors of method
approve_device_with_id
- Cancel
Action With IdError - struct for typed errors of method
cancel_action_with_id
- Change
Password ByIdentity With IdError - struct for typed errors of method
change_password_by_identity_with_id
- Change
Password With IdError - struct for typed errors of method
change_password_with_id
- Check
Change Password Using IdWith IdError - struct for typed errors of method
check_change_password_using_id_with_id
- Comment
OnUser With IdError - struct for typed errors of method
comment_on_user_with_id
- Complete
WebAuthn Assertion With IdError - struct for typed errors of method
complete_web_authn_assertion_with_id
- Complete
WebAuthn Login With IdError - struct for typed errors of method
complete_web_authn_login_with_id
- Complete
WebAuthn Registration With IdError - struct for typed errors of method
complete_web_authn_registration_with_id
- Create
ApiKey Error - struct for typed errors of method
create_api_key
- Create
ApiKey With IdError - struct for typed errors of method
create_api_key_with_id
- Create
Application Error - struct for typed errors of method
create_application
- Create
Application Role Error - struct for typed errors of method
create_application_role
- Create
Application Role With IdError - struct for typed errors of method
create_application_role_with_id
- Create
Application With IdError - struct for typed errors of method
create_application_with_id
- Create
Audit LogWith IdError - struct for typed errors of method
create_audit_log_with_id
- Create
Connector Error - struct for typed errors of method
create_connector
- Create
Connector With IdError - struct for typed errors of method
create_connector_with_id
- Create
Consent Error - struct for typed errors of method
create_consent
- Create
Consent With IdError - struct for typed errors of method
create_consent_with_id
- Create
Email Template Error - struct for typed errors of method
create_email_template
- Create
Email Template With IdError - struct for typed errors of method
create_email_template_with_id
- Create
Entity Error - struct for typed errors of method
create_entity
- Create
Entity Type Error - struct for typed errors of method
create_entity_type
- Create
Entity Type Permission Error - struct for typed errors of method
create_entity_type_permission
- Create
Entity Type Permission With IdError - struct for typed errors of method
create_entity_type_permission_with_id
- Create
Entity Type With IdError - struct for typed errors of method
create_entity_type_with_id
- Create
Entity With IdError - struct for typed errors of method
create_entity_with_id
- Create
Family Error - struct for typed errors of method
create_family
- Create
Family With IdError - struct for typed errors of method
create_family_with_id
- Create
Form Error - struct for typed errors of method
create_form
- Create
Form Field Error - struct for typed errors of method
create_form_field
- Create
Form Field With IdError - struct for typed errors of method
create_form_field_with_id
- Create
Form With IdError - struct for typed errors of method
create_form_with_id
- Create
Group Error - struct for typed errors of method
create_group
- Create
Group Members With IdError - struct for typed errors of method
create_group_members_with_id
- Create
Group With IdError - struct for typed errors of method
create_group_with_id
- Create
Identity Provider Error - struct for typed errors of method
create_identity_provider
- Create
Identity Provider With IdError - struct for typed errors of method
create_identity_provider_with_id
- Create
Introspect Error - struct for typed errors of method
create_introspect
- Create
IpAccess Control List Error - struct for typed errors of method
create_ip_access_control_list
- Create
IpAccess Control List With IdError - struct for typed errors of method
create_ip_access_control_list_with_id
- Create
Lambda Error - struct for typed errors of method
create_lambda
- Create
Lambda With IdError - struct for typed errors of method
create_lambda_with_id
- Create
Logout Error - struct for typed errors of method
create_logout
- Create
Message Template Error - struct for typed errors of method
create_message_template
- Create
Message Template With IdError - struct for typed errors of method
create_message_template_with_id
- Create
Messenger Error - struct for typed errors of method
create_messenger
- Create
Messenger With IdError - struct for typed errors of method
create_messenger_with_id
- CreateO
Auth Scope Error - struct for typed errors of method
create_o_auth_scope
- CreateO
Auth Scope With IdError - struct for typed errors of method
create_o_auth_scope_with_id
- Create
Tenant Error - struct for typed errors of method
create_tenant
- Create
Tenant With IdError - struct for typed errors of method
create_tenant_with_id
- Create
Theme Error - struct for typed errors of method
create_theme
- Create
Theme With IdError - struct for typed errors of method
create_theme_with_id
- Create
Token Error - struct for typed errors of method
create_token
- Create
User Action Error - struct for typed errors of method
create_user_action
- Create
User Action Reason Error - struct for typed errors of method
create_user_action_reason
- Create
User Action Reason With IdError - struct for typed errors of method
create_user_action_reason_with_id
- Create
User Action With IdError - struct for typed errors of method
create_user_action_with_id
- Create
User Consent Error - struct for typed errors of method
create_user_consent
- Create
User Consent With IdError - struct for typed errors of method
create_user_consent_with_id
- Create
User Error - struct for typed errors of method
create_user
- Create
User Link With IdError - struct for typed errors of method
create_user_link_with_id
- Create
User Verify Email Error - struct for typed errors of method
create_user_verify_email
- Create
User With IdError - struct for typed errors of method
create_user_with_id
- Create
Webhook Error - struct for typed errors of method
create_webhook
- Create
Webhook With IdError - struct for typed errors of method
create_webhook_with_id
- Delete
ApiKey With IdError - struct for typed errors of method
delete_api_key_with_id
- Delete
Application Role With IdError - struct for typed errors of method
delete_application_role_with_id
- Delete
Application With IdError - struct for typed errors of method
delete_application_with_id
- Delete
Connector With IdError - struct for typed errors of method
delete_connector_with_id
- Delete
Consent With IdError - struct for typed errors of method
delete_consent_with_id
- Delete
Email Template With IdError - struct for typed errors of method
delete_email_template_with_id
- Delete
Entity Grant With IdError - struct for typed errors of method
delete_entity_grant_with_id
- Delete
Entity Type Permission With IdError - struct for typed errors of method
delete_entity_type_permission_with_id
- Delete
Entity Type With IdError - struct for typed errors of method
delete_entity_type_with_id
- Delete
Entity With IdError - struct for typed errors of method
delete_entity_with_id
- Delete
Form Field With IdError - struct for typed errors of method
delete_form_field_with_id
- Delete
Form With IdError - struct for typed errors of method
delete_form_with_id
- Delete
Group Members With IdError - struct for typed errors of method
delete_group_members_with_id
- Delete
Group With IdError - struct for typed errors of method
delete_group_with_id
- Delete
Identity Provider With IdError - struct for typed errors of method
delete_identity_provider_with_id
- Delete
IpAccess Control List With IdError - struct for typed errors of method
delete_ip_access_control_list_with_id
- Delete
JwtRefresh Error - struct for typed errors of method
delete_jwt_refresh
- Delete
KeyWith IdError - struct for typed errors of method
delete_key_with_id
- Delete
Lambda With IdError - struct for typed errors of method
delete_lambda_with_id
- Delete
Message Template With IdError - struct for typed errors of method
delete_message_template_with_id
- Delete
Messenger With IdError - struct for typed errors of method
delete_messenger_with_id
- DeleteO
Auth Scope With IdError - struct for typed errors of method
delete_o_auth_scope_with_id
- Delete
Tenant With IdError - struct for typed errors of method
delete_tenant_with_id
- Delete
Theme With IdError - struct for typed errors of method
delete_theme_with_id
- Delete
User Action Reason With IdError - struct for typed errors of method
delete_user_action_reason_with_id
- Delete
User Action With IdError - struct for typed errors of method
delete_user_action_with_id
- Delete
User Bulk Error - struct for typed errors of method
delete_user_bulk
- Delete
User Link With IdError - struct for typed errors of method
delete_user_link_with_id
- Delete
User Registration With IdError - struct for typed errors of method
delete_user_registration_with_id
- Delete
User TwoFactor With IdError - struct for typed errors of method
delete_user_two_factor_with_id
- Delete
User With IdError - struct for typed errors of method
delete_user_with_id
- Delete
WebAuthn Credential With IdError - struct for typed errors of method
delete_web_authn_credential_with_id
- Delete
Webhook With IdError - struct for typed errors of method
delete_webhook_with_id
- Enable
TwoFactor With IdError - struct for typed errors of method
enable_two_factor_with_id
- Exchange
Refresh Token ForJwt With IdError - struct for typed errors of method
exchange_refresh_token_for_jwt_with_id
- Forgot
Password With IdError - struct for typed errors of method
forgot_password_with_id
- Generate
KeyError - struct for typed errors of method
generate_key
- Generate
KeyWith IdError - struct for typed errors of method
generate_key_with_id
- Generate
TwoFactor Recovery Codes With IdError - struct for typed errors of method
generate_two_factor_recovery_codes_with_id
- Generate
TwoFactor Secret Using JwtWith IdError - struct for typed errors of method
generate_two_factor_secret_using_jwt_with_id
- Identity
Provider Login With IdError - struct for typed errors of method
identity_provider_login_with_id
- Import
KeyError - struct for typed errors of method
import_key
- Import
KeyWith IdError - struct for typed errors of method
import_key_with_id
- Import
Refresh Tokens With IdError - struct for typed errors of method
import_refresh_tokens_with_id
- Import
Users With IdError - struct for typed errors of method
import_users_with_id
- Import
WebAuthn Credential With IdError - struct for typed errors of method
import_web_authn_credential_with_id
- Issue
JwtWith IdError - struct for typed errors of method
issue_jwt_with_id
- Login
Ping With IdError - struct for typed errors of method
login_ping_with_id
- Login
Ping With Request With IdError - struct for typed errors of method
login_ping_with_request_with_id
- Login
With IdError - struct for typed errors of method
login_with_id
- Lookup
Identity Provider With IdError - struct for typed errors of method
lookup_identity_provider_with_id
- Modify
Action With IdError - struct for typed errors of method
modify_action_with_id
- Passwordless
Login With IdError - struct for typed errors of method
passwordless_login_with_id
- Patch
Application Role With IdError - struct for typed errors of method
patch_application_role_with_id
- Patch
Application With IdError - struct for typed errors of method
patch_application_with_id
- Patch
Connector With IdError - struct for typed errors of method
patch_connector_with_id
- Patch
Consent With IdError - struct for typed errors of method
patch_consent_with_id
- Patch
Email Template With IdError - struct for typed errors of method
patch_email_template_with_id
- Patch
Entity Type Permission With IdError - struct for typed errors of method
patch_entity_type_permission_with_id
- Patch
Entity Type With IdError - struct for typed errors of method
patch_entity_type_with_id
- Patch
Entity With IdError - struct for typed errors of method
patch_entity_with_id
- Patch
Form Field With IdError - struct for typed errors of method
patch_form_field_with_id
- Patch
Form With IdError - struct for typed errors of method
patch_form_with_id
- Patch
Group With IdError - struct for typed errors of method
patch_group_with_id
- Patch
Identity Provider With IdError - struct for typed errors of method
patch_identity_provider_with_id
- Patch
Integrations With IdError - struct for typed errors of method
patch_integrations_with_id
- Patch
IpAccess Control List With IdError - struct for typed errors of method
patch_ip_access_control_list_with_id
- Patch
Lambda With IdError - struct for typed errors of method
patch_lambda_with_id
- Patch
Message Template With IdError - struct for typed errors of method
patch_message_template_with_id
- Patch
Messenger With IdError - struct for typed errors of method
patch_messenger_with_id
- PatchO
Auth Scope With IdError - struct for typed errors of method
patch_o_auth_scope_with_id
- Patch
Registration With IdError - struct for typed errors of method
patch_registration_with_id
- Patch
System Configuration With IdError - struct for typed errors of method
patch_system_configuration_with_id
- Patch
Tenant With IdError - struct for typed errors of method
patch_tenant_with_id
- Patch
Theme With IdError - struct for typed errors of method
patch_theme_with_id
- Patch
User Action Reason With IdError - struct for typed errors of method
patch_user_action_reason_with_id
- Patch
User Action With IdError - struct for typed errors of method
patch_user_action_with_id
- Patch
User Consent With IdError - struct for typed errors of method
patch_user_consent_with_id
- Patch
User With IdError - struct for typed errors of method
patch_user_with_id
- Patch
Webhook With IdError - struct for typed errors of method
patch_webhook_with_id
- Reconcile
JwtWith IdError - struct for typed errors of method
reconcile_jwt_with_id
- Register
Error - struct for typed errors of method
register
- Register
With IdError - struct for typed errors of method
register_with_id
- Reindex
With IdError - struct for typed errors of method
reindex_with_id
- Remove
User From Family With IdError - struct for typed errors of method
remove_user_from_family_with_id
- Retrieve
Action With IdError - struct for typed errors of method
retrieve_action_with_id
- Retrieve
ApiKey With IdError - struct for typed errors of method
retrieve_api_key_with_id
- Retrieve
Application Error - struct for typed errors of method
retrieve_application
- Retrieve
Application With IdError - struct for typed errors of method
retrieve_application_with_id
- Retrieve
Audit LogWith IdError - struct for typed errors of method
retrieve_audit_log_with_id
- Retrieve
Connector With IdError - struct for typed errors of method
retrieve_connector_with_id
- Retrieve
Consent With IdError - struct for typed errors of method
retrieve_consent_with_id
- Retrieve
Daily Active Report With IdError - struct for typed errors of method
retrieve_daily_active_report_with_id
- Retrieve
Device User Code Error - struct for typed errors of method
retrieve_device_user_code
- Retrieve
Email Template Error - struct for typed errors of method
retrieve_email_template
- Retrieve
Email Template Preview With IdError - struct for typed errors of method
retrieve_email_template_preview_with_id
- Retrieve
Email Template With IdError - struct for typed errors of method
retrieve_email_template_with_id
- Retrieve
Entity Grant With IdError - struct for typed errors of method
retrieve_entity_grant_with_id
- Retrieve
Entity Type With IdError - struct for typed errors of method
retrieve_entity_type_with_id
- Retrieve
Entity With IdError - struct for typed errors of method
retrieve_entity_with_id
- Retrieve
Event LogWith IdError - struct for typed errors of method
retrieve_event_log_with_id
- Retrieve
Families With IdError - struct for typed errors of method
retrieve_families_with_id
- Retrieve
Family Members ByFamily IdWith IdError - struct for typed errors of method
retrieve_family_members_by_family_id_with_id
- Retrieve
Form Field With IdError - struct for typed errors of method
retrieve_form_field_with_id
- Retrieve
Form With IdError - struct for typed errors of method
retrieve_form_with_id
- Retrieve
Group With IdError - struct for typed errors of method
retrieve_group_with_id
- Retrieve
Identity Provider ByType With IdError - struct for typed errors of method
retrieve_identity_provider_by_type_with_id
- Retrieve
Identity Provider Link Error - struct for typed errors of method
retrieve_identity_provider_link
- Retrieve
Identity Provider With IdError - struct for typed errors of method
retrieve_identity_provider_with_id
- Retrieve
IpAccess Control List With IdError - struct for typed errors of method
retrieve_ip_access_control_list_with_id
- Retrieve
Json WebKey SetWith IdError - struct for typed errors of method
retrieve_json_web_key_set_with_id
- Retrieve
JwtPublic KeyError - struct for typed errors of method
retrieve_jwt_public_key
- Retrieve
KeyWith IdError - struct for typed errors of method
retrieve_key_with_id
- Retrieve
Keys With IdError - struct for typed errors of method
retrieve_keys_with_id
- Retrieve
Lambda With IdError - struct for typed errors of method
retrieve_lambda_with_id
- Retrieve
Lambdas ByType With IdError - struct for typed errors of method
retrieve_lambdas_by_type_with_id
- Retrieve
Message Template Error - struct for typed errors of method
retrieve_message_template
- Retrieve
Message Template Preview With IdError - struct for typed errors of method
retrieve_message_template_preview_with_id
- Retrieve
Message Template With IdError - struct for typed errors of method
retrieve_message_template_with_id
- Retrieve
Messenger With IdError - struct for typed errors of method
retrieve_messenger_with_id
- Retrieve
Monthly Active Report With IdError - struct for typed errors of method
retrieve_monthly_active_report_with_id
- RetrieveO
Auth Scope With IdError - struct for typed errors of method
retrieve_o_auth_scope_with_id
- Retrieve
Oauth Configuration With IdError - struct for typed errors of method
retrieve_oauth_configuration_with_id
- Retrieve
Open IdConfiguration With IdError - struct for typed errors of method
retrieve_open_id_configuration_with_id
- Retrieve
Password Validation Rules With IdError - struct for typed errors of method
retrieve_password_validation_rules_with_id
- Retrieve
Password Validation Rules With Tenant IdWith IdError - struct for typed errors of method
retrieve_password_validation_rules_with_tenant_id_with_id
- Retrieve
Pending Children With IdError - struct for typed errors of method
retrieve_pending_children_with_id
- Retrieve
Pending Link With IdError - struct for typed errors of method
retrieve_pending_link_with_id
- Retrieve
Reactor Metrics With IdError - struct for typed errors of method
retrieve_reactor_metrics_with_id
- Retrieve
Refresh Token ById With IdError - struct for typed errors of method
retrieve_refresh_token_by_id_with_id
- Retrieve
Refresh Tokens With IdError - struct for typed errors of method
retrieve_refresh_tokens_with_id
- Retrieve
Registration Report With IdError - struct for typed errors of method
retrieve_registration_report_with_id
- Retrieve
Registration With IdError - struct for typed errors of method
retrieve_registration_with_id
- Retrieve
Report Login Error - struct for typed errors of method
retrieve_report_login
- Retrieve
Status Error - struct for typed errors of method
retrieve_status
- Retrieve
System Health With IdError - struct for typed errors of method
retrieve_system_health_with_id
- Retrieve
Tenant With IdError - struct for typed errors of method
retrieve_tenant_with_id
- Retrieve
Theme With IdError - struct for typed errors of method
retrieve_theme_with_id
- Retrieve
Total Report With IdError - struct for typed errors of method
retrieve_total_report_with_id
- Retrieve
TwoFactor Recovery Codes With IdError - struct for typed errors of method
retrieve_two_factor_recovery_codes_with_id
- Retrieve
TwoFactor Status With IdError - struct for typed errors of method
retrieve_two_factor_status_with_id
- Retrieve
User Action Error - struct for typed errors of method
retrieve_user_action
- Retrieve
User Action Reason Error - struct for typed errors of method
retrieve_user_action_reason
- Retrieve
User Action Reason With IdError - struct for typed errors of method
retrieve_user_action_reason_with_id
- Retrieve
User Action With IdError - struct for typed errors of method
retrieve_user_action_with_id
- Retrieve
User Actioning Error - struct for typed errors of method
retrieve_user_actioning
- Retrieve
User Change Password Error - struct for typed errors of method
retrieve_user_change_password
- Retrieve
User Comments With IdError - struct for typed errors of method
retrieve_user_comments_with_id
- Retrieve
User Consent With IdError - struct for typed errors of method
retrieve_user_consent_with_id
- Retrieve
User Consents With IdError - struct for typed errors of method
retrieve_user_consents_with_id
- Retrieve
User Error - struct for typed errors of method
retrieve_user
- Retrieve
User Info From Access Token With IdError - struct for typed errors of method
retrieve_user_info_from_access_token_with_id
- Retrieve
User Recent Login Error - struct for typed errors of method
retrieve_user_recent_login
- Retrieve
User With IdError - struct for typed errors of method
retrieve_user_with_id
- Retrieve
Version With IdError - struct for typed errors of method
retrieve_version_with_id
- Retrieve
WebAuthn Credential With IdError - struct for typed errors of method
retrieve_web_authn_credential_with_id
- Retrieve
WebAuthn Credentials ForUser With IdError - struct for typed errors of method
retrieve_web_authn_credentials_for_user_with_id
- Retrieve
Webhook Attempt LogWith IdError - struct for typed errors of method
retrieve_webhook_attempt_log_with_id
- Retrieve
Webhook Error - struct for typed errors of method
retrieve_webhook
- Retrieve
Webhook Event LogWith IdError - struct for typed errors of method
retrieve_webhook_event_log_with_id
- Retrieve
Webhook With IdError - struct for typed errors of method
retrieve_webhook_with_id
- Revoke
Refresh Token ById With IdError - struct for typed errors of method
revoke_refresh_token_by_id_with_id
- Revoke
User Consent With IdError - struct for typed errors of method
revoke_user_consent_with_id
- Search
Applications With IdError - struct for typed errors of method
search_applications_with_id
- Search
Audit Logs With IdError - struct for typed errors of method
search_audit_logs_with_id
- Search
Consents With IdError - struct for typed errors of method
search_consents_with_id
- Search
Email Templates With IdError - struct for typed errors of method
search_email_templates_with_id
- Search
Entities ByIds With IdError - struct for typed errors of method
search_entities_by_ids_with_id
- Search
Entities With IdError - struct for typed errors of method
search_entities_with_id
- Search
Entity Grants With IdError - struct for typed errors of method
search_entity_grants_with_id
- Search
Entity Types With IdError - struct for typed errors of method
search_entity_types_with_id
- Search
Event Logs With IdError - struct for typed errors of method
search_event_logs_with_id
- Search
Group Members With IdError - struct for typed errors of method
search_group_members_with_id
- Search
Groups With IdError - struct for typed errors of method
search_groups_with_id
- Search
Identity Providers With IdError - struct for typed errors of method
search_identity_providers_with_id
- Search
IpAccess Control Lists With IdError - struct for typed errors of method
search_ip_access_control_lists_with_id
- Search
Keys With IdError - struct for typed errors of method
search_keys_with_id
- Search
Lambdas With IdError - struct for typed errors of method
search_lambdas_with_id
- Search
Login Records With IdError - struct for typed errors of method
search_login_records_with_id
- Search
Tenants With IdError - struct for typed errors of method
search_tenants_with_id
- Search
Themes With IdError - struct for typed errors of method
search_themes_with_id
- Search
User Comments With IdError - struct for typed errors of method
search_user_comments_with_id
- Search
Users ByIds With IdError - struct for typed errors of method
search_users_by_ids_with_id
- Search
Users ByQuery With IdError - struct for typed errors of method
search_users_by_query_with_id
- Search
Webhook Event Logs With IdError - struct for typed errors of method
search_webhook_event_logs_with_id
- Search
Webhooks With IdError - struct for typed errors of method
search_webhooks_with_id
- Send
Email With IdError - struct for typed errors of method
send_email_with_id
- Send
Family Request Email With IdError - struct for typed errors of method
send_family_request_email_with_id
- Send
Passwordless Code With IdError - struct for typed errors of method
send_passwordless_code_with_id
- Send
TwoFactor Code ForEnable Disable With IdError - struct for typed errors of method
send_two_factor_code_for_enable_disable_with_id
- Send
TwoFactor Code ForLogin Using Method With IdError - struct for typed errors of method
send_two_factor_code_for_login_using_method_with_id
- Start
Identity Provider Login With IdError - struct for typed errors of method
start_identity_provider_login_with_id
- Start
Passwordless Login With IdError - struct for typed errors of method
start_passwordless_login_with_id
- Start
TwoFactor Login With IdError - struct for typed errors of method
start_two_factor_login_with_id
- Start
WebAuthn Login With IdError - struct for typed errors of method
start_web_authn_login_with_id
- Start
WebAuthn Registration With IdError - struct for typed errors of method
start_web_authn_registration_with_id
- TwoFactor
Login With IdError - struct for typed errors of method
two_factor_login_with_id
- Update
ApiKey With IdError - struct for typed errors of method
update_api_key_with_id
- Update
Application Role With IdError - struct for typed errors of method
update_application_role_with_id
- Update
Application With IdError - struct for typed errors of method
update_application_with_id
- Update
Connector With IdError - struct for typed errors of method
update_connector_with_id
- Update
Consent With IdError - struct for typed errors of method
update_consent_with_id
- Update
Email Template With IdError - struct for typed errors of method
update_email_template_with_id
- Update
Entity Type Permission With IdError - struct for typed errors of method
update_entity_type_permission_with_id
- Update
Entity Type With IdError - struct for typed errors of method
update_entity_type_with_id
- Update
Entity With IdError - struct for typed errors of method
update_entity_with_id
- Update
Form Field With IdError - struct for typed errors of method
update_form_field_with_id
- Update
Form With IdError - struct for typed errors of method
update_form_with_id
- Update
Group Members With IdError - struct for typed errors of method
update_group_members_with_id
- Update
Group With IdError - struct for typed errors of method
update_group_with_id
- Update
Identity Provider With IdError - struct for typed errors of method
update_identity_provider_with_id
- Update
Integrations With IdError - struct for typed errors of method
update_integrations_with_id
- Update
IpAccess Control List With IdError - struct for typed errors of method
update_ip_access_control_list_with_id
- Update
KeyWith IdError - struct for typed errors of method
update_key_with_id
- Update
Lambda With IdError - struct for typed errors of method
update_lambda_with_id
- Update
Message Template With IdError - struct for typed errors of method
update_message_template_with_id
- Update
Messenger With IdError - struct for typed errors of method
update_messenger_with_id
- UpdateO
Auth Scope With IdError - struct for typed errors of method
update_o_auth_scope_with_id
- Update
Registration With IdError - struct for typed errors of method
update_registration_with_id
- Update
System Configuration With IdError - struct for typed errors of method
update_system_configuration_with_id
- Update
Tenant With IdError - struct for typed errors of method
update_tenant_with_id
- Update
Theme With IdError - struct for typed errors of method
update_theme_with_id
- Update
User Action Reason With IdError - struct for typed errors of method
update_user_action_reason_with_id
- Update
User Action With IdError - struct for typed errors of method
update_user_action_with_id
- Update
User Consent With IdError - struct for typed errors of method
update_user_consent_with_id
- Update
User Family With IdError - struct for typed errors of method
update_user_family_with_id
- Update
User Verify Email Error - struct for typed errors of method
update_user_verify_email
- Update
User Verify Registration Error - struct for typed errors of method
update_user_verify_registration
- Update
User With IdError - struct for typed errors of method
update_user_with_id
- Update
Webhook With IdError - struct for typed errors of method
update_webhook_with_id
- Upsert
Entity Grant With IdError - struct for typed errors of method
upsert_entity_grant_with_id
- Validate
Device With IdError - struct for typed errors of method
validate_device_with_id
- Validate
JwtWith IdError - struct for typed errors of method
validate_jwt_with_id
- Vend
JwtWith IdError - struct for typed errors of method
vend_jwt_with_id
- Verify
User Registration With IdError - struct for typed errors of method
verify_user_registration_with_id
Functions§
- action_
user_ with_ id - Takes an action on a user. The user being actioned is called the "actionee" and the user taking the action is called the "actioner". Both user ids are required in the request object.
- activate_
reactor_ with_ id - Activates the FusionAuth Reactor using a license Id and optionally a license text (for air-gapped deployments)
- approve_
device_ with_ id - Approve a device grant.
- cancel_
action_ with_ id - Cancels the user action.
- change_
password_ by_ identity_ with_ id - Changes a user’s password using their identity (loginId and password). Using a loginId instead of the changePasswordId bypasses the email verification and allows a password to be changed directly without first calling the #forgotPassword method.
- change_
password_ with_ id - Changes a user’s password using the change password Id. This usually occurs after an email has been sent to the user and they clicked on a link to reset their password. As of version 1.32.2, prefer sending the changePasswordId in the request body. To do this, omit the first parameter, and set the value in the request body.
- check_
change_ password_ using_ id_ with_ id - Check to see if the user must obtain a Trust Token Id in order to complete a change password request. When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change your password, you must obtain a Trust Token by completing a Two-Factor Step-Up authentication. An HTTP status code of 400 with a general error code of [TrustTokenRequired] indicates that a Trust Token is required to make a POST request to this API.
- comment_
on_ user_ with_ id - Adds a comment to the user’s account.
- complete_
web_ authn_ assertion_ with_ id - Complete a WebAuthn authentication ceremony by validating the signature against the previously generated challenge without logging the user in
- complete_
web_ authn_ login_ with_ id - Complete a WebAuthn authentication ceremony by validating the signature against the previously generated challenge and then login the user in
- complete_
web_ authn_ registration_ with_ id - Complete a WebAuthn registration ceremony by validating the client request and saving the new credential
- create_
api_ key - Creates an API key. You can optionally specify a unique Id for the key, if not provided one will be generated. an API key can only be created with equal or lesser authority. An API key cannot create another API key unless it is granted to that API key. If an API key is locked to a tenant, it can only create API Keys for that same tenant.
- create_
api_ key_ with_ id - Creates an API key. You can optionally specify a unique Id for the key, if not provided one will be generated. an API key can only be created with equal or lesser authority. An API key cannot create another API key unless it is granted to that API key. If an API key is locked to a tenant, it can only create API Keys for that same tenant. OR Updates an authentication API key by given id
- create_
application - Creates an application. You can optionally specify an Id for the application, if not provided one will be generated.
- create_
application_ role - Creates a new role for an application. You must specify the Id of the application you are creating the role for. You can optionally specify an Id for the role inside the ApplicationRole object itself, if not provided one will be generated.
- create_
application_ role_ with_ id - Creates a new role for an application. You must specify the Id of the application you are creating the role for. You can optionally specify an Id for the role inside the ApplicationRole object itself, if not provided one will be generated.
- create_
application_ with_ id - Creates an application. You can optionally specify an Id for the application, if not provided one will be generated.
- create_
audit_ log_ with_ id - Creates an audit log with the message and user name (usually an email). Audit logs should be written anytime you make changes to the FusionAuth database. When using the FusionAuth App web interface, any changes are automatically written to the audit log. However, if you are accessing the API, you must write the audit logs yourself.
- create_
connector - Creates a connector. You can optionally specify an Id for the connector, if not provided one will be generated.
- create_
connector_ with_ id - Creates a connector. You can optionally specify an Id for the connector, if not provided one will be generated.
- create_
consent - Creates a user consent type. You can optionally specify an Id for the consent type, if not provided one will be generated.
- create_
consent_ with_ id - Creates a user consent type. You can optionally specify an Id for the consent type, if not provided one will be generated.
- create_
email_ template - Creates an email template. You can optionally specify an Id for the template, if not provided one will be generated.
- create_
email_ template_ with_ id - Creates an email template. You can optionally specify an Id for the template, if not provided one will be generated.
- create_
entity - Creates an Entity. You can optionally specify an Id for the Entity. If not provided one will be generated.
- create_
entity_ type - Creates a Entity Type. You can optionally specify an Id for the Entity Type, if not provided one will be generated.
- create_
entity_ type_ permission - Creates a new permission for an entity type. You must specify the Id of the entity type you are creating the permission for. You can optionally specify an Id for the permission inside the EntityTypePermission object itself, if not provided one will be generated.
- create_
entity_ type_ permission_ with_ id - Creates a new permission for an entity type. You must specify the Id of the entity type you are creating the permission for. You can optionally specify an Id for the permission inside the EntityTypePermission object itself, if not provided one will be generated.
- create_
entity_ type_ with_ id - Creates a Entity Type. You can optionally specify an Id for the Entity Type, if not provided one will be generated.
- create_
entity_ with_ id - Creates an Entity. You can optionally specify an Id for the Entity. If not provided one will be generated.
- create_
family - Creates a family with the user Id in the request as the owner and sole member of the family. You can optionally specify an Id for the family, if not provided one will be generated.
- create_
family_ with_ id - Creates a family with the user Id in the request as the owner and sole member of the family. You can optionally specify an Id for the family, if not provided one will be generated.
- create_
form - Creates a form. You can optionally specify an Id for the form, if not provided one will be generated.
- create_
form_ field - Creates a form field. You can optionally specify an Id for the form, if not provided one will be generated.
- create_
form_ field_ with_ id - Creates a form field. You can optionally specify an Id for the form, if not provided one will be generated.
- create_
form_ with_ id - Creates a form. You can optionally specify an Id for the form, if not provided one will be generated.
- create_
group - Creates a group. You can optionally specify an Id for the group, if not provided one will be generated.
- create_
group_ members_ with_ id - Creates a member in a group.
- create_
group_ with_ id - Creates a group. You can optionally specify an Id for the group, if not provided one will be generated.
- create_
identity_ provider - Creates an identity provider. You can optionally specify an Id for the identity provider, if not provided one will be generated.
- create_
identity_ provider_ with_ id - Creates an identity provider. You can optionally specify an Id for the identity provider, if not provided one will be generated.
- create_
introspect - Inspect an access token issued as the result of the User based grant such as the Authorization Code Grant, Implicit Grant, the User Credentials Grant or the Refresh Grant. OR Inspect an access token issued as the result of the Client Credentials Grant.
- create_
ip_ access_ control_ list - Creates an IP Access Control List. You can optionally specify an Id on this create request, if one is not provided one will be generated.
- create_
ip_ access_ control_ list_ with_ id - Creates an IP Access Control List. You can optionally specify an Id on this create request, if one is not provided one will be generated.
- create_
lambda - Creates a Lambda. You can optionally specify an Id for the lambda, if not provided one will be generated.
- create_
lambda_ with_ id - Creates a Lambda. You can optionally specify an Id for the lambda, if not provided one will be generated.
- create_
logout - The Logout API is intended to be used to remove the refresh token and access token cookies if they exist on the client and revoke the refresh token stored. This API does nothing if the request does not contain an access token or refresh token cookies. OR The Logout API is intended to be used to remove the refresh token and access token cookies if they exist on the client and revoke the refresh token stored. This API takes the refresh token in the JSON body.
- create_
message_ template - Creates an message template. You can optionally specify an Id for the template, if not provided one will be generated.
- create_
message_ template_ with_ id - Creates an message template. You can optionally specify an Id for the template, if not provided one will be generated.
- create_
messenger - Creates a messenger. You can optionally specify an Id for the messenger, if not provided one will be generated.
- create_
messenger_ with_ id - Creates a messenger. You can optionally specify an Id for the messenger, if not provided one will be generated.
- create_
o_ auth_ scope - Creates a new custom OAuth scope for an application. You must specify the Id of the application you are creating the scope for. You can optionally specify an Id for the OAuth scope on the URL, if not provided one will be generated.
- create_
o_ auth_ scope_ with_ id - Creates a new custom OAuth scope for an application. You must specify the Id of the application you are creating the scope for. You can optionally specify an Id for the OAuth scope on the URL, if not provided one will be generated.
- create_
tenant - Creates a tenant. You can optionally specify an Id for the tenant, if not provided one will be generated.
- create_
tenant_ with_ id - Creates a tenant. You can optionally specify an Id for the tenant, if not provided one will be generated.
- create_
theme - Creates a Theme. You can optionally specify an Id for the theme, if not provided one will be generated.
- create_
theme_ with_ id - Creates a Theme. You can optionally specify an Id for the theme, if not provided one will be generated.
- create_
token - Exchanges an OAuth authorization code and code_verifier for an access token. Makes a request to the Token endpoint to exchange the authorization code returned from the Authorize endpoint and a code_verifier for an access token. OR Make a Client Credentials grant request to obtain an access token. OR Exchange a Refresh Token for an Access Token. If you will be using the Refresh Token Grant, you will make a request to the Token endpoint to exchange the user’s refresh token for an access token. OR Exchange User Credentials for a Token. If you will be using the Resource Owner Password Credential Grant, you will make a request to the Token endpoint to exchange the user’s email and password for an access token. OR Exchanges an OAuth authorization code for an access token. Makes a request to the Token endpoint to exchange the authorization code returned from the Authorize endpoint for an access token.
- create_
user - Creates a user. You can optionally specify an Id for the user, if not provided one will be generated.
- create_
user_ action - Creates a user action. This action cannot be taken on a user until this call successfully returns. Anytime after that the user action can be applied to any user.
- create_
user_ action_ reason - Creates a user reason. This user action reason cannot be used when actioning a user until this call completes successfully. Anytime after that the user action reason can be used.
- create_
user_ action_ reason_ with_ id - Creates a user reason. This user action reason cannot be used when actioning a user until this call completes successfully. Anytime after that the user action reason can be used.
- create_
user_ action_ with_ id - Creates a user action. This action cannot be taken on a user until this call successfully returns. Anytime after that the user action can be applied to any user.
- create_
user_ consent - Creates a single User consent.
- create_
user_ consent_ with_ id - Creates a single User consent.
- create_
user_ link_ with_ id - Link an external user from a 3rd party identity provider to a FusionAuth user.
- create_
user_ verify_ email - Administratively verify a user’s email address. Use this method to bypass email verification for the user. The request body will contain the userId to be verified. An API key is required when sending the userId in the request body. OR Confirms a user’s email address. The request body will contain the verificationId. You may also be required to send a one-time use code based upon your configuration. When the tenant is configured to gate a user until their email address is verified, this procedures requires two values instead of one. The verificationId is a high entropy value and the one-time use code is a low entropy value that is easily entered in a user interactive form. The two values together are able to confirm a user’s email address and mark the user’s email address as verified.
- create_
user_ with_ id - Creates a user. You can optionally specify an Id for the user, if not provided one will be generated.
- create_
webhook - Creates a webhook. You can optionally specify an Id for the webhook, if not provided one will be generated.
- create_
webhook_ with_ id - Creates a webhook. You can optionally specify an Id for the webhook, if not provided one will be generated.
- delete_
api_ key_ with_ id - Deletes the API key for the given Id.
- delete_
application_ role_ with_ id - Hard deletes an application role. This is a dangerous operation and should not be used in most circumstances. This permanently removes the given role from all users that had it.
- delete_
application_ with_ id - Hard deletes an application. This is a dangerous operation and should not be used in most circumstances. This will delete the application, any registrations for that application, metrics and reports for the application, all the roles for the application, and any other data associated with the application. This operation could take a very long time, depending on the amount of data in your database. OR Deactivates the application with the given Id.
- delete_
connector_ with_ id - Deletes the connector for the given Id.
- delete_
consent_ with_ id - Deletes the consent for the given Id.
- delete_
email_ template_ with_ id - Deletes the email template for the given Id.
- delete_
entity_ grant_ with_ id - Deletes an Entity Grant for the given User or Entity.
- delete_
entity_ type_ permission_ with_ id - Hard deletes a permission. This is a dangerous operation and should not be used in most circumstances. This permanently removes the given permission from all grants that had it.
- delete_
entity_ type_ with_ id - Deletes the Entity Type for the given Id.
- delete_
entity_ with_ id - Deletes the Entity for the given Id.
- delete_
form_ field_ with_ id - Deletes the form field for the given Id.
- delete_
form_ with_ id - Deletes the form for the given Id.
- delete_
group_ members_ with_ id - Removes users as members of a group.
- delete_
group_ with_ id - Deletes the group for the given Id.
- delete_
identity_ provider_ with_ id - Deletes the identity provider for the given Id.
- delete_
ip_ access_ control_ list_ with_ id - Deletes the IP Access Control List for the given Id.
- delete_
jwt_ refresh - Revoke all refresh tokens that belong to a user by user Id. OR Revoke all refresh tokens that belong to a user by user Id for a specific application by applicationId. OR Revoke all refresh tokens that belong to an application by applicationId. OR Revokes refresh tokens using the information in the JSON body. The handling for this method is the same as the revokeRefreshToken method and is based on the information you provide in the RefreshDeleteRequest object. See that method for additional information. OR Revokes a single refresh token by using the actual refresh token value. This refresh token value is sensitive, so be careful with this API request. OR Revokes refresh tokens. Usage examples: - Delete a single refresh token, pass in only the token. revokeRefreshToken(token) - Delete all refresh tokens for a user, pass in only the userId. revokeRefreshToken(null, userId) - Delete all refresh tokens for a user for a specific application, pass in both the userId and the applicationId. revokeRefreshToken(null, userId, applicationId) - Delete all refresh tokens for an application revokeRefreshToken(null, null, applicationId) Note:
null
may be handled differently depending upon the programming language. See also: (method names may vary by language… but you’ll figure it out) - revokeRefreshTokenById - revokeRefreshTokenByToken - revokeRefreshTokensByUserId - revokeRefreshTokensByApplicationId - revokeRefreshTokensByUserIdForApplication - delete_
key_ with_ id - Deletes the key for the given Id.
- delete_
lambda_ with_ id - Deletes the lambda for the given Id.
- delete_
message_ template_ with_ id - Deletes the message template for the given Id.
- delete_
messenger_ with_ id - Deletes the messenger for the given Id.
- delete_
o_ auth_ scope_ with_ id - Hard deletes a custom OAuth scope. OAuth workflows that are still requesting the deleted OAuth scope may fail depending on the application’s unknown scope policy.
- delete_
tenant_ with_ id - Deletes the tenant based on the given Id on the URL. This permanently deletes all information, metrics, reports and data associated with the tenant and everything under the tenant (applications, users, etc). OR Deletes the tenant for the given Id asynchronously. This method is helpful if you do not want to wait for the delete operation to complete. OR Deletes the tenant based on the given request (sent to the API as JSON). This permanently deletes all information, metrics, reports and data associated with the tenant and everything under the tenant (applications, users, etc).
- delete_
theme_ with_ id - Deletes the theme for the given Id.
- delete_
user_ action_ reason_ with_ id - Deletes the user action reason for the given Id.
- delete_
user_ action_ with_ id - Deactivates the user action with the given Id. OR Deletes the user action for the given Id. This permanently deletes the user action and also any history and logs of the action being applied to any users.
- delete_
user_ bulk - Deactivates the users with the given ids. OR Deletes the users with the given ids, or users matching the provided JSON query or queryString. The order of preference is ids, query and then queryString, it is recommended to only provide one of the three for the request. This method can be used to deactivate or permanently delete (hard-delete) users based upon the hardDelete boolean in the request body. Using the dryRun parameter you may also request the result of the action without actually deleting or deactivating any users.
- delete_
user_ link_ with_ id - Remove an existing link that has been made from a 3rd party identity provider to a FusionAuth user.
- delete_
user_ registration_ with_ id - Deletes the user registration for the given user and application. OR Deletes the user registration for the given user and application along with the given JSON body that contains the event information.
- delete_
user_ two_ factor_ with_ id - Disable two-factor authentication for a user using a JSON body rather than URL parameters. OR Disable two-factor authentication for a user.
- delete_
user_ with_ id - Deletes the user based on the given request (sent to the API as JSON). This permanently deletes all information, metrics, reports and data associated with the user. OR Deletes the user for the given Id. This permanently deletes all information, metrics, reports and data associated with the user. OR Deactivates the user with the given Id.
- delete_
web_ authn_ credential_ with_ id - Deletes the WebAuthn credential for the given Id.
- delete_
webhook_ with_ id - Deletes the webhook for the given Id.
- enable_
two_ factor_ with_ id - Enable two-factor authentication for a user.
- exchange_
refresh_ token_ for_ jwt_ with_ id - Exchange a refresh token for a new JWT.
- forgot_
password_ with_ id - Begins the forgot password sequence, which kicks off an email to the user so that they can reset their password.
- generate_
key - Generate a new RSA or EC key pair or an HMAC secret.
- generate_
key_ with_ id - Generate a new RSA or EC key pair or an HMAC secret.
- generate_
two_ factor_ recovery_ codes_ with_ id - Generate two-factor recovery codes for a user. Generating two-factor recovery codes will invalidate any existing recovery codes.
- generate_
two_ factor_ secret_ using_ jwt_ with_ id - Generate a Two Factor secret that can be used to enable Two Factor authentication for a User. The response will contain both the secret and a Base32 encoded form of the secret which can be shown to a User when using a 2 Step Authentication application such as Google Authenticator.
- identity_
provider_ login_ with_ id - Handles login via third-parties including Social login, external OAuth and OpenID Connect, and other login systems.
- import_
key - Import an existing RSA or EC key pair or an HMAC secret.
- import_
key_ with_ id - Import an existing RSA or EC key pair or an HMAC secret.
- import_
refresh_ tokens_ with_ id - Bulk imports refresh tokens. This request performs minimal validation and runs batch inserts of refresh tokens with the expectation that each token represents a user that already exists and is registered for the corresponding FusionAuth Application. This is done to increases the insert performance. Therefore, if you encounter an error due to a database key violation, the response will likely offer a generic explanation. If you encounter an error, you may optionally enable additional validation to receive a JSON response body with specific validation errors. This will slow the request down but will allow you to identify the cause of the failure. See the validateDbConstraints request parameter.
- import_
users_ with_ id - Bulk imports users. This request performs minimal validation and runs batch inserts of users with the expectation that each user does not yet exist and each registration corresponds to an existing FusionAuth Application. This is done to increases the insert performance. Therefore, if you encounter an error due to a database key violation, the response will likely offer a generic explanation. If you encounter an error, you may optionally enable additional validation to receive a JSON response body with specific validation errors. This will slow the request down but will allow you to identify the cause of the failure. See the validateDbConstraints request parameter.
- import_
web_ authn_ credential_ with_ id - Import a WebAuthn credential
- issue_
jwt_ with_ id - Issue a new access token (JWT) for the requested Application after ensuring the provided JWT is valid. A valid access token is properly signed and not expired.
This API may be used in an SSO configuration to issue new tokens for another application after the user has obtained a valid token from authentication.
- login_
ping_ with_ id - Sends a ping to FusionAuth indicating that the user was automatically logged into an application. When using FusionAuth’s SSO or your own, you should call this if the user is already logged in centrally, but accesses an application where they no longer have a session. This helps correctly track login counts, times and helps with reporting.
- login_
ping_ with_ request_ with_ id - Sends a ping to FusionAuth indicating that the user was automatically logged into an application. When using FusionAuth’s SSO or your own, you should call this if the user is already logged in centrally, but accesses an application where they no longer have a session. This helps correctly track login counts, times and helps with reporting.
- login_
with_ id - Authenticates a user to FusionAuth. This API optionally requires an API key. See
Application.loginConfiguration.requireAuthentication
. - lookup_
identity_ provider_ with_ id - Retrieves the identity provider for the given domain. A 200 response code indicates the domain is managed by a registered identity provider. A 404 indicates the domain is not managed.
- modify_
action_ with_ id - Modifies a temporal user action by changing the expiration of the action and optionally adding a comment to the action.
- passwordless_
login_ with_ id - Complete a login request using a passwordless code
- patch_
application_ role_ with_ id - Updates, via PATCH, the application role with the given Id for the application.
- patch_
application_ with_ id - Updates, via PATCH, the application with the given Id.
- patch_
connector_ with_ id - Updates, via PATCH, the connector with the given Id.
- patch_
consent_ with_ id - Updates, via PATCH, the consent with the given Id.
- patch_
email_ template_ with_ id - Updates, via PATCH, the email template with the given Id.
- patch_
entity_ type_ permission_ with_ id - Patches the permission with the given Id for the entity type.
- patch_
entity_ type_ with_ id - Updates, via PATCH, the Entity Type with the given Id.
- patch_
entity_ with_ id - Updates, via PATCH, the Entity with the given Id.
- patch_
form_ field_ with_ id - Patches the form field with the given Id.
- patch_
form_ with_ id - Patches the form with the given Id.
- patch_
group_ with_ id - Updates, via PATCH, the group with the given Id.
- patch_
identity_ provider_ with_ id - Updates, via PATCH, the identity provider with the given Id.
- patch_
integrations_ with_ id - Updates, via PATCH, the available integrations.
- patch_
ip_ access_ control_ list_ with_ id - Update the IP Access Control List with the given Id.
- patch_
lambda_ with_ id - Updates, via PATCH, the lambda with the given Id.
- patch_
message_ template_ with_ id - Updates, via PATCH, the message template with the given Id.
- patch_
messenger_ with_ id - Updates, via PATCH, the messenger with the given Id.
- patch_
o_ auth_ scope_ with_ id - Updates, via PATCH, the custom OAuth scope with the given Id for the application.
- patch_
registration_ with_ id - Updates, via PATCH, the registration for the user with the given Id and the application defined in the request.
- patch_
system_ configuration_ with_ id - Updates, via PATCH, the system configuration.
- patch_
tenant_ with_ id - Updates, via PATCH, the tenant with the given Id.
- patch_
theme_ with_ id - Updates, via PATCH, the theme with the given Id.
- patch_
user_ action_ reason_ with_ id - Updates, via PATCH, the user action reason with the given Id.
- patch_
user_ action_ with_ id - Updates, via PATCH, the user action with the given Id.
- patch_
user_ consent_ with_ id - Updates, via PATCH, a single User consent by Id.
- patch_
user_ with_ id - Updates, via PATCH, the user with the given Id.
- patch_
webhook_ with_ id - Patches the webhook with the given Id.
- reconcile_
jwt_ with_ id - Reconcile a User to FusionAuth using JWT issued from another Identity Provider.
- register
- Registers a user for an application. If you provide the User and the UserRegistration object on this request, it will create the user as well as register them for the application. This is called a Full Registration. However, if you only provide the UserRegistration object, then the user must already exist and they will be registered for the application. The user Id can also be provided and it will either be used to look up an existing user or it will be used for the newly created User.
- register_
with_ id - Registers a user for an application. If you provide the User and the UserRegistration object on this request, it will create the user as well as register them for the application. This is called a Full Registration. However, if you only provide the UserRegistration object, then the user must already exist and they will be registered for the application. The user Id can also be provided and it will either be used to look up an existing user or it will be used for the newly created User.
- reindex_
with_ id - Requests Elasticsearch to delete and rebuild the index for FusionAuth users or entities. Be very careful when running this request as it will increase the CPU and I/O load on your database until the operation completes. Generally speaking you do not ever need to run this operation unless instructed by FusionAuth support, or if you are migrating a database another system and you are not brining along the Elasticsearch index. You have been warned.
- remove_
user_ from_ family_ with_ id - Removes a user from the family with the given id.
- retrieve_
action_ with_ id - Retrieves a single action log (the log of a user action that was taken on a user previously) for the given Id.
- retrieve_
api_ key_ with_ id - Retrieves an authentication API key for the given id
- retrieve_
application - Retrieves the application for the given Id or all the applications if the Id is null. OR Retrieves all the applications that are currently inactive.
- retrieve_
application_ with_ id - Retrieves the application for the given Id or all the applications if the Id is null.
- retrieve_
audit_ log_ with_ id - Retrieves a single audit log for the given Id.
- retrieve_
connector_ with_ id - Retrieves the connector with the given Id.
- retrieve_
consent_ with_ id - Retrieves the Consent for the given Id.
- retrieve_
daily_ active_ report_ with_ id - Retrieves the daily active user report between the two instants. If you specify an application id, it will only return the daily active counts for that application.
- retrieve_
device_ user_ code - Retrieve a user_code that is part of an in-progress Device Authorization Grant. This API is useful if you want to build your own login workflow to complete a device grant. This request will require an API key. OR Retrieve a user_code that is part of an in-progress Device Authorization Grant. This API is useful if you want to build your own login workflow to complete a device grant.
- retrieve_
email_ template - Retrieves the email template for the given Id. If you don’t specify the id, this will return all the email templates.
- retrieve_
email_ template_ preview_ with_ id - Creates a preview of the email template provided in the request. This allows you to preview an email template that hasn’t been saved to the database yet. The entire email template does not need to be provided on the request. This will create the preview based on whatever is given.
- retrieve_
email_ template_ with_ id - Retrieves the email template for the given Id. If you don’t specify the id, this will return all the email templates.
- retrieve_
entity_ grant_ with_ id - Retrieves an Entity Grant for the given Entity and User/Entity.
- retrieve_
entity_ type_ with_ id - Retrieves the Entity Type for the given Id.
- retrieve_
entity_ with_ id - Retrieves the Entity for the given Id.
- retrieve_
event_ log_ with_ id - Retrieves a single event log for the given Id.
- retrieve_
families_ with_ id - Retrieves all the families that a user belongs to.
- retrieve_
family_ members_ by_ family_ id_ with_ id - Retrieves all the members of a family by the unique Family Id.
- retrieve_
form_ field_ with_ id - Retrieves the form field with the given Id.
- retrieve_
form_ with_ id - Retrieves the form with the given Id.
- retrieve_
group_ with_ id - Retrieves the group for the given Id.
- retrieve_
identity_ provider_ by_ type_ with_ id - Retrieves one or more identity provider for the given type. For types such as Google, Facebook, Twitter and LinkedIn, only a single identity provider can exist. For types such as OpenID Connect and SAMLv2 more than one identity provider can be configured so this request may return multiple identity providers.
- retrieve_
identity_ provider_ link - Retrieve a single Identity Provider user (link). OR Retrieve all Identity Provider users (links) for the user. Specify the optional identityProviderId to retrieve links for a particular IdP.
- retrieve_
identity_ provider_ with_ id - Retrieves the identity provider for the given Id or all the identity providers if the Id is null.
- retrieve_
ip_ access_ control_ list_ with_ id - Retrieves the IP Access Control List with the given Id.
- retrieve_
json_ web_ key_ set_ with_ id - Returns public keys used by FusionAuth to cryptographically verify JWTs using the JSON Web Key format.
- retrieve_
jwt_ public_ key - Retrieves the Public Key configured for verifying JSON Web Tokens (JWT) by the key Id (kid). OR Retrieves the Public Key configured for verifying the JSON Web Tokens (JWT) issued by the Login API by the Application Id.
- retrieve_
key_ with_ id - Retrieves the key for the given Id.
- retrieve_
keys_ with_ id - Retrieves all the keys.
- retrieve_
lambda_ with_ id - Retrieves the lambda for the given Id.
- retrieve_
lambdas_ by_ type_ with_ id - Retrieves all the lambdas for the provided type.
- retrieve_
message_ template - Retrieves the message template for the given Id. If you don’t specify the id, this will return all the message templates.
- retrieve_
message_ template_ preview_ with_ id - Creates a preview of the message template provided in the request, normalized to a given locale.
- retrieve_
message_ template_ with_ id - Retrieves the message template for the given Id. If you don’t specify the id, this will return all the message templates.
- retrieve_
messenger_ with_ id - Retrieves the messenger with the given Id.
- retrieve_
monthly_ active_ report_ with_ id - Retrieves the monthly active user report between the two instants. If you specify an application id, it will only return the monthly active counts for that application.
- retrieve_
o_ auth_ scope_ with_ id - Retrieves a custom OAuth scope.
- retrieve_
oauth_ configuration_ with_ id - Retrieves the Oauth2 configuration for the application for the given Application Id.
- retrieve_
open_ id_ configuration_ with_ id - Returns the well known OpenID Configuration JSON document
- retrieve_
password_ validation_ rules_ with_ id - Retrieves the password validation rules for a specific tenant. This method requires a tenantId to be provided through the use of a Tenant scoped API key or an HTTP header X-FusionAuth-TenantId to specify the Tenant Id. This API does not require an API key.
- retrieve_
password_ validation_ rules_ with_ tenant_ id_ with_ id - Retrieves the password validation rules for a specific tenant. This API does not require an API key.
- retrieve_
pending_ children_ with_ id - Retrieves all the children for the given parent email address.
- retrieve_
pending_ link_ with_ id - Retrieve a pending identity provider link. This is useful to validate a pending link and retrieve meta-data about the identity provider link.
- retrieve_
reactor_ metrics_ with_ id - Retrieves the FusionAuth Reactor metrics.
- retrieve_
refresh_ token_ by_ id_ with_ id - Retrieves a single refresh token by unique Id. This is not the same thing as the string value of the refresh token. If you have that, you already have what you need.
- retrieve_
refresh_ tokens_ with_ id - Retrieves the refresh tokens that belong to the user with the given Id.
- retrieve_
registration_ report_ with_ id - Retrieves the registration report between the two instants. If you specify an application id, it will only return the registration counts for that application.
- retrieve_
registration_ with_ id - Retrieves the user registration for the user with the given Id and the given application id.
- retrieve_
report_ login - Retrieves the login report between the two instants. If you specify an application id, it will only return the login counts for that application. OR Retrieves the login report between the two instants for a particular user by Id. If you specify an application id, it will only return the login counts for that application. OR Retrieves the login report between the two instants for a particular user by login Id. If you specify an application id, it will only return the login counts for that application.
- retrieve_
status - Retrieves the FusionAuth system status. This request is anonymous and does not require an API key. When an API key is not provided the response will contain a single value in the JSON response indicating the current health check. OR Retrieves the FusionAuth system status using an API key. Using an API key will cause the response to include the product version, health checks and various runtime metrics.
- retrieve_
system_ health_ with_ id - Retrieves the FusionAuth system health. This API will return 200 if the system is healthy, and 500 if the system is un-healthy.
- retrieve_
tenant_ with_ id - Retrieves the tenant for the given Id.
- retrieve_
theme_ with_ id - Retrieves the theme for the given Id.
- retrieve_
total_ report_ with_ id - Retrieves the totals report. This contains all the total counts for each application and the global registration count.
- retrieve_
two_ factor_ recovery_ codes_ with_ id - Retrieve two-factor recovery codes for a user.
- retrieve_
two_ factor_ status_ with_ id - Retrieve a user’s two-factor status. This can be used to see if a user will need to complete a two-factor challenge to complete a login, and optionally identify the state of the two-factor trust across various applications.
- retrieve_
user - Retrieves the user for the given username. OR Retrieves the user by a verificationId. The intended use of this API is to retrieve a user after the forgot password workflow has been initiated and you may not know the user’s email or username. OR Retrieves the user by a change password Id. The intended use of this API is to retrieve a user after the forgot password workflow has been initiated and you may not know the user’s email or username. OR Retrieves the user for the given Id. This method does not use an API key, instead it uses a JSON Web Token (JWT) for authentication. OR Retrieves the user for the given email. OR Retrieves the user for the loginId. The loginId can be either the username or the email.
- retrieve_
user_ action - Retrieves all the user actions that are currently inactive. OR Retrieves the user action for the given Id. If you pass in null for the id, this will return all the user actions.
- retrieve_
user_ action_ reason - Retrieves the user action reason for the given Id. If you pass in null for the id, this will return all the user action reasons.
- retrieve_
user_ action_ reason_ with_ id - Retrieves the user action reason for the given Id. If you pass in null for the id, this will return all the user action reasons.
- retrieve_
user_ action_ with_ id - Retrieves the user action for the given Id. If you pass in null for the id, this will return all the user actions.
- retrieve_
user_ actioning - Retrieves all the actions for the user with the given Id that are currently preventing the User from logging in. OR Retrieves all the actions for the user with the given Id. This will return all time based actions that are active, and inactive as well as non-time based actions. OR Retrieves all the actions for the user with the given Id that are currently active. An active action means one that is time based and has not been canceled, and has not ended. OR Retrieves all the actions for the user with the given Id that are currently inactive. An inactive action means one that is time based and has been canceled or has expired, or is not time based.
- retrieve_
user_ change_ password - Check to see if the user must obtain a Trust Request Id in order to complete a change password request. When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change your password, you must obtain a Trust Request Id by completing a Two-Factor Step-Up authentication. An HTTP status code of 400 with a general error code of [TrustTokenRequired] indicates that a Trust Token is required to make a POST request to this API. OR Check to see if the user must obtain a Trust Token Id in order to complete a change password request. When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change your password, you must obtain a Trust Token by completing a Two-Factor Step-Up authentication. An HTTP status code of 400 with a general error code of [TrustTokenRequired] indicates that a Trust Token is required to make a POST request to this API.
- retrieve_
user_ comments_ with_ id - Retrieves all the comments for the user with the given Id.
- retrieve_
user_ consent_ with_ id - Retrieve a single User consent by Id.
- retrieve_
user_ consents_ with_ id - Retrieves all the consents for a User.
- retrieve_
user_ info_ from_ access_ token_ with_ id - Call the UserInfo endpoint to retrieve User Claims from the access token issued by FusionAuth.
- retrieve_
user_ recent_ login - Retrieves the last number of login records. OR Retrieves the last number of login records for a user.
- retrieve_
user_ with_ id - Retrieves the user for the given Id.
- retrieve_
version_ with_ id - Retrieves the FusionAuth version string.
- retrieve_
web_ authn_ credential_ with_ id - Retrieves the WebAuthn credential for the given Id.
- retrieve_
web_ authn_ credentials_ for_ user_ with_ id - Retrieves all WebAuthn credentials for the given user.
- retrieve_
webhook - Retrieves the webhook for the given Id. If you pass in null for the id, this will return all the webhooks.
- retrieve_
webhook_ attempt_ log_ with_ id - Retrieves a single webhook attempt log for the given Id.
- retrieve_
webhook_ event_ log_ with_ id - Retrieves a single webhook event log for the given Id.
- retrieve_
webhook_ with_ id - Retrieves the webhook for the given Id. If you pass in null for the id, this will return all the webhooks.
- revoke_
refresh_ token_ by_ id_ with_ id - Revokes a single refresh token by the unique Id. The unique Id is not sensitive as it cannot be used to obtain another JWT.
- revoke_
user_ consent_ with_ id - Revokes a single User consent by Id.
- search_
applications_ with_ id - Searches applications with the specified criteria and pagination.
- search_
audit_ logs_ with_ id - Searches the audit logs with the specified criteria and pagination.
- search_
consents_ with_ id - Searches consents with the specified criteria and pagination.
- search_
email_ templates_ with_ id - Searches email templates with the specified criteria and pagination.
- search_
entities_ by_ ids_ with_ id - Retrieves the entities for the given ids. If any Id is invalid, it is ignored.
- search_
entities_ with_ id - Searches entities with the specified criteria and pagination.
- search_
entity_ grants_ with_ id - Searches Entity Grants with the specified criteria and pagination.
- search_
entity_ types_ with_ id - Searches the entity types with the specified criteria and pagination.
- search_
event_ logs_ with_ id - Searches the event logs with the specified criteria and pagination.
- search_
group_ members_ with_ id - Searches group members with the specified criteria and pagination.
- search_
groups_ with_ id - Searches groups with the specified criteria and pagination.
- search_
identity_ providers_ with_ id - Searches identity providers with the specified criteria and pagination.
- search_
ip_ access_ control_ lists_ with_ id - Searches the IP Access Control Lists with the specified criteria and pagination.
- search_
keys_ with_ id - Searches keys with the specified criteria and pagination.
- search_
lambdas_ with_ id - Searches lambdas with the specified criteria and pagination.
- search_
login_ records_ with_ id - Searches the login records with the specified criteria and pagination.
- search_
tenants_ with_ id - Searches tenants with the specified criteria and pagination.
- search_
themes_ with_ id - Searches themes with the specified criteria and pagination.
- search_
user_ comments_ with_ id - Searches user comments with the specified criteria and pagination.
- search_
users_ by_ ids_ with_ id - Retrieves the users for the given ids. If any Id is invalid, it is ignored.
- search_
users_ by_ query_ with_ id - Retrieves the users for the given search criteria and pagination.
- search_
webhook_ event_ logs_ with_ id - Searches the webhook event logs with the specified criteria and pagination.
- search_
webhooks_ with_ id - Searches webhooks with the specified criteria and pagination.
- send_
email_ with_ id - Send an email using an email template id. You can optionally provide
requestData
to access key value pairs in the email template. - send_
family_ request_ email_ with_ id - Sends out an email to a parent that they need to register and create a family or need to log in and add a child to their existing family.
- send_
passwordless_ code_ with_ id - Send a passwordless authentication code in an email to complete login.
- send_
two_ factor_ code_ for_ enable_ disable_ with_ id - Send a Two Factor authentication code to assist in setting up Two Factor authentication or disabling.
- send_
two_ factor_ code_ for_ login_ using_ method_ with_ id - Send a Two Factor authentication code to allow the completion of Two Factor authentication.
- start_
identity_ provider_ login_ with_ id - Begins a login request for a 3rd party login that requires user interaction such as HYPR.
- start_
passwordless_ login_ with_ id - Start a passwordless login request by generating a passwordless code. This code can be sent to the User using the Send Passwordless Code API or using a mechanism outside of FusionAuth. The passwordless login is completed by using the Passwordless Login API with this code.
- start_
two_ factor_ login_ with_ id - Start a Two-Factor login request by generating a two-factor identifier. This code can then be sent to the Two Factor Send API (/api/two-factor/send)in order to send a one-time use code to a user. You can also use one-time use code returned to send the code out-of-band. The Two-Factor login is completed by making a request to the Two-Factor Login API (/api/two-factor/login). with the two-factor identifier and the one-time use code. This API is intended to allow you to begin a Two-Factor login outside a normal login that originated from the Login API (/api/login).
- start_
web_ authn_ login_ with_ id - Start a WebAuthn authentication ceremony by generating a new challenge for the user
- start_
web_ authn_ registration_ with_ id - Start a WebAuthn registration ceremony by generating a new challenge for the user
- two_
factor_ login_ with_ id - Complete login using a 2FA challenge
- update_
api_ key_ with_ id - Updates an API key by given id
- update_
application_ role_ with_ id - Updates the application role with the given Id for the application.
- update_
application_ with_ id - Updates the application with the given Id. OR Reactivates the application with the given Id.
- update_
connector_ with_ id - Updates the connector with the given Id.
- update_
consent_ with_ id - Updates the consent with the given Id.
- update_
email_ template_ with_ id - Updates the email template with the given Id.
- update_
entity_ type_ permission_ with_ id - Updates the permission with the given Id for the entity type.
- update_
entity_ type_ with_ id - Updates the Entity Type with the given Id.
- update_
entity_ with_ id - Updates the Entity with the given Id.
- update_
form_ field_ with_ id - Updates the form field with the given Id.
- update_
form_ with_ id - Updates the form with the given Id.
- update_
group_ members_ with_ id - Creates a member in a group.
- update_
group_ with_ id - Updates the group with the given Id.
- update_
identity_ provider_ with_ id - Updates the identity provider with the given Id.
- update_
integrations_ with_ id - Updates the available integrations.
- update_
ip_ access_ control_ list_ with_ id - Updates the IP Access Control List with the given Id.
- update_
key_ with_ id - Updates the key with the given Id.
- update_
lambda_ with_ id - Updates the lambda with the given Id.
- update_
message_ template_ with_ id - Updates the message template with the given Id.
- update_
messenger_ with_ id - Updates the messenger with the given Id.
- update_
o_ auth_ scope_ with_ id - Updates the OAuth scope with the given Id for the application.
- update_
registration_ with_ id - Updates the registration for the user with the given Id and the application defined in the request.
- update_
system_ configuration_ with_ id - Updates the system configuration.
- update_
tenant_ with_ id - Updates the tenant with the given Id.
- update_
theme_ with_ id - Updates the theme with the given Id.
- update_
user_ action_ reason_ with_ id - Updates the user action reason with the given Id.
- update_
user_ action_ with_ id - Reactivates the user action with the given Id. OR Updates the user action with the given Id.
- update_
user_ consent_ with_ id - Updates a single User consent by Id.
- update_
user_ family_ with_ id - Updates a family with a given Id. OR Adds a user to an existing family. The family Id must be specified.
- update_
user_ verify_ email - Re-sends the verification email to the user. OR Re-sends the verification email to the user. If the Application has configured a specific email template this will be used instead of the tenant configuration. OR Generate a new Email Verification Id to be used with the Verify Email API. This API will not attempt to send an email to the User. This API may be used to collect the verificationId for use with a third party system.
- update_
user_ verify_ registration - Generate a new Application Registration Verification Id to be used with the Verify Registration API. This API will not attempt to send an email to the User. This API may be used to collect the verificationId for use with a third party system. OR Re-sends the application registration verification email to the user.
- update_
user_ with_ id - Reactivates the user with the given Id. OR Updates the user with the given Id.
- update_
webhook_ with_ id - Updates the webhook with the given Id.
- upsert_
entity_ grant_ with_ id - Creates or updates an Entity Grant. This is when a User/Entity is granted permissions to an Entity.
- validate_
device_ with_ id - Validates the end-user provided user_code from the user-interaction of the Device Authorization Grant. If you build your own activation form you should validate the user provided code prior to beginning the Authorization grant.
- validate_
jwt_ with_ id - Validates the provided JWT (encoded JWT string) to ensure the token is valid. A valid access token is properly signed and not expired.
This API may be used to verify the JWT as well as decode the encoded JWT into human readable identity claims.
- vend_
jwt_ with_ id - It’s a JWT vending machine! Issue a new access token (JWT) with the provided claims in the request. This JWT is not scoped to a tenant or user, it is a free form token that will contain what claims you provide.
The iat, exp and jti claims will be added by FusionAuth, all other claims must be provided by the caller. If a TTL is not provided in the request, the TTL will be retrieved from the default Tenant or the Tenant specified on the request either by way of the X-FusionAuth-TenantId request header, or a tenant scoped API key.
- verify_
user_ registration_ with_ id - Confirms a user’s registration. The request body will contain the verificationId. You may also be required to send a one-time use code based upon your configuration. When the application is configured to gate a user until their registration is verified, this procedures requires two values instead of one. The verificationId is a high entropy value and the one-time use code is a low entropy value that is easily entered in a user interactive form. The two values together are able to confirm a user’s registration and mark the user’s registration as verified.