Module default_api

Source

Enums§

ActionUserWithIdError
struct for typed errors of method action_user_with_id
ActivateReactorWithIdError
struct for typed errors of method activate_reactor_with_id
ApproveDeviceWithIdError
struct for typed errors of method approve_device_with_id
CancelActionWithIdError
struct for typed errors of method cancel_action_with_id
ChangePasswordByIdentityWithIdError
struct for typed errors of method change_password_by_identity_with_id
ChangePasswordWithIdError
struct for typed errors of method change_password_with_id
CheckChangePasswordUsingIdWithIdError
struct for typed errors of method check_change_password_using_id_with_id
CommentOnUserWithIdError
struct for typed errors of method comment_on_user_with_id
CompleteWebAuthnAssertionWithIdError
struct for typed errors of method complete_web_authn_assertion_with_id
CompleteWebAuthnLoginWithIdError
struct for typed errors of method complete_web_authn_login_with_id
CompleteWebAuthnRegistrationWithIdError
struct for typed errors of method complete_web_authn_registration_with_id
CreateApiKeyError
struct for typed errors of method create_api_key
CreateApiKeyWithIdError
struct for typed errors of method create_api_key_with_id
CreateApplicationError
struct for typed errors of method create_application
CreateApplicationRoleError
struct for typed errors of method create_application_role
CreateApplicationRoleWithIdError
struct for typed errors of method create_application_role_with_id
CreateApplicationWithIdError
struct for typed errors of method create_application_with_id
CreateAuditLogWithIdError
struct for typed errors of method create_audit_log_with_id
CreateConnectorError
struct for typed errors of method create_connector
CreateConnectorWithIdError
struct for typed errors of method create_connector_with_id
CreateConsentError
struct for typed errors of method create_consent
CreateConsentWithIdError
struct for typed errors of method create_consent_with_id
CreateEmailTemplateError
struct for typed errors of method create_email_template
CreateEmailTemplateWithIdError
struct for typed errors of method create_email_template_with_id
CreateEntityError
struct for typed errors of method create_entity
CreateEntityTypeError
struct for typed errors of method create_entity_type
CreateEntityTypePermissionError
struct for typed errors of method create_entity_type_permission
CreateEntityTypePermissionWithIdError
struct for typed errors of method create_entity_type_permission_with_id
CreateEntityTypeWithIdError
struct for typed errors of method create_entity_type_with_id
CreateEntityWithIdError
struct for typed errors of method create_entity_with_id
CreateFamilyError
struct for typed errors of method create_family
CreateFamilyWithIdError
struct for typed errors of method create_family_with_id
CreateFormError
struct for typed errors of method create_form
CreateFormFieldError
struct for typed errors of method create_form_field
CreateFormFieldWithIdError
struct for typed errors of method create_form_field_with_id
CreateFormWithIdError
struct for typed errors of method create_form_with_id
CreateGroupError
struct for typed errors of method create_group
CreateGroupMembersWithIdError
struct for typed errors of method create_group_members_with_id
CreateGroupWithIdError
struct for typed errors of method create_group_with_id
CreateIdentityProviderError
struct for typed errors of method create_identity_provider
CreateIdentityProviderWithIdError
struct for typed errors of method create_identity_provider_with_id
CreateIntrospectError
struct for typed errors of method create_introspect
CreateIpAccessControlListError
struct for typed errors of method create_ip_access_control_list
CreateIpAccessControlListWithIdError
struct for typed errors of method create_ip_access_control_list_with_id
CreateLambdaError
struct for typed errors of method create_lambda
CreateLambdaWithIdError
struct for typed errors of method create_lambda_with_id
CreateLogoutError
struct for typed errors of method create_logout
CreateMessageTemplateError
struct for typed errors of method create_message_template
CreateMessageTemplateWithIdError
struct for typed errors of method create_message_template_with_id
CreateMessengerError
struct for typed errors of method create_messenger
CreateMessengerWithIdError
struct for typed errors of method create_messenger_with_id
CreateOAuthScopeError
struct for typed errors of method create_o_auth_scope
CreateOAuthScopeWithIdError
struct for typed errors of method create_o_auth_scope_with_id
CreateTenantError
struct for typed errors of method create_tenant
CreateTenantWithIdError
struct for typed errors of method create_tenant_with_id
CreateThemeError
struct for typed errors of method create_theme
CreateThemeWithIdError
struct for typed errors of method create_theme_with_id
CreateTokenError
struct for typed errors of method create_token
CreateUserActionError
struct for typed errors of method create_user_action
CreateUserActionReasonError
struct for typed errors of method create_user_action_reason
CreateUserActionReasonWithIdError
struct for typed errors of method create_user_action_reason_with_id
CreateUserActionWithIdError
struct for typed errors of method create_user_action_with_id
CreateUserConsentError
struct for typed errors of method create_user_consent
CreateUserConsentWithIdError
struct for typed errors of method create_user_consent_with_id
CreateUserError
struct for typed errors of method create_user
CreateUserLinkWithIdError
struct for typed errors of method create_user_link_with_id
CreateUserVerifyEmailError
struct for typed errors of method create_user_verify_email
CreateUserWithIdError
struct for typed errors of method create_user_with_id
CreateWebhookError
struct for typed errors of method create_webhook
CreateWebhookWithIdError
struct for typed errors of method create_webhook_with_id
DeleteApiKeyWithIdError
struct for typed errors of method delete_api_key_with_id
DeleteApplicationRoleWithIdError
struct for typed errors of method delete_application_role_with_id
DeleteApplicationWithIdError
struct for typed errors of method delete_application_with_id
DeleteConnectorWithIdError
struct for typed errors of method delete_connector_with_id
DeleteConsentWithIdError
struct for typed errors of method delete_consent_with_id
DeleteEmailTemplateWithIdError
struct for typed errors of method delete_email_template_with_id
DeleteEntityGrantWithIdError
struct for typed errors of method delete_entity_grant_with_id
DeleteEntityTypePermissionWithIdError
struct for typed errors of method delete_entity_type_permission_with_id
DeleteEntityTypeWithIdError
struct for typed errors of method delete_entity_type_with_id
DeleteEntityWithIdError
struct for typed errors of method delete_entity_with_id
DeleteFormFieldWithIdError
struct for typed errors of method delete_form_field_with_id
DeleteFormWithIdError
struct for typed errors of method delete_form_with_id
DeleteGroupMembersWithIdError
struct for typed errors of method delete_group_members_with_id
DeleteGroupWithIdError
struct for typed errors of method delete_group_with_id
DeleteIdentityProviderWithIdError
struct for typed errors of method delete_identity_provider_with_id
DeleteIpAccessControlListWithIdError
struct for typed errors of method delete_ip_access_control_list_with_id
DeleteJwtRefreshError
struct for typed errors of method delete_jwt_refresh
DeleteKeyWithIdError
struct for typed errors of method delete_key_with_id
DeleteLambdaWithIdError
struct for typed errors of method delete_lambda_with_id
DeleteMessageTemplateWithIdError
struct for typed errors of method delete_message_template_with_id
DeleteMessengerWithIdError
struct for typed errors of method delete_messenger_with_id
DeleteOAuthScopeWithIdError
struct for typed errors of method delete_o_auth_scope_with_id
DeleteTenantWithIdError
struct for typed errors of method delete_tenant_with_id
DeleteThemeWithIdError
struct for typed errors of method delete_theme_with_id
DeleteUserActionReasonWithIdError
struct for typed errors of method delete_user_action_reason_with_id
DeleteUserActionWithIdError
struct for typed errors of method delete_user_action_with_id
DeleteUserBulkError
struct for typed errors of method delete_user_bulk
DeleteUserLinkWithIdError
struct for typed errors of method delete_user_link_with_id
DeleteUserRegistrationWithIdError
struct for typed errors of method delete_user_registration_with_id
DeleteUserTwoFactorWithIdError
struct for typed errors of method delete_user_two_factor_with_id
DeleteUserWithIdError
struct for typed errors of method delete_user_with_id
DeleteWebAuthnCredentialWithIdError
struct for typed errors of method delete_web_authn_credential_with_id
DeleteWebhookWithIdError
struct for typed errors of method delete_webhook_with_id
EnableTwoFactorWithIdError
struct for typed errors of method enable_two_factor_with_id
ExchangeRefreshTokenForJwtWithIdError
struct for typed errors of method exchange_refresh_token_for_jwt_with_id
ForgotPasswordWithIdError
struct for typed errors of method forgot_password_with_id
GenerateKeyError
struct for typed errors of method generate_key
GenerateKeyWithIdError
struct for typed errors of method generate_key_with_id
GenerateTwoFactorRecoveryCodesWithIdError
struct for typed errors of method generate_two_factor_recovery_codes_with_id
GenerateTwoFactorSecretUsingJwtWithIdError
struct for typed errors of method generate_two_factor_secret_using_jwt_with_id
IdentityProviderLoginWithIdError
struct for typed errors of method identity_provider_login_with_id
ImportKeyError
struct for typed errors of method import_key
ImportKeyWithIdError
struct for typed errors of method import_key_with_id
ImportRefreshTokensWithIdError
struct for typed errors of method import_refresh_tokens_with_id
ImportUsersWithIdError
struct for typed errors of method import_users_with_id
ImportWebAuthnCredentialWithIdError
struct for typed errors of method import_web_authn_credential_with_id
IssueJwtWithIdError
struct for typed errors of method issue_jwt_with_id
LoginPingWithIdError
struct for typed errors of method login_ping_with_id
LoginPingWithRequestWithIdError
struct for typed errors of method login_ping_with_request_with_id
LoginWithIdError
struct for typed errors of method login_with_id
LookupIdentityProviderWithIdError
struct for typed errors of method lookup_identity_provider_with_id
ModifyActionWithIdError
struct for typed errors of method modify_action_with_id
PasswordlessLoginWithIdError
struct for typed errors of method passwordless_login_with_id
PatchApplicationRoleWithIdError
struct for typed errors of method patch_application_role_with_id
PatchApplicationWithIdError
struct for typed errors of method patch_application_with_id
PatchConnectorWithIdError
struct for typed errors of method patch_connector_with_id
PatchConsentWithIdError
struct for typed errors of method patch_consent_with_id
PatchEmailTemplateWithIdError
struct for typed errors of method patch_email_template_with_id
PatchEntityTypePermissionWithIdError
struct for typed errors of method patch_entity_type_permission_with_id
PatchEntityTypeWithIdError
struct for typed errors of method patch_entity_type_with_id
PatchEntityWithIdError
struct for typed errors of method patch_entity_with_id
PatchFormFieldWithIdError
struct for typed errors of method patch_form_field_with_id
PatchFormWithIdError
struct for typed errors of method patch_form_with_id
PatchGroupWithIdError
struct for typed errors of method patch_group_with_id
PatchIdentityProviderWithIdError
struct for typed errors of method patch_identity_provider_with_id
PatchIntegrationsWithIdError
struct for typed errors of method patch_integrations_with_id
PatchIpAccessControlListWithIdError
struct for typed errors of method patch_ip_access_control_list_with_id
PatchLambdaWithIdError
struct for typed errors of method patch_lambda_with_id
PatchMessageTemplateWithIdError
struct for typed errors of method patch_message_template_with_id
PatchMessengerWithIdError
struct for typed errors of method patch_messenger_with_id
PatchOAuthScopeWithIdError
struct for typed errors of method patch_o_auth_scope_with_id
PatchRegistrationWithIdError
struct for typed errors of method patch_registration_with_id
PatchSystemConfigurationWithIdError
struct for typed errors of method patch_system_configuration_with_id
PatchTenantWithIdError
struct for typed errors of method patch_tenant_with_id
PatchThemeWithIdError
struct for typed errors of method patch_theme_with_id
PatchUserActionReasonWithIdError
struct for typed errors of method patch_user_action_reason_with_id
PatchUserActionWithIdError
struct for typed errors of method patch_user_action_with_id
PatchUserConsentWithIdError
struct for typed errors of method patch_user_consent_with_id
PatchUserWithIdError
struct for typed errors of method patch_user_with_id
PatchWebhookWithIdError
struct for typed errors of method patch_webhook_with_id
ReconcileJwtWithIdError
struct for typed errors of method reconcile_jwt_with_id
RegisterError
struct for typed errors of method register
RegisterWithIdError
struct for typed errors of method register_with_id
ReindexWithIdError
struct for typed errors of method reindex_with_id
RemoveUserFromFamilyWithIdError
struct for typed errors of method remove_user_from_family_with_id
RetrieveActionWithIdError
struct for typed errors of method retrieve_action_with_id
RetrieveApiKeyWithIdError
struct for typed errors of method retrieve_api_key_with_id
RetrieveApplicationError
struct for typed errors of method retrieve_application
RetrieveApplicationWithIdError
struct for typed errors of method retrieve_application_with_id
RetrieveAuditLogWithIdError
struct for typed errors of method retrieve_audit_log_with_id
RetrieveConnectorWithIdError
struct for typed errors of method retrieve_connector_with_id
RetrieveConsentWithIdError
struct for typed errors of method retrieve_consent_with_id
RetrieveDailyActiveReportWithIdError
struct for typed errors of method retrieve_daily_active_report_with_id
RetrieveDeviceUserCodeError
struct for typed errors of method retrieve_device_user_code
RetrieveEmailTemplateError
struct for typed errors of method retrieve_email_template
RetrieveEmailTemplatePreviewWithIdError
struct for typed errors of method retrieve_email_template_preview_with_id
RetrieveEmailTemplateWithIdError
struct for typed errors of method retrieve_email_template_with_id
RetrieveEntityGrantWithIdError
struct for typed errors of method retrieve_entity_grant_with_id
RetrieveEntityTypeWithIdError
struct for typed errors of method retrieve_entity_type_with_id
RetrieveEntityWithIdError
struct for typed errors of method retrieve_entity_with_id
RetrieveEventLogWithIdError
struct for typed errors of method retrieve_event_log_with_id
RetrieveFamiliesWithIdError
struct for typed errors of method retrieve_families_with_id
RetrieveFamilyMembersByFamilyIdWithIdError
struct for typed errors of method retrieve_family_members_by_family_id_with_id
RetrieveFormFieldWithIdError
struct for typed errors of method retrieve_form_field_with_id
RetrieveFormWithIdError
struct for typed errors of method retrieve_form_with_id
RetrieveGroupWithIdError
struct for typed errors of method retrieve_group_with_id
RetrieveIdentityProviderByTypeWithIdError
struct for typed errors of method retrieve_identity_provider_by_type_with_id
RetrieveIdentityProviderLinkError
struct for typed errors of method retrieve_identity_provider_link
RetrieveIdentityProviderWithIdError
struct for typed errors of method retrieve_identity_provider_with_id
RetrieveIpAccessControlListWithIdError
struct for typed errors of method retrieve_ip_access_control_list_with_id
RetrieveJsonWebKeySetWithIdError
struct for typed errors of method retrieve_json_web_key_set_with_id
RetrieveJwtPublicKeyError
struct for typed errors of method retrieve_jwt_public_key
RetrieveKeyWithIdError
struct for typed errors of method retrieve_key_with_id
RetrieveKeysWithIdError
struct for typed errors of method retrieve_keys_with_id
RetrieveLambdaWithIdError
struct for typed errors of method retrieve_lambda_with_id
RetrieveLambdasByTypeWithIdError
struct for typed errors of method retrieve_lambdas_by_type_with_id
RetrieveMessageTemplateError
struct for typed errors of method retrieve_message_template
RetrieveMessageTemplatePreviewWithIdError
struct for typed errors of method retrieve_message_template_preview_with_id
RetrieveMessageTemplateWithIdError
struct for typed errors of method retrieve_message_template_with_id
RetrieveMessengerWithIdError
struct for typed errors of method retrieve_messenger_with_id
RetrieveMonthlyActiveReportWithIdError
struct for typed errors of method retrieve_monthly_active_report_with_id
RetrieveOAuthScopeWithIdError
struct for typed errors of method retrieve_o_auth_scope_with_id
RetrieveOauthConfigurationWithIdError
struct for typed errors of method retrieve_oauth_configuration_with_id
RetrieveOpenIdConfigurationWithIdError
struct for typed errors of method retrieve_open_id_configuration_with_id
RetrievePasswordValidationRulesWithIdError
struct for typed errors of method retrieve_password_validation_rules_with_id
RetrievePasswordValidationRulesWithTenantIdWithIdError
struct for typed errors of method retrieve_password_validation_rules_with_tenant_id_with_id
RetrievePendingChildrenWithIdError
struct for typed errors of method retrieve_pending_children_with_id
RetrievePendingLinkWithIdError
struct for typed errors of method retrieve_pending_link_with_id
RetrieveReactorMetricsWithIdError
struct for typed errors of method retrieve_reactor_metrics_with_id
RetrieveRefreshTokenByIdWithIdError
struct for typed errors of method retrieve_refresh_token_by_id_with_id
RetrieveRefreshTokensWithIdError
struct for typed errors of method retrieve_refresh_tokens_with_id
RetrieveRegistrationReportWithIdError
struct for typed errors of method retrieve_registration_report_with_id
RetrieveRegistrationWithIdError
struct for typed errors of method retrieve_registration_with_id
RetrieveReportLoginError
struct for typed errors of method retrieve_report_login
RetrieveStatusError
struct for typed errors of method retrieve_status
RetrieveSystemHealthWithIdError
struct for typed errors of method retrieve_system_health_with_id
RetrieveTenantWithIdError
struct for typed errors of method retrieve_tenant_with_id
RetrieveThemeWithIdError
struct for typed errors of method retrieve_theme_with_id
RetrieveTotalReportWithIdError
struct for typed errors of method retrieve_total_report_with_id
RetrieveTwoFactorRecoveryCodesWithIdError
struct for typed errors of method retrieve_two_factor_recovery_codes_with_id
RetrieveTwoFactorStatusWithIdError
struct for typed errors of method retrieve_two_factor_status_with_id
RetrieveUserActionError
struct for typed errors of method retrieve_user_action
RetrieveUserActionReasonError
struct for typed errors of method retrieve_user_action_reason
RetrieveUserActionReasonWithIdError
struct for typed errors of method retrieve_user_action_reason_with_id
RetrieveUserActionWithIdError
struct for typed errors of method retrieve_user_action_with_id
RetrieveUserActioningError
struct for typed errors of method retrieve_user_actioning
RetrieveUserChangePasswordError
struct for typed errors of method retrieve_user_change_password
RetrieveUserCommentsWithIdError
struct for typed errors of method retrieve_user_comments_with_id
RetrieveUserConsentWithIdError
struct for typed errors of method retrieve_user_consent_with_id
RetrieveUserConsentsWithIdError
struct for typed errors of method retrieve_user_consents_with_id
RetrieveUserError
struct for typed errors of method retrieve_user
RetrieveUserInfoFromAccessTokenWithIdError
struct for typed errors of method retrieve_user_info_from_access_token_with_id
RetrieveUserRecentLoginError
struct for typed errors of method retrieve_user_recent_login
RetrieveUserWithIdError
struct for typed errors of method retrieve_user_with_id
RetrieveVersionWithIdError
struct for typed errors of method retrieve_version_with_id
RetrieveWebAuthnCredentialWithIdError
struct for typed errors of method retrieve_web_authn_credential_with_id
RetrieveWebAuthnCredentialsForUserWithIdError
struct for typed errors of method retrieve_web_authn_credentials_for_user_with_id
RetrieveWebhookAttemptLogWithIdError
struct for typed errors of method retrieve_webhook_attempt_log_with_id
RetrieveWebhookError
struct for typed errors of method retrieve_webhook
RetrieveWebhookEventLogWithIdError
struct for typed errors of method retrieve_webhook_event_log_with_id
RetrieveWebhookWithIdError
struct for typed errors of method retrieve_webhook_with_id
RevokeRefreshTokenByIdWithIdError
struct for typed errors of method revoke_refresh_token_by_id_with_id
RevokeUserConsentWithIdError
struct for typed errors of method revoke_user_consent_with_id
SearchApplicationsWithIdError
struct for typed errors of method search_applications_with_id
SearchAuditLogsWithIdError
struct for typed errors of method search_audit_logs_with_id
SearchConsentsWithIdError
struct for typed errors of method search_consents_with_id
SearchEmailTemplatesWithIdError
struct for typed errors of method search_email_templates_with_id
SearchEntitiesByIdsWithIdError
struct for typed errors of method search_entities_by_ids_with_id
SearchEntitiesWithIdError
struct for typed errors of method search_entities_with_id
SearchEntityGrantsWithIdError
struct for typed errors of method search_entity_grants_with_id
SearchEntityTypesWithIdError
struct for typed errors of method search_entity_types_with_id
SearchEventLogsWithIdError
struct for typed errors of method search_event_logs_with_id
SearchGroupMembersWithIdError
struct for typed errors of method search_group_members_with_id
SearchGroupsWithIdError
struct for typed errors of method search_groups_with_id
SearchIdentityProvidersWithIdError
struct for typed errors of method search_identity_providers_with_id
SearchIpAccessControlListsWithIdError
struct for typed errors of method search_ip_access_control_lists_with_id
SearchKeysWithIdError
struct for typed errors of method search_keys_with_id
SearchLambdasWithIdError
struct for typed errors of method search_lambdas_with_id
SearchLoginRecordsWithIdError
struct for typed errors of method search_login_records_with_id
SearchTenantsWithIdError
struct for typed errors of method search_tenants_with_id
SearchThemesWithIdError
struct for typed errors of method search_themes_with_id
SearchUserCommentsWithIdError
struct for typed errors of method search_user_comments_with_id
SearchUsersByIdsWithIdError
struct for typed errors of method search_users_by_ids_with_id
SearchUsersByQueryWithIdError
struct for typed errors of method search_users_by_query_with_id
SearchWebhookEventLogsWithIdError
struct for typed errors of method search_webhook_event_logs_with_id
SearchWebhooksWithIdError
struct for typed errors of method search_webhooks_with_id
SendEmailWithIdError
struct for typed errors of method send_email_with_id
SendFamilyRequestEmailWithIdError
struct for typed errors of method send_family_request_email_with_id
SendPasswordlessCodeWithIdError
struct for typed errors of method send_passwordless_code_with_id
SendTwoFactorCodeForEnableDisableWithIdError
struct for typed errors of method send_two_factor_code_for_enable_disable_with_id
SendTwoFactorCodeForLoginUsingMethodWithIdError
struct for typed errors of method send_two_factor_code_for_login_using_method_with_id
StartIdentityProviderLoginWithIdError
struct for typed errors of method start_identity_provider_login_with_id
StartPasswordlessLoginWithIdError
struct for typed errors of method start_passwordless_login_with_id
StartTwoFactorLoginWithIdError
struct for typed errors of method start_two_factor_login_with_id
StartWebAuthnLoginWithIdError
struct for typed errors of method start_web_authn_login_with_id
StartWebAuthnRegistrationWithIdError
struct for typed errors of method start_web_authn_registration_with_id
TwoFactorLoginWithIdError
struct for typed errors of method two_factor_login_with_id
UpdateApiKeyWithIdError
struct for typed errors of method update_api_key_with_id
UpdateApplicationRoleWithIdError
struct for typed errors of method update_application_role_with_id
UpdateApplicationWithIdError
struct for typed errors of method update_application_with_id
UpdateConnectorWithIdError
struct for typed errors of method update_connector_with_id
UpdateConsentWithIdError
struct for typed errors of method update_consent_with_id
UpdateEmailTemplateWithIdError
struct for typed errors of method update_email_template_with_id
UpdateEntityTypePermissionWithIdError
struct for typed errors of method update_entity_type_permission_with_id
UpdateEntityTypeWithIdError
struct for typed errors of method update_entity_type_with_id
UpdateEntityWithIdError
struct for typed errors of method update_entity_with_id
UpdateFormFieldWithIdError
struct for typed errors of method update_form_field_with_id
UpdateFormWithIdError
struct for typed errors of method update_form_with_id
UpdateGroupMembersWithIdError
struct for typed errors of method update_group_members_with_id
UpdateGroupWithIdError
struct for typed errors of method update_group_with_id
UpdateIdentityProviderWithIdError
struct for typed errors of method update_identity_provider_with_id
UpdateIntegrationsWithIdError
struct for typed errors of method update_integrations_with_id
UpdateIpAccessControlListWithIdError
struct for typed errors of method update_ip_access_control_list_with_id
UpdateKeyWithIdError
struct for typed errors of method update_key_with_id
UpdateLambdaWithIdError
struct for typed errors of method update_lambda_with_id
UpdateMessageTemplateWithIdError
struct for typed errors of method update_message_template_with_id
UpdateMessengerWithIdError
struct for typed errors of method update_messenger_with_id
UpdateOAuthScopeWithIdError
struct for typed errors of method update_o_auth_scope_with_id
UpdateRegistrationWithIdError
struct for typed errors of method update_registration_with_id
UpdateSystemConfigurationWithIdError
struct for typed errors of method update_system_configuration_with_id
UpdateTenantWithIdError
struct for typed errors of method update_tenant_with_id
UpdateThemeWithIdError
struct for typed errors of method update_theme_with_id
UpdateUserActionReasonWithIdError
struct for typed errors of method update_user_action_reason_with_id
UpdateUserActionWithIdError
struct for typed errors of method update_user_action_with_id
UpdateUserConsentWithIdError
struct for typed errors of method update_user_consent_with_id
UpdateUserFamilyWithIdError
struct for typed errors of method update_user_family_with_id
UpdateUserVerifyEmailError
struct for typed errors of method update_user_verify_email
UpdateUserVerifyRegistrationError
struct for typed errors of method update_user_verify_registration
UpdateUserWithIdError
struct for typed errors of method update_user_with_id
UpdateWebhookWithIdError
struct for typed errors of method update_webhook_with_id
UpsertEntityGrantWithIdError
struct for typed errors of method upsert_entity_grant_with_id
ValidateDeviceWithIdError
struct for typed errors of method validate_device_with_id
ValidateJwtWithIdError
struct for typed errors of method validate_jwt_with_id
VendJwtWithIdError
struct for typed errors of method vend_jwt_with_id
VerifyUserRegistrationWithIdError
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.