Class: FusionAuth::FusionAuthClient
- Inherits:
-
Object
- Object
- FusionAuth::FusionAuthClient
- Defined in:
- lib/fusionauth/fusionauth_client.rb
Overview
This class is the the Ruby client library for the FusionAuth CIAM Platform https://fusionauth.io
Each method on this class calls one of the APIs for FusionAuth. In most cases, the methods will take either a Hash, an OpenStruct or any object that can be safely converted to JSON that conforms to the FusionAuth API interface. Likewise, most methods will return an OpenStruct that contains the response JSON from FusionAuth.
noinspection RubyInstanceMethodNamingConvention,RubyTooManyMethodsInspection,RubyParameterNamingConvention
Instance Attribute Summary collapse
-
#api_key ⇒ Object
Returns the value of attribute api_key.
-
#base_url ⇒ Object
Returns the value of attribute base_url.
-
#connect_timeout ⇒ Object
Returns the value of attribute connect_timeout.
-
#read_timeout ⇒ Object
Returns the value of attribute read_timeout.
-
#tenant_id ⇒ Object
Returns the value of attribute tenant_id.
Instance Method Summary collapse
-
#action_user(request) ⇒ FusionAuth::ClientResponse
Takes an action on a user.
-
#activate_reactor(request) ⇒ FusionAuth::ClientResponse
Activates the FusionAuth Reactor using a license Id and optionally a license text (for air-gapped deployments).
-
#add_user_to_family(family_id, request) ⇒ FusionAuth::ClientResponse
Adds a user to an existing family.
-
#approve_device(client_id, client_secret, token, user_code) ⇒ FusionAuth::ClientResponse
Approve a device grant.
-
#cancel_action(action_id, request) ⇒ FusionAuth::ClientResponse
Cancels the user action.
-
#change_password(change_password_id, request) ⇒ FusionAuth::ClientResponse
Changes a user’s password using the change password Id.
-
#change_password_by_identity(request) ⇒ FusionAuth::ClientResponse
Changes a user’s password using their identity (loginId and password).
-
#check_change_password_using_id(change_password_id) ⇒ FusionAuth::ClientResponse
Check to see if the user must obtain a Trust Token Id in order to complete a change password request.
-
#check_change_password_using_jwt(encoded_jwt) ⇒ FusionAuth::ClientResponse
Check to see if the user must obtain a Trust Token Id in order to complete a change password request.
-
#check_change_password_using_login_id(login_id) ⇒ FusionAuth::ClientResponse
Check to see if the user must obtain a Trust Request Id in order to complete a change password request.
-
#client_credentials_grant(client_id, client_secret, scope) ⇒ FusionAuth::ClientResponse
Make a Client Credentials grant request to obtain an access token.
-
#comment_on_user(request) ⇒ FusionAuth::ClientResponse
Adds a comment to the user’s account.
-
#complete_web_authn_assertion(request) ⇒ FusionAuth::ClientResponse
Complete a WebAuthn authentication ceremony by validating the signature against the previously generated challenge without logging the user in.
-
#complete_web_authn_login(request) ⇒ FusionAuth::ClientResponse
Complete a WebAuthn authentication ceremony by validating the signature against the previously generated challenge and then login the user in.
-
#complete_web_authn_registration(request) ⇒ FusionAuth::ClientResponse
Complete a WebAuthn registration ceremony by validating the client request and saving the new credential.
-
#create_api_key(key_id, request) ⇒ FusionAuth::ClientResponse
Creates an API key.
-
#create_application(application_id, request) ⇒ FusionAuth::ClientResponse
Creates an application.
-
#create_application_role(application_id, role_id, request) ⇒ FusionAuth::ClientResponse
Creates a new role for an application.
-
#create_audit_log(request) ⇒ FusionAuth::ClientResponse
Creates an audit log with the message and user name (usually an email).
-
#create_connector(connector_id, request) ⇒ FusionAuth::ClientResponse
Creates a connector.
-
#create_consent(consent_id, request) ⇒ FusionAuth::ClientResponse
Creates a user consent type.
-
#create_email_template(email_template_id, request) ⇒ FusionAuth::ClientResponse
Creates an email template.
-
#create_entity(entity_id, request) ⇒ FusionAuth::ClientResponse
Creates an Entity.
-
#create_entity_type(entity_type_id, request) ⇒ FusionAuth::ClientResponse
Creates a Entity Type.
-
#create_entity_type_permission(entity_type_id, permission_id, request) ⇒ FusionAuth::ClientResponse
Creates a new permission for an entity type.
-
#create_family(family_id, request) ⇒ FusionAuth::ClientResponse
Creates a family with the user Id in the request as the owner and sole member of the family.
-
#create_form(form_id, request) ⇒ FusionAuth::ClientResponse
Creates a form.
-
#create_form_field(field_id, request) ⇒ FusionAuth::ClientResponse
Creates a form field.
-
#create_group(group_id, request) ⇒ FusionAuth::ClientResponse
Creates a group.
-
#create_group_members(request) ⇒ FusionAuth::ClientResponse
Creates a member in a group.
-
#create_identity_provider(identity_provider_id, request) ⇒ FusionAuth::ClientResponse
Creates an identity provider.
-
#create_ip_access_control_list(access_control_list_id, request) ⇒ FusionAuth::ClientResponse
Creates an IP Access Control List.
-
#create_lambda(lambda_id, request) ⇒ FusionAuth::ClientResponse
Creates a Lambda.
-
#create_message_template(message_template_id, request) ⇒ FusionAuth::ClientResponse
Creates an message template.
-
#create_messenger(messenger_id, request) ⇒ FusionAuth::ClientResponse
Creates a messenger.
-
#create_tenant(tenant_id, request) ⇒ FusionAuth::ClientResponse
Creates a tenant.
-
#create_theme(theme_id, request) ⇒ FusionAuth::ClientResponse
Creates a Theme.
-
#create_user(user_id, request) ⇒ FusionAuth::ClientResponse
Creates a user.
-
#create_user_action(user_action_id, request) ⇒ FusionAuth::ClientResponse
Creates a user action.
-
#create_user_action_reason(user_action_reason_id, request) ⇒ FusionAuth::ClientResponse
Creates a user reason.
-
#create_user_consent(user_consent_id, request) ⇒ FusionAuth::ClientResponse
Creates a single User consent.
-
#create_user_link(request) ⇒ FusionAuth::ClientResponse
Link an external user from a 3rd party identity provider to a FusionAuth user.
-
#create_webhook(webhook_id, request) ⇒ FusionAuth::ClientResponse
Creates a webhook.
-
#deactivate_application(application_id) ⇒ FusionAuth::ClientResponse
Deactivates the application with the given Id.
-
#deactivate_reactor ⇒ FusionAuth::ClientResponse
Deactivates the FusionAuth Reactor.
-
#deactivate_user(user_id) ⇒ FusionAuth::ClientResponse
Deactivates the user with the given Id.
-
#deactivate_user_action(user_action_id) ⇒ FusionAuth::ClientResponse
Deactivates the user action with the given Id.
-
#deactivate_users(user_ids) ⇒ FusionAuth::ClientResponse
deprecated
Deprecated.
This method has been renamed to deactivate_users_by_ids, use that method instead.
-
#deactivate_users_by_ids(user_ids) ⇒ FusionAuth::ClientResponse
Deactivates the users with the given ids.
-
#delete_api_key(key_id) ⇒ FusionAuth::ClientResponse
Deletes the API key for the given Id.
-
#delete_application(application_id) ⇒ FusionAuth::ClientResponse
Hard deletes an application.
-
#delete_application_role(application_id, role_id) ⇒ FusionAuth::ClientResponse
Hard deletes an application role.
-
#delete_connector(connector_id) ⇒ FusionAuth::ClientResponse
Deletes the connector for the given Id.
-
#delete_consent(consent_id) ⇒ FusionAuth::ClientResponse
Deletes the consent for the given Id.
-
#delete_email_template(email_template_id) ⇒ FusionAuth::ClientResponse
Deletes the email template for the given Id.
-
#delete_entity(entity_id) ⇒ FusionAuth::ClientResponse
Deletes the Entity for the given Id.
-
#delete_entity_grant(entity_id, recipient_entity_id, user_id) ⇒ FusionAuth::ClientResponse
Deletes an Entity Grant for the given User or Entity.
-
#delete_entity_type(entity_type_id) ⇒ FusionAuth::ClientResponse
Deletes the Entity Type for the given Id.
-
#delete_entity_type_permission(entity_type_id, permission_id) ⇒ FusionAuth::ClientResponse
Hard deletes a permission.
-
#delete_form(form_id) ⇒ FusionAuth::ClientResponse
Deletes the form for the given Id.
-
#delete_form_field(field_id) ⇒ FusionAuth::ClientResponse
Deletes the form field for the given Id.
-
#delete_group(group_id) ⇒ FusionAuth::ClientResponse
Deletes the group for the given Id.
-
#delete_group_members(request) ⇒ FusionAuth::ClientResponse
Removes users as members of a group.
-
#delete_identity_provider(identity_provider_id) ⇒ FusionAuth::ClientResponse
Deletes the identity provider for the given Id.
-
#delete_ip_access_control_list(ip_access_control_list_id) ⇒ FusionAuth::ClientResponse
Deletes the IP Access Control List for the given Id.
-
#delete_key(key_id) ⇒ FusionAuth::ClientResponse
Deletes the key for the given Id.
-
#delete_lambda(lambda_id) ⇒ FusionAuth::ClientResponse
Deletes the lambda for the given Id.
-
#delete_message_template(message_template_id) ⇒ FusionAuth::ClientResponse
Deletes the message template for the given Id.
-
#delete_messenger(messenger_id) ⇒ FusionAuth::ClientResponse
Deletes the messenger for the given Id.
-
#delete_registration(user_id, application_id) ⇒ FusionAuth::ClientResponse
Deletes the user registration for the given user and application.
-
#delete_registration_with_request(user_id, application_id, request) ⇒ FusionAuth::ClientResponse
Deletes the user registration for the given user and application along with the given JSON body that contains the event information.
-
#delete_tenant(tenant_id) ⇒ FusionAuth::ClientResponse
Deletes the tenant based on the given Id on the URL.
-
#delete_tenant_async(tenant_id) ⇒ FusionAuth::ClientResponse
Deletes the tenant for the given Id asynchronously.
-
#delete_tenant_with_request(tenant_id, request) ⇒ FusionAuth::ClientResponse
Deletes the tenant based on the given request (sent to the API as JSON).
-
#delete_theme(theme_id) ⇒ FusionAuth::ClientResponse
Deletes the theme for the given Id.
-
#delete_user(user_id) ⇒ FusionAuth::ClientResponse
Deletes the user for the given Id.
-
#delete_user_action(user_action_id) ⇒ FusionAuth::ClientResponse
Deletes the user action for the given Id.
-
#delete_user_action_reason(user_action_reason_id) ⇒ FusionAuth::ClientResponse
Deletes the user action reason for the given Id.
-
#delete_user_link(identity_provider_id, identity_provider_user_id, user_id) ⇒ FusionAuth::ClientResponse
Remove an existing link that has been made from a 3rd party identity provider to a FusionAuth user.
-
#delete_user_with_request(user_id, request) ⇒ FusionAuth::ClientResponse
Deletes the user based on the given request (sent to the API as JSON).
-
#delete_users(request) ⇒ FusionAuth::ClientResponse
deprecated
Deprecated.
This method has been renamed to delete_users_by_query, use that method instead.
-
#delete_users_by_query(request) ⇒ FusionAuth::ClientResponse
Deletes the users with the given ids, or users matching the provided JSON query or queryString.
-
#delete_web_authn_credential(id) ⇒ FusionAuth::ClientResponse
Deletes the WebAuthn credential for the given Id.
-
#delete_webhook(webhook_id) ⇒ FusionAuth::ClientResponse
Deletes the webhook for the given Id.
-
#disable_two_factor(user_id, method_id, code) ⇒ FusionAuth::ClientResponse
Disable two-factor authentication for a user.
-
#disable_two_factor_with_request(user_id, request) ⇒ FusionAuth::ClientResponse
Disable two-factor authentication for a user using a JSON body rather than URL parameters.
-
#enable_two_factor(user_id, request) ⇒ FusionAuth::ClientResponse
Enable two-factor authentication for a user.
-
#exchange_o_auth_code_for_access_token(code, client_id, client_secret, redirect_uri) ⇒ FusionAuth::ClientResponse
Exchanges an OAuth authorization code for an access token.
-
#exchange_o_auth_code_for_access_token_using_pkce(code, client_id, client_secret, redirect_uri, code_verifier) ⇒ FusionAuth::ClientResponse
Exchanges an OAuth authorization code and code_verifier for an access token.
-
#exchange_refresh_token_for_access_token(refresh_token, client_id, client_secret, scope, user_code) ⇒ FusionAuth::ClientResponse
Exchange a Refresh Token for an Access Token.
-
#exchange_refresh_token_for_jwt(request) ⇒ FusionAuth::ClientResponse
Exchange a refresh token for a new JWT.
-
#exchange_user_credentials_for_access_token(username, password, client_id, client_secret, scope, user_code) ⇒ FusionAuth::ClientResponse
Exchange User Credentials for a Token.
-
#forgot_password(request) ⇒ FusionAuth::ClientResponse
Begins the forgot password sequence, which kicks off an email to the user so that they can reset their password.
-
#generate_email_verification_id(email) ⇒ FusionAuth::ClientResponse
Generate a new Email Verification Id to be used with the Verify Email API.
-
#generate_key(key_id, request) ⇒ FusionAuth::ClientResponse
Generate a new RSA or EC key pair or an HMAC secret.
-
#generate_registration_verification_id(email, application_id) ⇒ FusionAuth::ClientResponse
Generate a new Application Registration Verification Id to be used with the Verify Registration API.
-
#generate_two_factor_recovery_codes(user_id) ⇒ FusionAuth::ClientResponse
Generate two-factor recovery codes for a user.
-
#generate_two_factor_secret ⇒ FusionAuth::ClientResponse
Generate a Two Factor secret that can be used to enable Two Factor authentication for a User.
-
#generate_two_factor_secret_using_jwt(encoded_jwt) ⇒ FusionAuth::ClientResponse
Generate a Two Factor secret that can be used to enable Two Factor authentication for a User.
-
#identity_provider_login(request) ⇒ FusionAuth::ClientResponse
Handles login via third-parties including Social login, external OAuth and OpenID Connect, and other login systems.
-
#import_key(key_id, request) ⇒ FusionAuth::ClientResponse
Import an existing RSA or EC key pair or an HMAC secret.
-
#import_refresh_tokens(request) ⇒ FusionAuth::ClientResponse
Bulk imports refresh tokens.
-
#import_users(request) ⇒ FusionAuth::ClientResponse
Bulk imports users.
-
#import_web_authn_credential(request) ⇒ FusionAuth::ClientResponse
Import a WebAuthn credential.
-
#initialize(api_key, base_url) ⇒ FusionAuthClient
constructor
A new instance of FusionAuthClient.
-
#introspect_access_token(client_id, token) ⇒ FusionAuth::ClientResponse
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.
-
#introspect_client_credentials_access_token(token) ⇒ FusionAuth::ClientResponse
Inspect an access token issued as the result of the Client Credentials Grant.
-
#issue_jwt(application_id, encoded_jwt, refresh_token) ⇒ FusionAuth::ClientResponse
Issue a new access token (JWT) for the requested Application after ensuring the provided JWT is valid.
-
#login(request) ⇒ FusionAuth::ClientResponse
Authenticates a user to FusionAuth.
-
#login_ping(user_id, application_id, caller_ip_address) ⇒ FusionAuth::ClientResponse
Sends a ping to FusionAuth indicating that the user was automatically logged into an application.
-
#login_ping_with_request(request) ⇒ FusionAuth::ClientResponse
Sends a ping to FusionAuth indicating that the user was automatically logged into an application.
-
#logout(global, refresh_token) ⇒ FusionAuth::ClientResponse
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.
-
#logout_with_request(request) ⇒ FusionAuth::ClientResponse
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.
-
#lookup_identity_provider(domain) ⇒ FusionAuth::ClientResponse
Retrieves the identity provider for the given domain.
-
#modify_action(action_id, request) ⇒ FusionAuth::ClientResponse
Modifies a temporal user action by changing the expiration of the action and optionally adding a comment to the action.
-
#passwordless_login(request) ⇒ FusionAuth::ClientResponse
Complete a login request using a passwordless code.
-
#patch_api_key(key_id, request) ⇒ FusionAuth::ClientResponse
Updates an authentication API key by given id.
-
#patch_application(application_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the application with the given Id.
-
#patch_application_role(application_id, role_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the application role with the given Id for the application.
-
#patch_connector(connector_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the connector with the given Id.
-
#patch_consent(consent_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the consent with the given Id.
-
#patch_email_template(email_template_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the email template with the given Id.
-
#patch_entity_type(entity_type_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the Entity Type with the given Id.
-
#patch_group(group_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the group with the given Id.
-
#patch_identity_provider(identity_provider_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the identity provider with the given Id.
-
#patch_integrations(request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the available integrations.
-
#patch_lambda(lambda_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the lambda with the given Id.
-
#patch_message_template(message_template_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the message template with the given Id.
-
#patch_messenger(messenger_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the messenger with the given Id.
-
#patch_registration(user_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the registration for the user with the given Id and the application defined in the request.
-
#patch_system_configuration(request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the system configuration.
-
#patch_tenant(tenant_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the tenant with the given Id.
-
#patch_theme(theme_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the theme with the given Id.
-
#patch_user(user_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the user with the given Id.
-
#patch_user_action(user_action_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the user action with the given Id.
-
#patch_user_action_reason(user_action_reason_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the user action reason with the given Id.
-
#patch_user_consent(user_consent_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, a single User consent by Id.
-
#reactivate_application(application_id) ⇒ FusionAuth::ClientResponse
Reactivates the application with the given Id.
-
#reactivate_user(user_id) ⇒ FusionAuth::ClientResponse
Reactivates the user with the given Id.
-
#reactivate_user_action(user_action_id) ⇒ FusionAuth::ClientResponse
Reactivates the user action with the given Id.
-
#reconcile_jwt(request) ⇒ FusionAuth::ClientResponse
Reconcile a User to FusionAuth using JWT issued from another Identity Provider.
-
#refresh_entity_search_index ⇒ FusionAuth::ClientResponse
Request a refresh of the Entity search index.
-
#refresh_user_search_index ⇒ FusionAuth::ClientResponse
Request a refresh of the User search index.
-
#regenerate_reactor_keys ⇒ FusionAuth::ClientResponse
Regenerates any keys that are used by the FusionAuth Reactor.
-
#register(user_id, request) ⇒ FusionAuth::ClientResponse
Registers a user for an application.
-
#reindex(request) ⇒ FusionAuth::ClientResponse
Requests Elasticsearch to delete and rebuild the index for FusionAuth users or entities.
-
#remove_user_from_family(family_id, user_id) ⇒ FusionAuth::ClientResponse
Removes a user from the family with the given id.
-
#resend_email_verification(email) ⇒ FusionAuth::ClientResponse
Re-sends the verification email to the user.
-
#resend_email_verification_with_application_template(application_id, email) ⇒ FusionAuth::ClientResponse
Re-sends the verification email to the user.
-
#resend_registration_verification(email, application_id) ⇒ FusionAuth::ClientResponse
Re-sends the application registration verification email to the user.
-
#retrieve_action(action_id) ⇒ FusionAuth::ClientResponse
Retrieves a single action log (the log of a user action that was taken on a user previously) for the given Id.
-
#retrieve_actions(user_id) ⇒ FusionAuth::ClientResponse
Retrieves all the actions for the user with the given Id.
-
#retrieve_actions_preventing_login(user_id) ⇒ FusionAuth::ClientResponse
Retrieves all the actions for the user with the given Id that are currently preventing the User from logging in.
-
#retrieve_active_actions(user_id) ⇒ FusionAuth::ClientResponse
Retrieves all the actions for the user with the given Id that are currently active.
-
#retrieve_api_key(key_id) ⇒ FusionAuth::ClientResponse
Retrieves an authentication API key for the given id.
-
#retrieve_application(application_id) ⇒ FusionAuth::ClientResponse
Retrieves the application for the given Id or all the applications if the Id is null.
-
#retrieve_applications ⇒ FusionAuth::ClientResponse
Retrieves all the applications.
-
#retrieve_audit_log(audit_log_id) ⇒ FusionAuth::ClientResponse
Retrieves a single audit log for the given Id.
-
#retrieve_connector(connector_id) ⇒ FusionAuth::ClientResponse
Retrieves the connector with the given Id.
-
#retrieve_connectors ⇒ FusionAuth::ClientResponse
Retrieves all the connectors.
-
#retrieve_consent(consent_id) ⇒ FusionAuth::ClientResponse
Retrieves the Consent for the given Id.
-
#retrieve_consents ⇒ FusionAuth::ClientResponse
Retrieves all the consent.
-
#retrieve_daily_active_report(application_id, start, _end) ⇒ FusionAuth::ClientResponse
Retrieves the daily active user report between the two instants.
-
#retrieve_email_template(email_template_id) ⇒ FusionAuth::ClientResponse
Retrieves the email template for the given Id.
-
#retrieve_email_template_preview(request) ⇒ FusionAuth::ClientResponse
Creates a preview of the email template provided in the request.
-
#retrieve_email_templates ⇒ FusionAuth::ClientResponse
Retrieves all the email templates.
-
#retrieve_entity(entity_id) ⇒ FusionAuth::ClientResponse
Retrieves the Entity for the given Id.
-
#retrieve_entity_grant(entity_id, recipient_entity_id, user_id) ⇒ FusionAuth::ClientResponse
Retrieves an Entity Grant for the given Entity and User/Entity.
-
#retrieve_entity_type(entity_type_id) ⇒ FusionAuth::ClientResponse
Retrieves the Entity Type for the given Id.
-
#retrieve_entity_types ⇒ FusionAuth::ClientResponse
Retrieves all the Entity Types.
-
#retrieve_event_log(event_log_id) ⇒ FusionAuth::ClientResponse
Retrieves a single event log for the given Id.
-
#retrieve_families(user_id) ⇒ FusionAuth::ClientResponse
Retrieves all the families that a user belongs to.
-
#retrieve_family_members_by_family_id(family_id) ⇒ FusionAuth::ClientResponse
Retrieves all the members of a family by the unique Family Id.
-
#retrieve_form(form_id) ⇒ FusionAuth::ClientResponse
Retrieves the form with the given Id.
-
#retrieve_form_field(field_id) ⇒ FusionAuth::ClientResponse
Retrieves the form field with the given Id.
-
#retrieve_form_fields ⇒ FusionAuth::ClientResponse
Retrieves all the forms fields.
-
#retrieve_forms ⇒ FusionAuth::ClientResponse
Retrieves all the forms.
-
#retrieve_group(group_id) ⇒ FusionAuth::ClientResponse
Retrieves the group for the given Id.
-
#retrieve_groups ⇒ FusionAuth::ClientResponse
Retrieves all the groups.
-
#retrieve_identity_provider(identity_provider_id) ⇒ FusionAuth::ClientResponse
Retrieves the identity provider for the given Id or all the identity providers if the Id is null.
-
#retrieve_identity_provider_by_type(type) ⇒ FusionAuth::ClientResponse
Retrieves one or more identity provider for the given type.
-
#retrieve_identity_providers ⇒ FusionAuth::ClientResponse
Retrieves all the identity providers.
-
#retrieve_inactive_actions(user_id) ⇒ FusionAuth::ClientResponse
Retrieves all the actions for the user with the given Id that are currently inactive.
-
#retrieve_inactive_applications ⇒ FusionAuth::ClientResponse
Retrieves all the applications that are currently inactive.
-
#retrieve_inactive_user_actions ⇒ FusionAuth::ClientResponse
Retrieves all the user actions that are currently inactive.
-
#retrieve_integration ⇒ FusionAuth::ClientResponse
Retrieves the available integrations.
-
#retrieve_ip_access_control_list(ip_access_control_list_id) ⇒ FusionAuth::ClientResponse
Retrieves the IP Access Control List with the given Id.
-
#retrieve_json_web_key_set ⇒ FusionAuth::ClientResponse
Returns public keys used by FusionAuth to cryptographically verify JWTs using the JSON Web Key format.
-
#retrieve_jwt_public_key(key_id) ⇒ FusionAuth::ClientResponse
Retrieves the Public Key configured for verifying JSON Web Tokens (JWT) by the key Id (kid).
-
#retrieve_jwt_public_key_by_application_id(application_id) ⇒ FusionAuth::ClientResponse
Retrieves the Public Key configured for verifying the JSON Web Tokens (JWT) issued by the Login API by the Application Id.
-
#retrieve_jwt_public_keys ⇒ FusionAuth::ClientResponse
Retrieves all Public Keys configured for verifying JSON Web Tokens (JWT).
-
#retrieve_key(key_id) ⇒ FusionAuth::ClientResponse
Retrieves the key for the given Id.
-
#retrieve_keys ⇒ FusionAuth::ClientResponse
Retrieves all the keys.
-
#retrieve_lambda(lambda_id) ⇒ FusionAuth::ClientResponse
Retrieves the lambda for the given Id.
-
#retrieve_lambdas ⇒ FusionAuth::ClientResponse
Retrieves all the lambdas.
-
#retrieve_lambdas_by_type(type) ⇒ FusionAuth::ClientResponse
Retrieves all the lambdas for the provided type.
-
#retrieve_login_report(application_id, start, _end) ⇒ FusionAuth::ClientResponse
Retrieves the login report between the two instants.
-
#retrieve_message_template(message_template_id) ⇒ FusionAuth::ClientResponse
Retrieves the message template for the given Id.
-
#retrieve_message_template_preview(request) ⇒ FusionAuth::ClientResponse
Creates a preview of the message template provided in the request, normalized to a given locale.
-
#retrieve_message_templates ⇒ FusionAuth::ClientResponse
Retrieves all the message templates.
-
#retrieve_messenger(messenger_id) ⇒ FusionAuth::ClientResponse
Retrieves the messenger with the given Id.
-
#retrieve_messengers ⇒ FusionAuth::ClientResponse
Retrieves all the messengers.
-
#retrieve_monthly_active_report(application_id, start, _end) ⇒ FusionAuth::ClientResponse
Retrieves the monthly active user report between the two instants.
-
#retrieve_oauth_configuration(application_id) ⇒ FusionAuth::ClientResponse
Retrieves the Oauth2 configuration for the application for the given Application Id.
-
#retrieve_open_id_configuration ⇒ FusionAuth::ClientResponse
Returns the well known OpenID Configuration JSON document.
-
#retrieve_password_validation_rules ⇒ FusionAuth::ClientResponse
Retrieves the password validation rules for a specific tenant.
-
#retrieve_password_validation_rules_with_tenant_id(tenant_id) ⇒ FusionAuth::ClientResponse
Retrieves the password validation rules for a specific tenant.
-
#retrieve_pending_children(parent_email) ⇒ FusionAuth::ClientResponse
Retrieves all the children for the given parent email address.
-
#retrieve_pending_link(pending_link_id, user_id) ⇒ FusionAuth::ClientResponse
Retrieve a pending identity provider link.
-
#retrieve_reactor_metrics ⇒ FusionAuth::ClientResponse
Retrieves the FusionAuth Reactor metrics.
-
#retrieve_reactor_status ⇒ FusionAuth::ClientResponse
Retrieves the FusionAuth Reactor status.
-
#retrieve_recent_logins(offset, limit) ⇒ FusionAuth::ClientResponse
Retrieves the last number of login records.
-
#retrieve_refresh_token_by_id(token_id) ⇒ FusionAuth::ClientResponse
Retrieves a single refresh token by unique Id.
-
#retrieve_refresh_tokens(user_id) ⇒ FusionAuth::ClientResponse
Retrieves the refresh tokens that belong to the user with the given Id.
-
#retrieve_registration(user_id, application_id) ⇒ FusionAuth::ClientResponse
Retrieves the user registration for the user with the given Id and the given application id.
-
#retrieve_registration_report(application_id, start, _end) ⇒ FusionAuth::ClientResponse
Retrieves the registration report between the two instants.
-
#retrieve_reindex_status ⇒ FusionAuth::ClientResponse
Retrieve the status of a re-index process.
-
#retrieve_system_configuration ⇒ FusionAuth::ClientResponse
Retrieves the system configuration.
-
#retrieve_tenant(tenant_id) ⇒ FusionAuth::ClientResponse
Retrieves the tenant for the given Id.
-
#retrieve_tenants ⇒ FusionAuth::ClientResponse
Retrieves all the tenants.
-
#retrieve_theme(theme_id) ⇒ FusionAuth::ClientResponse
Retrieves the theme for the given Id.
-
#retrieve_themes ⇒ FusionAuth::ClientResponse
Retrieves all the themes.
-
#retrieve_total_report ⇒ FusionAuth::ClientResponse
Retrieves the totals report.
-
#retrieve_two_factor_recovery_codes(user_id) ⇒ FusionAuth::ClientResponse
Retrieve two-factor recovery codes for a user.
-
#retrieve_two_factor_status(user_id, application_id, two_factor_trust_id) ⇒ FusionAuth::ClientResponse
Retrieve a user’s two-factor status.
-
#retrieve_user(user_id) ⇒ FusionAuth::ClientResponse
Retrieves the user for the given Id.
-
#retrieve_user_action(user_action_id) ⇒ FusionAuth::ClientResponse
Retrieves the user action for the given Id.
-
#retrieve_user_action_reason(user_action_reason_id) ⇒ FusionAuth::ClientResponse
Retrieves the user action reason for the given Id.
-
#retrieve_user_action_reasons ⇒ FusionAuth::ClientResponse
Retrieves all the user action reasons.
-
#retrieve_user_actions ⇒ FusionAuth::ClientResponse
Retrieves all the user actions.
-
#retrieve_user_by_change_password_id(change_password_id) ⇒ FusionAuth::ClientResponse
Retrieves the user by a change password Id.
-
#retrieve_user_by_email(email) ⇒ FusionAuth::ClientResponse
Retrieves the user for the given email.
-
#retrieve_user_by_login_id(login_id) ⇒ FusionAuth::ClientResponse
Retrieves the user for the loginId.
-
#retrieve_user_by_username(username) ⇒ FusionAuth::ClientResponse
Retrieves the user for the given username.
-
#retrieve_user_by_verification_id(verification_id) ⇒ FusionAuth::ClientResponse
Retrieves the user by a verificationId.
-
#retrieve_user_code(client_id, client_secret, user_code) ⇒ FusionAuth::ClientResponse
Retrieve a user_code that is part of an in-progress Device Authorization Grant.
-
#retrieve_user_code_using_api_key(user_code) ⇒ FusionAuth::ClientResponse
Retrieve a user_code that is part of an in-progress Device Authorization Grant.
-
#retrieve_user_comments(user_id) ⇒ FusionAuth::ClientResponse
Retrieves all the comments for the user with the given Id.
-
#retrieve_user_consent(user_consent_id) ⇒ FusionAuth::ClientResponse
Retrieve a single User consent by Id.
-
#retrieve_user_consents(user_id) ⇒ FusionAuth::ClientResponse
Retrieves all the consents for a User.
-
#retrieve_user_info_from_access_token(encoded_jwt) ⇒ FusionAuth::ClientResponse
Call the UserInfo endpoint to retrieve User Claims from the access token issued by FusionAuth.
-
#retrieve_user_link(identity_provider_id, identity_provider_user_id, user_id) ⇒ FusionAuth::ClientResponse
Retrieve a single Identity Provider user (link).
-
#retrieve_user_links_by_user_id(identity_provider_id, user_id) ⇒ FusionAuth::ClientResponse
Retrieve all Identity Provider users (links) for the user.
-
#retrieve_user_login_report(application_id, user_id, start, _end) ⇒ FusionAuth::ClientResponse
Retrieves the login report between the two instants for a particular user by Id.
-
#retrieve_user_login_report_by_login_id(application_id, login_id, start, _end) ⇒ FusionAuth::ClientResponse
Retrieves the login report between the two instants for a particular user by login Id.
-
#retrieve_user_recent_logins(user_id, offset, limit) ⇒ FusionAuth::ClientResponse
Retrieves the last number of login records for a user.
-
#retrieve_user_using_jwt(encoded_jwt) ⇒ FusionAuth::ClientResponse
Retrieves the user for the given Id.
-
#retrieve_version ⇒ FusionAuth::ClientResponse
Retrieves the FusionAuth version string.
-
#retrieve_web_authn_credential(id) ⇒ FusionAuth::ClientResponse
Retrieves the WebAuthn credential for the given Id.
-
#retrieve_web_authn_credentials_for_user(user_id) ⇒ FusionAuth::ClientResponse
Retrieves all WebAuthn credentials for the given user.
-
#retrieve_webhook(webhook_id) ⇒ FusionAuth::ClientResponse
Retrieves the webhook for the given Id.
-
#retrieve_webhooks ⇒ FusionAuth::ClientResponse
Retrieves all the webhooks.
-
#revoke_refresh_token(token, user_id, application_id) ⇒ FusionAuth::ClientResponse
Revokes refresh tokens.
-
#revoke_refresh_token_by_id(token_id) ⇒ FusionAuth::ClientResponse
Revokes a single refresh token by the unique Id.
-
#revoke_refresh_token_by_token(token) ⇒ FusionAuth::ClientResponse
Revokes a single refresh token by using the actual refresh token value.
-
#revoke_refresh_tokens_by_application_id(application_id) ⇒ FusionAuth::ClientResponse
Revoke all refresh tokens that belong to an application by applicationId.
-
#revoke_refresh_tokens_by_user_id(user_id) ⇒ FusionAuth::ClientResponse
Revoke all refresh tokens that belong to a user by user Id.
-
#revoke_refresh_tokens_by_user_id_for_application(user_id, application_id) ⇒ FusionAuth::ClientResponse
Revoke all refresh tokens that belong to a user by user Id for a specific application by applicationId.
-
#revoke_refresh_tokens_with_request(request) ⇒ FusionAuth::ClientResponse
Revokes refresh tokens using the information in the JSON body.
-
#revoke_user_consent(user_consent_id) ⇒ FusionAuth::ClientResponse
Revokes a single User consent by Id.
-
#search_applications(request) ⇒ FusionAuth::ClientResponse
Searches applications with the specified criteria and pagination.
-
#search_audit_logs(request) ⇒ FusionAuth::ClientResponse
Searches the audit logs with the specified criteria and pagination.
-
#search_consents(request) ⇒ FusionAuth::ClientResponse
Searches consents with the specified criteria and pagination.
-
#search_email_templates(request) ⇒ FusionAuth::ClientResponse
Searches email templates with the specified criteria and pagination.
-
#search_entities(request) ⇒ FusionAuth::ClientResponse
Searches entities with the specified criteria and pagination.
-
#search_entities_by_ids(ids) ⇒ FusionAuth::ClientResponse
Retrieves the entities for the given ids.
-
#search_entity_grants(request) ⇒ FusionAuth::ClientResponse
Searches Entity Grants with the specified criteria and pagination.
-
#search_entity_types(request) ⇒ FusionAuth::ClientResponse
Searches the entity types with the specified criteria and pagination.
-
#search_event_logs(request) ⇒ FusionAuth::ClientResponse
Searches the event logs with the specified criteria and pagination.
-
#search_group_members(request) ⇒ FusionAuth::ClientResponse
Searches group members with the specified criteria and pagination.
-
#search_groups(request) ⇒ FusionAuth::ClientResponse
Searches groups with the specified criteria and pagination.
-
#search_identity_providers(request) ⇒ FusionAuth::ClientResponse
Searches identity providers with the specified criteria and pagination.
-
#search_ip_access_control_lists(request) ⇒ FusionAuth::ClientResponse
Searches the IP Access Control Lists with the specified criteria and pagination.
-
#search_keys(request) ⇒ FusionAuth::ClientResponse
Searches keys with the specified criteria and pagination.
-
#search_lambdas(request) ⇒ FusionAuth::ClientResponse
Searches lambdas with the specified criteria and pagination.
-
#search_login_records(request) ⇒ FusionAuth::ClientResponse
Searches the login records with the specified criteria and pagination.
-
#search_tenants(request) ⇒ FusionAuth::ClientResponse
Searches tenants with the specified criteria and pagination.
-
#search_themes(request) ⇒ FusionAuth::ClientResponse
Searches themes with the specified criteria and pagination.
-
#search_user_comments(request) ⇒ FusionAuth::ClientResponse
Searches user comments with the specified criteria and pagination.
-
#search_users(ids) ⇒ FusionAuth::ClientResponse
deprecated
Deprecated.
This method has been renamed to search_users_by_ids, use that method instead.
-
#search_users_by_ids(ids) ⇒ FusionAuth::ClientResponse
Retrieves the users for the given ids.
-
#search_users_by_query(request) ⇒ FusionAuth::ClientResponse
Retrieves the users for the given search criteria and pagination.
-
#search_users_by_query_string(request) ⇒ FusionAuth::ClientResponse
deprecated
Deprecated.
This method has been renamed to search_users_by_query, use that method instead.
-
#search_webhooks(request) ⇒ FusionAuth::ClientResponse
Searches webhooks with the specified criteria and pagination.
-
#send_email(email_template_id, request) ⇒ FusionAuth::ClientResponse
Send an email using an email template id.
-
#send_family_request_email(request) ⇒ FusionAuth::ClientResponse
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(request) ⇒ FusionAuth::ClientResponse
Send a passwordless authentication code in an email to complete login.
-
#send_two_factor_code(request) ⇒ FusionAuth::ClientResponse
deprecated
Deprecated.
This method has been renamed to send_two_factor_code_for_enable_disable, use that method instead.
-
#send_two_factor_code_for_enable_disable(request) ⇒ FusionAuth::ClientResponse
Send a Two Factor authentication code to assist in setting up Two Factor authentication or disabling.
-
#send_two_factor_code_for_login(two_factor_id) ⇒ FusionAuth::ClientResponse
deprecated
Deprecated.
This method has been renamed to send_two_factor_code_for_login_using_method, use that method instead.
-
#send_two_factor_code_for_login_using_method(two_factor_id, request) ⇒ FusionAuth::ClientResponse
Send a Two Factor authentication code to allow the completion of Two Factor authentication.
- #set_tenant_id(tenant_id) ⇒ Object
-
#start_identity_provider_login(request) ⇒ FusionAuth::ClientResponse
Begins a login request for a 3rd party login that requires user interaction such as HYPR.
-
#start_passwordless_login(request) ⇒ FusionAuth::ClientResponse
Start a passwordless login request by generating a passwordless code.
-
#start_two_factor_login(request) ⇒ FusionAuth::ClientResponse
Start a Two-Factor login request by generating a two-factor identifier.
-
#start_web_authn_login(request) ⇒ FusionAuth::ClientResponse
Start a WebAuthn authentication ceremony by generating a new challenge for the user.
-
#start_web_authn_registration(request) ⇒ FusionAuth::ClientResponse
Start a WebAuthn registration ceremony by generating a new challenge for the user.
-
#two_factor_login(request) ⇒ FusionAuth::ClientResponse
Complete login using a 2FA challenge.
-
#update_api_key(api_key_id, request) ⇒ FusionAuth::ClientResponse
Updates an API key by given id.
-
#update_application(application_id, request) ⇒ FusionAuth::ClientResponse
Updates the application with the given Id.
-
#update_application_role(application_id, role_id, request) ⇒ FusionAuth::ClientResponse
Updates the application role with the given Id for the application.
-
#update_connector(connector_id, request) ⇒ FusionAuth::ClientResponse
Updates the connector with the given Id.
-
#update_consent(consent_id, request) ⇒ FusionAuth::ClientResponse
Updates the consent with the given Id.
-
#update_email_template(email_template_id, request) ⇒ FusionAuth::ClientResponse
Updates the email template with the given Id.
-
#update_entity(entity_id, request) ⇒ FusionAuth::ClientResponse
Updates the Entity with the given Id.
-
#update_entity_type(entity_type_id, request) ⇒ FusionAuth::ClientResponse
Updates the Entity Type with the given Id.
-
#update_entity_type_permission(entity_type_id, permission_id, request) ⇒ FusionAuth::ClientResponse
Updates the permission with the given Id for the entity type.
-
#update_form(form_id, request) ⇒ FusionAuth::ClientResponse
Updates the form with the given Id.
-
#update_form_field(field_id, request) ⇒ FusionAuth::ClientResponse
Updates the form field with the given Id.
-
#update_group(group_id, request) ⇒ FusionAuth::ClientResponse
Updates the group with the given Id.
-
#update_group_members(request) ⇒ FusionAuth::ClientResponse
Creates a member in a group.
-
#update_identity_provider(identity_provider_id, request) ⇒ FusionAuth::ClientResponse
Updates the identity provider with the given Id.
-
#update_integrations(request) ⇒ FusionAuth::ClientResponse
Updates the available integrations.
-
#update_ip_access_control_list(access_control_list_id, request) ⇒ FusionAuth::ClientResponse
Updates the IP Access Control List with the given Id.
-
#update_key(key_id, request) ⇒ FusionAuth::ClientResponse
Updates the key with the given Id.
-
#update_lambda(lambda_id, request) ⇒ FusionAuth::ClientResponse
Updates the lambda with the given Id.
-
#update_message_template(message_template_id, request) ⇒ FusionAuth::ClientResponse
Updates the message template with the given Id.
-
#update_messenger(messenger_id, request) ⇒ FusionAuth::ClientResponse
Updates the messenger with the given Id.
-
#update_registration(user_id, request) ⇒ FusionAuth::ClientResponse
Updates the registration for the user with the given Id and the application defined in the request.
-
#update_system_configuration(request) ⇒ FusionAuth::ClientResponse
Updates the system configuration.
-
#update_tenant(tenant_id, request) ⇒ FusionAuth::ClientResponse
Updates the tenant with the given Id.
-
#update_theme(theme_id, request) ⇒ FusionAuth::ClientResponse
Updates the theme with the given Id.
-
#update_user(user_id, request) ⇒ FusionAuth::ClientResponse
Updates the user with the given Id.
-
#update_user_action(user_action_id, request) ⇒ FusionAuth::ClientResponse
Updates the user action with the given Id.
-
#update_user_action_reason(user_action_reason_id, request) ⇒ FusionAuth::ClientResponse
Updates the user action reason with the given Id.
-
#update_user_consent(user_consent_id, request) ⇒ FusionAuth::ClientResponse
Updates a single User consent by Id.
-
#update_webhook(webhook_id, request) ⇒ FusionAuth::ClientResponse
Updates the webhook with the given Id.
-
#upsert_entity_grant(entity_id, request) ⇒ FusionAuth::ClientResponse
Creates or updates an Entity Grant.
-
#validate_device(user_code, client_id) ⇒ FusionAuth::ClientResponse
Validates the end-user provided user_code from the user-interaction of the Device Authorization Grant.
-
#validate_jwt(encoded_jwt) ⇒ FusionAuth::ClientResponse
Validates the provided JWT (encoded JWT string) to ensure the token is valid.
-
#vend_jwt(request) ⇒ FusionAuth::ClientResponse
It’s a JWT vending machine!.
-
#verify_email(verification_id) ⇒ FusionAuth::ClientResponse
deprecated
Deprecated.
This method has been renamed to verify_email_address and changed to take a JSON request body, use that method instead.
-
#verify_email_address(request) ⇒ FusionAuth::ClientResponse
Confirms a user’s email address.
-
#verify_email_address_by_user_id(request) ⇒ FusionAuth::ClientResponse
Administratively verify a user’s email address.
-
#verify_registration(verification_id) ⇒ FusionAuth::ClientResponse
deprecated
Deprecated.
This method has been renamed to verify_user_registration and changed to take a JSON request body, use that method instead.
-
#verify_user_registration(request) ⇒ FusionAuth::ClientResponse
Confirms a user’s registration.
Constructor Details
#initialize(api_key, base_url) ⇒ FusionAuthClient
Returns a new instance of FusionAuthClient.
32 33 34 35 36 37 38 |
# File 'lib/fusionauth/fusionauth_client.rb', line 32 def initialize(api_key, base_url) @api_key = api_key @base_url = base_url @connect_timeout = 1000 @read_timeout = 2000 @tenant_id = nil end |
Instance Attribute Details
#api_key ⇒ Object
Returns the value of attribute api_key.
30 31 32 |
# File 'lib/fusionauth/fusionauth_client.rb', line 30 def api_key @api_key end |
#base_url ⇒ Object
Returns the value of attribute base_url.
30 31 32 |
# File 'lib/fusionauth/fusionauth_client.rb', line 30 def base_url @base_url end |
#connect_timeout ⇒ Object
Returns the value of attribute connect_timeout.
30 31 32 |
# File 'lib/fusionauth/fusionauth_client.rb', line 30 def connect_timeout @connect_timeout end |
#read_timeout ⇒ Object
Returns the value of attribute read_timeout.
30 31 32 |
# File 'lib/fusionauth/fusionauth_client.rb', line 30 def read_timeout @read_timeout end |
#tenant_id ⇒ Object
Returns the value of attribute tenant_id.
30 31 32 |
# File 'lib/fusionauth/fusionauth_client.rb', line 30 def tenant_id @tenant_id end |
Instance Method Details
#action_user(request) ⇒ FusionAuth::ClientResponse
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.
51 52 53 54 55 56 |
# File 'lib/fusionauth/fusionauth_client.rb', line 51 def action_user(request) start.uri('/api/user/action') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#activate_reactor(request) ⇒ FusionAuth::ClientResponse
Activates the FusionAuth Reactor using a license Id and optionally a license text (for air-gapped deployments)
63 64 65 66 67 68 |
# File 'lib/fusionauth/fusionauth_client.rb', line 63 def activate_reactor(request) start.uri('/api/reactor') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#add_user_to_family(family_id, request) ⇒ FusionAuth::ClientResponse
Adds a user to an existing family. The family Id must be specified.
76 77 78 79 80 81 82 |
# File 'lib/fusionauth/fusionauth_client.rb', line 76 def add_user_to_family(family_id, request) start.uri('/api/user/family') .url_segment(family_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .put() .go() end |
#approve_device(client_id, client_secret, token, user_code) ⇒ FusionAuth::ClientResponse
Approve a device grant.
92 93 94 95 96 97 98 99 100 101 102 103 |
# File 'lib/fusionauth/fusionauth_client.rb', line 92 def approve_device(client_id, client_secret, token, user_code) body = { "client_id" => client_id, "client_secret" => client_secret, "token" => token, "user_code" => user_code } start.uri('/oauth2/device/approve') .body_handler(FusionAuth::FormDataBodyHandler.new(body)) .post() .go() end |
#cancel_action(action_id, request) ⇒ FusionAuth::ClientResponse
Cancels the user action.
111 112 113 114 115 116 117 |
# File 'lib/fusionauth/fusionauth_client.rb', line 111 def cancel_action(action_id, request) start.uri('/api/user/action') .url_segment(action_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .delete() .go() end |
#change_password(change_password_id, request) ⇒ FusionAuth::ClientResponse
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.
129 130 131 132 133 134 135 |
# File 'lib/fusionauth/fusionauth_client.rb', line 129 def change_password(change_password_id, request) startAnonymous.uri('/api/user/change-password') .url_segment(change_password_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#change_password_by_identity(request) ⇒ FusionAuth::ClientResponse
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.
144 145 146 147 148 149 |
# File 'lib/fusionauth/fusionauth_client.rb', line 144 def change_password_by_identity(request) start.uri('/api/user/change-password') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#check_change_password_using_id(change_password_id) ⇒ FusionAuth::ClientResponse
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.
160 161 162 163 164 165 |
# File 'lib/fusionauth/fusionauth_client.rb', line 160 def check_change_password_using_id(change_password_id) startAnonymous.uri('/api/user/change-password') .url_segment(change_password_id) .get() .go() end |
#check_change_password_using_jwt(encoded_jwt) ⇒ FusionAuth::ClientResponse
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.
176 177 178 179 180 181 |
# File 'lib/fusionauth/fusionauth_client.rb', line 176 def check_change_password_using_jwt(encoded_jwt) startAnonymous.uri('/api/user/change-password') .('Bearer ' + encoded_jwt) .get() .go() end |
#check_change_password_using_login_id(login_id) ⇒ FusionAuth::ClientResponse
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.
192 193 194 195 196 197 |
# File 'lib/fusionauth/fusionauth_client.rb', line 192 def check_change_password_using_login_id(login_id) start.uri('/api/user/change-password') .url_parameter('username', login_id) .get() .go() end |
#client_credentials_grant(client_id, client_secret, scope) ⇒ FusionAuth::ClientResponse
Make a Client Credentials grant request to obtain an access token.
208 209 210 211 212 213 214 215 216 217 218 219 |
# File 'lib/fusionauth/fusionauth_client.rb', line 208 def client_credentials_grant(client_id, client_secret, scope) body = { "client_id" => client_id, "client_secret" => client_secret, "grant_type" => "client_credentials", "scope" => scope } startAnonymous.uri('/oauth2/token') .body_handler(FusionAuth::FormDataBodyHandler.new(body)) .post() .go() end |
#comment_on_user(request) ⇒ FusionAuth::ClientResponse
Adds a comment to the user’s account.
226 227 228 229 230 231 |
# File 'lib/fusionauth/fusionauth_client.rb', line 226 def comment_on_user(request) start.uri('/api/user/comment') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#complete_web_authn_assertion(request) ⇒ FusionAuth::ClientResponse
Complete a WebAuthn authentication ceremony by validating the signature against the previously generated challenge without logging the user in
238 239 240 241 242 243 |
# File 'lib/fusionauth/fusionauth_client.rb', line 238 def complete_web_authn_assertion(request) startAnonymous.uri('/api/webauthn/assert') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#complete_web_authn_login(request) ⇒ FusionAuth::ClientResponse
Complete a WebAuthn authentication ceremony by validating the signature against the previously generated challenge and then login the user in
250 251 252 253 254 255 |
# File 'lib/fusionauth/fusionauth_client.rb', line 250 def complete_web_authn_login(request) startAnonymous.uri('/api/webauthn/login') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#complete_web_authn_registration(request) ⇒ FusionAuth::ClientResponse
Complete a WebAuthn registration ceremony by validating the client request and saving the new credential
262 263 264 265 266 267 |
# File 'lib/fusionauth/fusionauth_client.rb', line 262 def complete_web_authn_registration(request) start.uri('/api/webauthn/register/complete') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#create_api_key(key_id, request) ⇒ FusionAuth::ClientResponse
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.
279 280 281 282 283 284 285 |
# File 'lib/fusionauth/fusionauth_client.rb', line 279 def create_api_key(key_id, request) start.uri('/api/api-key') .url_segment(key_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#create_application(application_id, request) ⇒ FusionAuth::ClientResponse
Creates an application. You can optionally specify an Id for the application, if not provided one will be generated.
293 294 295 296 297 298 299 |
# File 'lib/fusionauth/fusionauth_client.rb', line 293 def create_application(application_id, request) start.uri('/api/application') .url_segment(application_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#create_application_role(application_id, role_id, request) ⇒ FusionAuth::ClientResponse
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.
309 310 311 312 313 314 315 316 317 |
# File 'lib/fusionauth/fusionauth_client.rb', line 309 def create_application_role(application_id, role_id, request) start.uri('/api/application') .url_segment(application_id) .url_segment("role") .url_segment(role_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#create_audit_log(request) ⇒ FusionAuth::ClientResponse
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.
326 327 328 329 330 331 |
# File 'lib/fusionauth/fusionauth_client.rb', line 326 def create_audit_log(request) start.uri('/api/system/audit-log') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#create_connector(connector_id, request) ⇒ FusionAuth::ClientResponse
Creates a connector. You can optionally specify an Id for the connector, if not provided one will be generated.
339 340 341 342 343 344 345 |
# File 'lib/fusionauth/fusionauth_client.rb', line 339 def create_connector(connector_id, request) start.uri('/api/connector') .url_segment(connector_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#create_consent(consent_id, request) ⇒ FusionAuth::ClientResponse
Creates a user consent type. You can optionally specify an Id for the consent type, if not provided one will be generated.
353 354 355 356 357 358 359 |
# File 'lib/fusionauth/fusionauth_client.rb', line 353 def (, request) start.uri('/api/consent') .url_segment() .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#create_email_template(email_template_id, request) ⇒ FusionAuth::ClientResponse
Creates an email template. You can optionally specify an Id for the template, if not provided one will be generated.
367 368 369 370 371 372 373 |
# File 'lib/fusionauth/fusionauth_client.rb', line 367 def create_email_template(email_template_id, request) start.uri('/api/email/template') .url_segment(email_template_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#create_entity(entity_id, request) ⇒ FusionAuth::ClientResponse
Creates an Entity. You can optionally specify an Id for the Entity. If not provided one will be generated.
381 382 383 384 385 386 387 |
# File 'lib/fusionauth/fusionauth_client.rb', line 381 def create_entity(entity_id, request) start.uri('/api/entity') .url_segment(entity_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#create_entity_type(entity_type_id, request) ⇒ FusionAuth::ClientResponse
Creates a Entity Type. You can optionally specify an Id for the Entity Type, if not provided one will be generated.
395 396 397 398 399 400 401 |
# File 'lib/fusionauth/fusionauth_client.rb', line 395 def create_entity_type(entity_type_id, request) start.uri('/api/entity/type') .url_segment(entity_type_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#create_entity_type_permission(entity_type_id, permission_id, request) ⇒ FusionAuth::ClientResponse
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.
411 412 413 414 415 416 417 418 419 |
# File 'lib/fusionauth/fusionauth_client.rb', line 411 def (entity_type_id, , request) start.uri('/api/entity/type') .url_segment(entity_type_id) .url_segment("permission") .url_segment() .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#create_family(family_id, request) ⇒ FusionAuth::ClientResponse
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.
428 429 430 431 432 433 434 |
# File 'lib/fusionauth/fusionauth_client.rb', line 428 def create_family(family_id, request) start.uri('/api/user/family') .url_segment(family_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#create_form(form_id, request) ⇒ FusionAuth::ClientResponse
Creates a form. You can optionally specify an Id for the form, if not provided one will be generated.
442 443 444 445 446 447 448 |
# File 'lib/fusionauth/fusionauth_client.rb', line 442 def create_form(form_id, request) start.uri('/api/form') .url_segment(form_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#create_form_field(field_id, request) ⇒ FusionAuth::ClientResponse
Creates a form field. You can optionally specify an Id for the form, if not provided one will be generated.
456 457 458 459 460 461 462 |
# File 'lib/fusionauth/fusionauth_client.rb', line 456 def create_form_field(field_id, request) start.uri('/api/form/field') .url_segment(field_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#create_group(group_id, request) ⇒ FusionAuth::ClientResponse
Creates a group. You can optionally specify an Id for the group, if not provided one will be generated.
470 471 472 473 474 475 476 |
# File 'lib/fusionauth/fusionauth_client.rb', line 470 def create_group(group_id, request) start.uri('/api/group') .url_segment(group_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#create_group_members(request) ⇒ FusionAuth::ClientResponse
Creates a member in a group.
483 484 485 486 487 488 |
# File 'lib/fusionauth/fusionauth_client.rb', line 483 def create_group_members(request) start.uri('/api/group/member') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#create_identity_provider(identity_provider_id, request) ⇒ FusionAuth::ClientResponse
Creates an identity provider. You can optionally specify an Id for the identity provider, if not provided one will be generated.
510 511 512 513 514 515 516 |
# File 'lib/fusionauth/fusionauth_client.rb', line 510 def create_identity_provider(identity_provider_id, request) start.uri('/api/identity-provider') .url_segment(identity_provider_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#create_ip_access_control_list(access_control_list_id, request) ⇒ FusionAuth::ClientResponse
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.
496 497 498 499 500 501 502 |
# File 'lib/fusionauth/fusionauth_client.rb', line 496 def create_ip_access_control_list(access_control_list_id, request) start.uri('/api/ip-acl') .url_segment(access_control_list_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#create_lambda(lambda_id, request) ⇒ FusionAuth::ClientResponse
Creates a Lambda. You can optionally specify an Id for the lambda, if not provided one will be generated.
524 525 526 527 528 529 530 |
# File 'lib/fusionauth/fusionauth_client.rb', line 524 def create_lambda(lambda_id, request) start.uri('/api/lambda') .url_segment(lambda_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#create_message_template(message_template_id, request) ⇒ FusionAuth::ClientResponse
Creates an message template. You can optionally specify an Id for the template, if not provided one will be generated.
538 539 540 541 542 543 544 |
# File 'lib/fusionauth/fusionauth_client.rb', line 538 def (, request) start.uri('/api/message/template') .url_segment() .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#create_messenger(messenger_id, request) ⇒ FusionAuth::ClientResponse
Creates a messenger. You can optionally specify an Id for the messenger, if not provided one will be generated.
552 553 554 555 556 557 558 |
# File 'lib/fusionauth/fusionauth_client.rb', line 552 def create_messenger(messenger_id, request) start.uri('/api/messenger') .url_segment(messenger_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#create_tenant(tenant_id, request) ⇒ FusionAuth::ClientResponse
Creates a tenant. You can optionally specify an Id for the tenant, if not provided one will be generated.
566 567 568 569 570 571 572 |
# File 'lib/fusionauth/fusionauth_client.rb', line 566 def create_tenant(tenant_id, request) start.uri('/api/tenant') .url_segment(tenant_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#create_theme(theme_id, request) ⇒ FusionAuth::ClientResponse
Creates a Theme. You can optionally specify an Id for the theme, if not provided one will be generated.
580 581 582 583 584 585 586 |
# File 'lib/fusionauth/fusionauth_client.rb', line 580 def create_theme(theme_id, request) start.uri('/api/theme') .url_segment(theme_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#create_user(user_id, request) ⇒ FusionAuth::ClientResponse
Creates a user. You can optionally specify an Id for the user, if not provided one will be generated.
594 595 596 597 598 599 600 |
# File 'lib/fusionauth/fusionauth_client.rb', line 594 def create_user(user_id, request) start.uri('/api/user') .url_segment(user_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#create_user_action(user_action_id, request) ⇒ FusionAuth::ClientResponse
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.
609 610 611 612 613 614 615 |
# File 'lib/fusionauth/fusionauth_client.rb', line 609 def create_user_action(user_action_id, request) start.uri('/api/user-action') .url_segment(user_action_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#create_user_action_reason(user_action_reason_id, request) ⇒ FusionAuth::ClientResponse
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.
624 625 626 627 628 629 630 |
# File 'lib/fusionauth/fusionauth_client.rb', line 624 def create_user_action_reason(user_action_reason_id, request) start.uri('/api/user-action-reason') .url_segment(user_action_reason_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#create_user_consent(user_consent_id, request) ⇒ FusionAuth::ClientResponse
Creates a single User consent.
638 639 640 641 642 643 644 |
# File 'lib/fusionauth/fusionauth_client.rb', line 638 def (, request) start.uri('/api/user/consent') .url_segment() .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#create_user_link(request) ⇒ FusionAuth::ClientResponse
Link an external user from a 3rd party identity provider to a FusionAuth user.
651 652 653 654 655 656 |
# File 'lib/fusionauth/fusionauth_client.rb', line 651 def create_user_link(request) start.uri('/api/identity-provider/link') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#create_webhook(webhook_id, request) ⇒ FusionAuth::ClientResponse
Creates a webhook. You can optionally specify an Id for the webhook, if not provided one will be generated.
664 665 666 667 668 669 670 |
# File 'lib/fusionauth/fusionauth_client.rb', line 664 def create_webhook(webhook_id, request) start.uri('/api/webhook') .url_segment(webhook_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#deactivate_application(application_id) ⇒ FusionAuth::ClientResponse
Deactivates the application with the given Id.
677 678 679 680 681 682 |
# File 'lib/fusionauth/fusionauth_client.rb', line 677 def deactivate_application(application_id) start.uri('/api/application') .url_segment(application_id) .delete() .go() end |
#deactivate_reactor ⇒ FusionAuth::ClientResponse
Deactivates the FusionAuth Reactor.
688 689 690 691 692 |
# File 'lib/fusionauth/fusionauth_client.rb', line 688 def deactivate_reactor() start.uri('/api/reactor') .delete() .go() end |
#deactivate_user(user_id) ⇒ FusionAuth::ClientResponse
Deactivates the user with the given Id.
699 700 701 702 703 704 |
# File 'lib/fusionauth/fusionauth_client.rb', line 699 def deactivate_user(user_id) start.uri('/api/user') .url_segment(user_id) .delete() .go() end |
#deactivate_user_action(user_action_id) ⇒ FusionAuth::ClientResponse
Deactivates the user action with the given Id.
711 712 713 714 715 716 |
# File 'lib/fusionauth/fusionauth_client.rb', line 711 def deactivate_user_action(user_action_id) start.uri('/api/user-action') .url_segment(user_action_id) .delete() .go() end |
#deactivate_users(user_ids) ⇒ FusionAuth::ClientResponse
This method has been renamed to deactivate_users_by_ids, use that method instead.
Deactivates the users with the given ids.
724 725 726 727 728 729 730 731 |
# File 'lib/fusionauth/fusionauth_client.rb', line 724 def deactivate_users(user_ids) start.uri('/api/user/bulk') .url_parameter('userId', user_ids) .url_parameter('dryRun', false) .url_parameter('hardDelete', false) .delete() .go() end |
#deactivate_users_by_ids(user_ids) ⇒ FusionAuth::ClientResponse
Deactivates the users with the given ids.
738 739 740 741 742 743 744 745 |
# File 'lib/fusionauth/fusionauth_client.rb', line 738 def deactivate_users_by_ids(user_ids) start.uri('/api/user/bulk') .url_parameter('userId', user_ids) .url_parameter('dryRun', false) .url_parameter('hardDelete', false) .delete() .go() end |
#delete_api_key(key_id) ⇒ FusionAuth::ClientResponse
Deletes the API key for the given Id.
752 753 754 755 756 757 |
# File 'lib/fusionauth/fusionauth_client.rb', line 752 def delete_api_key(key_id) start.uri('/api/api-key') .url_segment(key_id) .delete() .go() end |
#delete_application(application_id) ⇒ FusionAuth::ClientResponse
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.
767 768 769 770 771 772 773 |
# File 'lib/fusionauth/fusionauth_client.rb', line 767 def delete_application(application_id) start.uri('/api/application') .url_segment(application_id) .url_parameter('hardDelete', true) .delete() .go() end |
#delete_application_role(application_id, role_id) ⇒ FusionAuth::ClientResponse
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.
782 783 784 785 786 787 788 789 |
# File 'lib/fusionauth/fusionauth_client.rb', line 782 def delete_application_role(application_id, role_id) start.uri('/api/application') .url_segment(application_id) .url_segment("role") .url_segment(role_id) .delete() .go() end |
#delete_connector(connector_id) ⇒ FusionAuth::ClientResponse
Deletes the connector for the given Id.
796 797 798 799 800 801 |
# File 'lib/fusionauth/fusionauth_client.rb', line 796 def delete_connector(connector_id) start.uri('/api/connector') .url_segment(connector_id) .delete() .go() end |
#delete_consent(consent_id) ⇒ FusionAuth::ClientResponse
Deletes the consent for the given Id.
808 809 810 811 812 813 |
# File 'lib/fusionauth/fusionauth_client.rb', line 808 def () start.uri('/api/consent') .url_segment() .delete() .go() end |
#delete_email_template(email_template_id) ⇒ FusionAuth::ClientResponse
Deletes the email template for the given Id.
820 821 822 823 824 825 |
# File 'lib/fusionauth/fusionauth_client.rb', line 820 def delete_email_template(email_template_id) start.uri('/api/email/template') .url_segment(email_template_id) .delete() .go() end |
#delete_entity(entity_id) ⇒ FusionAuth::ClientResponse
Deletes the Entity for the given Id.
832 833 834 835 836 837 |
# File 'lib/fusionauth/fusionauth_client.rb', line 832 def delete_entity(entity_id) start.uri('/api/entity') .url_segment(entity_id) .delete() .go() end |
#delete_entity_grant(entity_id, recipient_entity_id, user_id) ⇒ FusionAuth::ClientResponse
Deletes an Entity Grant for the given User or Entity.
846 847 848 849 850 851 852 853 854 |
# File 'lib/fusionauth/fusionauth_client.rb', line 846 def delete_entity_grant(entity_id, recipient_entity_id, user_id) start.uri('/api/entity') .url_segment(entity_id) .url_segment("grant") .url_parameter('recipientEntityId', recipient_entity_id) .url_parameter('userId', user_id) .delete() .go() end |
#delete_entity_type(entity_type_id) ⇒ FusionAuth::ClientResponse
Deletes the Entity Type for the given Id.
861 862 863 864 865 866 |
# File 'lib/fusionauth/fusionauth_client.rb', line 861 def delete_entity_type(entity_type_id) start.uri('/api/entity/type') .url_segment(entity_type_id) .delete() .go() end |
#delete_entity_type_permission(entity_type_id, permission_id) ⇒ FusionAuth::ClientResponse
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.
875 876 877 878 879 880 881 882 |
# File 'lib/fusionauth/fusionauth_client.rb', line 875 def (entity_type_id, ) start.uri('/api/entity/type') .url_segment(entity_type_id) .url_segment("permission") .url_segment() .delete() .go() end |
#delete_form(form_id) ⇒ FusionAuth::ClientResponse
Deletes the form for the given Id.
889 890 891 892 893 894 |
# File 'lib/fusionauth/fusionauth_client.rb', line 889 def delete_form(form_id) start.uri('/api/form') .url_segment(form_id) .delete() .go() end |
#delete_form_field(field_id) ⇒ FusionAuth::ClientResponse
Deletes the form field for the given Id.
901 902 903 904 905 906 |
# File 'lib/fusionauth/fusionauth_client.rb', line 901 def delete_form_field(field_id) start.uri('/api/form/field') .url_segment(field_id) .delete() .go() end |
#delete_group(group_id) ⇒ FusionAuth::ClientResponse
Deletes the group for the given Id.
913 914 915 916 917 918 |
# File 'lib/fusionauth/fusionauth_client.rb', line 913 def delete_group(group_id) start.uri('/api/group') .url_segment(group_id) .delete() .go() end |
#delete_group_members(request) ⇒ FusionAuth::ClientResponse
Removes users as members of a group.
925 926 927 928 929 930 |
# File 'lib/fusionauth/fusionauth_client.rb', line 925 def delete_group_members(request) start.uri('/api/group/member') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .delete() .go() end |
#delete_identity_provider(identity_provider_id) ⇒ FusionAuth::ClientResponse
Deletes the identity provider for the given Id.
949 950 951 952 953 954 |
# File 'lib/fusionauth/fusionauth_client.rb', line 949 def delete_identity_provider(identity_provider_id) start.uri('/api/identity-provider') .url_segment(identity_provider_id) .delete() .go() end |
#delete_ip_access_control_list(ip_access_control_list_id) ⇒ FusionAuth::ClientResponse
Deletes the IP Access Control List for the given Id.
937 938 939 940 941 942 |
# File 'lib/fusionauth/fusionauth_client.rb', line 937 def delete_ip_access_control_list(ip_access_control_list_id) start.uri('/api/ip-acl') .url_segment(ip_access_control_list_id) .delete() .go() end |
#delete_key(key_id) ⇒ FusionAuth::ClientResponse
Deletes the key for the given Id.
961 962 963 964 965 966 |
# File 'lib/fusionauth/fusionauth_client.rb', line 961 def delete_key(key_id) start.uri('/api/key') .url_segment(key_id) .delete() .go() end |
#delete_lambda(lambda_id) ⇒ FusionAuth::ClientResponse
Deletes the lambda for the given Id.
973 974 975 976 977 978 |
# File 'lib/fusionauth/fusionauth_client.rb', line 973 def delete_lambda(lambda_id) start.uri('/api/lambda') .url_segment(lambda_id) .delete() .go() end |
#delete_message_template(message_template_id) ⇒ FusionAuth::ClientResponse
Deletes the message template for the given Id.
985 986 987 988 989 990 |
# File 'lib/fusionauth/fusionauth_client.rb', line 985 def () start.uri('/api/message/template') .url_segment() .delete() .go() end |
#delete_messenger(messenger_id) ⇒ FusionAuth::ClientResponse
Deletes the messenger for the given Id.
997 998 999 1000 1001 1002 |
# File 'lib/fusionauth/fusionauth_client.rb', line 997 def delete_messenger(messenger_id) start.uri('/api/messenger') .url_segment(messenger_id) .delete() .go() end |
#delete_registration(user_id, application_id) ⇒ FusionAuth::ClientResponse
Deletes the user registration for the given user and application.
1010 1011 1012 1013 1014 1015 1016 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1010 def delete_registration(user_id, application_id) start.uri('/api/user/registration') .url_segment(user_id) .url_segment(application_id) .delete() .go() end |
#delete_registration_with_request(user_id, application_id, request) ⇒ FusionAuth::ClientResponse
Deletes the user registration for the given user and application along with the given JSON body that contains the event information.
1025 1026 1027 1028 1029 1030 1031 1032 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1025 def delete_registration_with_request(user_id, application_id, request) start.uri('/api/user/registration') .url_segment(user_id) .url_segment(application_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .delete() .go() end |
#delete_tenant(tenant_id) ⇒ FusionAuth::ClientResponse
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).
1040 1041 1042 1043 1044 1045 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1040 def delete_tenant(tenant_id) start.uri('/api/tenant') .url_segment(tenant_id) .delete() .go() end |
#delete_tenant_async(tenant_id) ⇒ FusionAuth::ClientResponse
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.
1053 1054 1055 1056 1057 1058 1059 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1053 def delete_tenant_async(tenant_id) start.uri('/api/tenant') .url_segment(tenant_id) .url_parameter('async', true) .delete() .go() end |
#delete_tenant_with_request(tenant_id, request) ⇒ FusionAuth::ClientResponse
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).
1068 1069 1070 1071 1072 1073 1074 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1068 def delete_tenant_with_request(tenant_id, request) start.uri('/api/tenant') .url_segment(tenant_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .delete() .go() end |
#delete_theme(theme_id) ⇒ FusionAuth::ClientResponse
Deletes the theme for the given Id.
1081 1082 1083 1084 1085 1086 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1081 def delete_theme(theme_id) start.uri('/api/theme') .url_segment(theme_id) .delete() .go() end |
#delete_user(user_id) ⇒ FusionAuth::ClientResponse
Deletes the user for the given Id. This permanently deletes all information, metrics, reports and data associated with the user.
1094 1095 1096 1097 1098 1099 1100 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1094 def delete_user(user_id) start.uri('/api/user') .url_segment(user_id) .url_parameter('hardDelete', true) .delete() .go() end |
#delete_user_action(user_action_id) ⇒ FusionAuth::ClientResponse
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.
1108 1109 1110 1111 1112 1113 1114 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1108 def delete_user_action(user_action_id) start.uri('/api/user-action') .url_segment(user_action_id) .url_parameter('hardDelete', true) .delete() .go() end |
#delete_user_action_reason(user_action_reason_id) ⇒ FusionAuth::ClientResponse
Deletes the user action reason for the given Id.
1121 1122 1123 1124 1125 1126 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1121 def delete_user_action_reason(user_action_reason_id) start.uri('/api/user-action-reason') .url_segment(user_action_reason_id) .delete() .go() end |
#delete_user_link(identity_provider_id, identity_provider_user_id, user_id) ⇒ FusionAuth::ClientResponse
Remove an existing link that has been made from a 3rd party identity provider to a FusionAuth user.
1135 1136 1137 1138 1139 1140 1141 1142 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1135 def delete_user_link(identity_provider_id, identity_provider_user_id, user_id) start.uri('/api/identity-provider/link') .url_parameter('identityProviderId', identity_provider_id) .url_parameter('identityProviderUserId', identity_provider_user_id) .url_parameter('userId', user_id) .delete() .go() end |
#delete_user_with_request(user_id, request) ⇒ FusionAuth::ClientResponse
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.
1151 1152 1153 1154 1155 1156 1157 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1151 def delete_user_with_request(user_id, request) start.uri('/api/user') .url_segment(user_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .delete() .go() end |
#delete_users(request) ⇒ FusionAuth::ClientResponse
This method has been renamed to delete_users_by_query, use that method instead.
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.
1169 1170 1171 1172 1173 1174 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1169 def delete_users(request) start.uri('/api/user/bulk') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .delete() .go() end |
#delete_users_by_query(request) ⇒ FusionAuth::ClientResponse
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.
1185 1186 1187 1188 1189 1190 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1185 def delete_users_by_query(request) start.uri('/api/user/bulk') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .delete() .go() end |
#delete_web_authn_credential(id) ⇒ FusionAuth::ClientResponse
Deletes the WebAuthn credential for the given Id.
1197 1198 1199 1200 1201 1202 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1197 def delete_web_authn_credential(id) start.uri('/api/webauthn') .url_segment(id) .delete() .go() end |
#delete_webhook(webhook_id) ⇒ FusionAuth::ClientResponse
Deletes the webhook for the given Id.
1209 1210 1211 1212 1213 1214 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1209 def delete_webhook(webhook_id) start.uri('/api/webhook') .url_segment(webhook_id) .delete() .go() end |
#disable_two_factor(user_id, method_id, code) ⇒ FusionAuth::ClientResponse
Disable two-factor authentication for a user.
1223 1224 1225 1226 1227 1228 1229 1230 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1223 def disable_two_factor(user_id, method_id, code) start.uri('/api/user/two-factor') .url_segment(user_id) .url_parameter('methodId', method_id) .url_parameter('code', code) .delete() .go() end |
#disable_two_factor_with_request(user_id, request) ⇒ FusionAuth::ClientResponse
Disable two-factor authentication for a user using a JSON body rather than URL parameters.
1238 1239 1240 1241 1242 1243 1244 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1238 def disable_two_factor_with_request(user_id, request) start.uri('/api/user/two-factor') .url_segment(user_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .delete() .go() end |
#enable_two_factor(user_id, request) ⇒ FusionAuth::ClientResponse
Enable two-factor authentication for a user.
1252 1253 1254 1255 1256 1257 1258 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1252 def enable_two_factor(user_id, request) start.uri('/api/user/two-factor') .url_segment(user_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#exchange_o_auth_code_for_access_token(code, client_id, client_secret, redirect_uri) ⇒ FusionAuth::ClientResponse
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.
1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1270 def exchange_o_auth_code_for_access_token(code, client_id, client_secret, redirect_uri) body = { "code" => code, "client_id" => client_id, "client_secret" => client_secret, "grant_type" => "authorization_code", "redirect_uri" => redirect_uri } startAnonymous.uri('/oauth2/token') .body_handler(FusionAuth::FormDataBodyHandler.new(body)) .post() .go() end |
#exchange_o_auth_code_for_access_token_using_pkce(code, client_id, client_secret, redirect_uri, code_verifier) ⇒ FusionAuth::ClientResponse
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.
1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1295 def exchange_o_auth_code_for_access_token_using_pkce(code, client_id, client_secret, redirect_uri, code_verifier) body = { "code" => code, "client_id" => client_id, "client_secret" => client_secret, "grant_type" => "authorization_code", "redirect_uri" => redirect_uri, "code_verifier" => code_verifier } startAnonymous.uri('/oauth2/token') .body_handler(FusionAuth::FormDataBodyHandler.new(body)) .post() .go() end |
#exchange_refresh_token_for_access_token(refresh_token, client_id, client_secret, scope, user_code) ⇒ FusionAuth::ClientResponse
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.
1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1321 def exchange_refresh_token_for_access_token(refresh_token, client_id, client_secret, scope, user_code) body = { "refresh_token" => refresh_token, "client_id" => client_id, "client_secret" => client_secret, "grant_type" => "refresh_token", "scope" => scope, "user_code" => user_code } startAnonymous.uri('/oauth2/token') .body_handler(FusionAuth::FormDataBodyHandler.new(body)) .post() .go() end |
#exchange_refresh_token_for_jwt(request) ⇒ FusionAuth::ClientResponse
Exchange a refresh token for a new JWT.
1341 1342 1343 1344 1345 1346 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1341 def exchange_refresh_token_for_jwt(request) startAnonymous.uri('/api/jwt/refresh') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#exchange_user_credentials_for_access_token(username, password, client_id, client_secret, scope, user_code) ⇒ FusionAuth::ClientResponse
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.
1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1360 def exchange_user_credentials_for_access_token(username, password, client_id, client_secret, scope, user_code) body = { "username" => username, "password" => password, "client_id" => client_id, "client_secret" => client_secret, "grant_type" => "password", "scope" => scope, "user_code" => user_code } startAnonymous.uri('/oauth2/token') .body_handler(FusionAuth::FormDataBodyHandler.new(body)) .post() .go() end |
#forgot_password(request) ⇒ FusionAuth::ClientResponse
Begins the forgot password sequence, which kicks off an email to the user so that they can reset their password.
1381 1382 1383 1384 1385 1386 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1381 def forgot_password(request) start.uri('/api/user/forgot-password') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#generate_email_verification_id(email) ⇒ FusionAuth::ClientResponse
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.
1394 1395 1396 1397 1398 1399 1400 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1394 def generate_email_verification_id(email) start.uri('/api/user/verify-email') .url_parameter('email', email) .url_parameter('sendVerifyEmail', false) .put() .go() end |
#generate_key(key_id, request) ⇒ FusionAuth::ClientResponse
Generate a new RSA or EC key pair or an HMAC secret.
1408 1409 1410 1411 1412 1413 1414 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1408 def generate_key(key_id, request) start.uri('/api/key/generate') .url_segment(key_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#generate_registration_verification_id(email, application_id) ⇒ FusionAuth::ClientResponse
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.
1423 1424 1425 1426 1427 1428 1429 1430 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1423 def generate_registration_verification_id(email, application_id) start.uri('/api/user/verify-registration') .url_parameter('email', email) .url_parameter('sendVerifyPasswordEmail', false) .url_parameter('applicationId', application_id) .put() .go() end |
#generate_two_factor_recovery_codes(user_id) ⇒ FusionAuth::ClientResponse
Generate two-factor recovery codes for a user. Generating two-factor recovery codes will invalidate any existing recovery codes.
1437 1438 1439 1440 1441 1442 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1437 def generate_two_factor_recovery_codes(user_id) start.uri('/api/user/two-factor/recovery-code') .url_segment(user_id) .post() .go() end |
#generate_two_factor_secret ⇒ FusionAuth::ClientResponse
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.
1450 1451 1452 1453 1454 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1450 def generate_two_factor_secret() start.uri('/api/two-factor/secret') .get() .go() end |
#generate_two_factor_secret_using_jwt(encoded_jwt) ⇒ FusionAuth::ClientResponse
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.
1463 1464 1465 1466 1467 1468 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1463 def generate_two_factor_secret_using_jwt(encoded_jwt) startAnonymous.uri('/api/two-factor/secret') .('Bearer ' + encoded_jwt) .get() .go() end |
#identity_provider_login(request) ⇒ FusionAuth::ClientResponse
Handles login via third-parties including Social login, external OAuth and OpenID Connect, and other login systems.
1477 1478 1479 1480 1481 1482 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1477 def identity_provider_login(request) startAnonymous.uri('/api/identity-provider/login') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#import_key(key_id, request) ⇒ FusionAuth::ClientResponse
Import an existing RSA or EC key pair or an HMAC secret.
1490 1491 1492 1493 1494 1495 1496 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1490 def import_key(key_id, request) start.uri('/api/key/import') .url_segment(key_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#import_refresh_tokens(request) ⇒ FusionAuth::ClientResponse
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.
1510 1511 1512 1513 1514 1515 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1510 def import_refresh_tokens(request) start.uri('/api/user/refresh-token/import') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#import_users(request) ⇒ FusionAuth::ClientResponse
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.
1529 1530 1531 1532 1533 1534 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1529 def import_users(request) start.uri('/api/user/import') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#import_web_authn_credential(request) ⇒ FusionAuth::ClientResponse
Import a WebAuthn credential
1541 1542 1543 1544 1545 1546 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1541 def import_web_authn_credential(request) start.uri('/api/webauthn/import') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#introspect_access_token(client_id, token) ⇒ FusionAuth::ClientResponse
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.
1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1554 def introspect_access_token(client_id, token) body = { "client_id" => client_id, "token" => token } startAnonymous.uri('/oauth2/introspect') .body_handler(FusionAuth::FormDataBodyHandler.new(body)) .post() .go() end |
#introspect_client_credentials_access_token(token) ⇒ FusionAuth::ClientResponse
Inspect an access token issued as the result of the Client Credentials Grant.
1570 1571 1572 1573 1574 1575 1576 1577 1578 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1570 def introspect_client_credentials_access_token(token) body = { "token" => token } startAnonymous.uri('/oauth2/introspect') .body_handler(FusionAuth::FormDataBodyHandler.new(body)) .post() .go() end |
#issue_jwt(application_id, encoded_jwt, refresh_token) ⇒ FusionAuth::ClientResponse
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. <p> 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.
1593 1594 1595 1596 1597 1598 1599 1600 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1593 def issue_jwt(application_id, encoded_jwt, refresh_token) startAnonymous.uri('/api/jwt/issue') .('Bearer ' + encoded_jwt) .url_parameter('applicationId', application_id) .url_parameter('refreshToken', refresh_token) .get() .go() end |
#login(request) ⇒ FusionAuth::ClientResponse
Authenticates a user to FusionAuth.
This API optionally requires an API key. See Application.loginConfiguration.requireAuthentication
.
1609 1610 1611 1612 1613 1614 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1609 def login(request) start.uri('/api/login') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#login_ping(user_id, application_id, caller_ip_address) ⇒ FusionAuth::ClientResponse
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.
1627 1628 1629 1630 1631 1632 1633 1634 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1627 def login_ping(user_id, application_id, caller_ip_address) start.uri('/api/login') .url_segment(user_id) .url_segment(application_id) .url_parameter('ipAddress', caller_ip_address) .put() .go() end |
#login_ping_with_request(request) ⇒ FusionAuth::ClientResponse
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.
1644 1645 1646 1647 1648 1649 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1644 def login_ping_with_request(request) start.uri('/api/login') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .put() .go() end |
#logout(global, refresh_token) ⇒ FusionAuth::ClientResponse
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.
1661 1662 1663 1664 1665 1666 1667 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1661 def logout(global, refresh_token) startAnonymous.uri('/api/logout') .url_parameter('global', global) .url_parameter('refreshToken', refresh_token) .post() .go() end |
#logout_with_request(request) ⇒ FusionAuth::ClientResponse
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.
1675 1676 1677 1678 1679 1680 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1675 def logout_with_request(request) startAnonymous.uri('/api/logout') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#lookup_identity_provider(domain) ⇒ FusionAuth::ClientResponse
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.
1688 1689 1690 1691 1692 1693 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1688 def lookup_identity_provider(domain) start.uri('/api/identity-provider/lookup') .url_parameter('domain', domain) .get() .go() end |
#modify_action(action_id, request) ⇒ FusionAuth::ClientResponse
Modifies a temporal user action by changing the expiration of the action and optionally adding a comment to the action.
1702 1703 1704 1705 1706 1707 1708 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1702 def modify_action(action_id, request) start.uri('/api/user/action') .url_segment(action_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .put() .go() end |
#passwordless_login(request) ⇒ FusionAuth::ClientResponse
Complete a login request using a passwordless code
1715 1716 1717 1718 1719 1720 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1715 def passwordless_login(request) startAnonymous.uri('/api/passwordless/login') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#patch_api_key(key_id, request) ⇒ FusionAuth::ClientResponse
Updates an authentication API key by given id
1728 1729 1730 1731 1732 1733 1734 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1728 def patch_api_key(key_id, request) start.uri('/api/api-key') .url_segment(key_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#patch_application(application_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the application with the given Id.
1742 1743 1744 1745 1746 1747 1748 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1742 def patch_application(application_id, request) start.uri('/api/application') .url_segment(application_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .patch() .go() end |
#patch_application_role(application_id, role_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the application role with the given Id for the application.
1757 1758 1759 1760 1761 1762 1763 1764 1765 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1757 def patch_application_role(application_id, role_id, request) start.uri('/api/application') .url_segment(application_id) .url_segment("role") .url_segment(role_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .patch() .go() end |
#patch_connector(connector_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the connector with the given Id.
1773 1774 1775 1776 1777 1778 1779 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1773 def patch_connector(connector_id, request) start.uri('/api/connector') .url_segment(connector_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .patch() .go() end |
#patch_consent(consent_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the consent with the given Id.
1787 1788 1789 1790 1791 1792 1793 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1787 def (, request) start.uri('/api/consent') .url_segment() .body_handler(FusionAuth::JSONBodyHandler.new(request)) .patch() .go() end |
#patch_email_template(email_template_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the email template with the given Id.
1801 1802 1803 1804 1805 1806 1807 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1801 def patch_email_template(email_template_id, request) start.uri('/api/email/template') .url_segment(email_template_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .patch() .go() end |
#patch_entity_type(entity_type_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the Entity Type with the given Id.
1815 1816 1817 1818 1819 1820 1821 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1815 def patch_entity_type(entity_type_id, request) start.uri('/api/entity/type') .url_segment(entity_type_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .patch() .go() end |
#patch_group(group_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the group with the given Id.
1829 1830 1831 1832 1833 1834 1835 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1829 def patch_group(group_id, request) start.uri('/api/group') .url_segment(group_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .patch() .go() end |
#patch_identity_provider(identity_provider_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the identity provider with the given Id.
1843 1844 1845 1846 1847 1848 1849 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1843 def patch_identity_provider(identity_provider_id, request) start.uri('/api/identity-provider') .url_segment(identity_provider_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .patch() .go() end |
#patch_integrations(request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the available integrations.
1856 1857 1858 1859 1860 1861 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1856 def patch_integrations(request) start.uri('/api/integration') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .patch() .go() end |
#patch_lambda(lambda_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the lambda with the given Id.
1869 1870 1871 1872 1873 1874 1875 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1869 def patch_lambda(lambda_id, request) start.uri('/api/lambda') .url_segment(lambda_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .patch() .go() end |
#patch_message_template(message_template_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the message template with the given Id.
1883 1884 1885 1886 1887 1888 1889 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1883 def (, request) start.uri('/api/message/template') .url_segment() .body_handler(FusionAuth::JSONBodyHandler.new(request)) .patch() .go() end |
#patch_messenger(messenger_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the messenger with the given Id.
1897 1898 1899 1900 1901 1902 1903 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1897 def patch_messenger(messenger_id, request) start.uri('/api/messenger') .url_segment(messenger_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .patch() .go() end |
#patch_registration(user_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the registration for the user with the given Id and the application defined in the request.
1911 1912 1913 1914 1915 1916 1917 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1911 def patch_registration(user_id, request) start.uri('/api/user/registration') .url_segment(user_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .patch() .go() end |
#patch_system_configuration(request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the system configuration.
1924 1925 1926 1927 1928 1929 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1924 def patch_system_configuration(request) start.uri('/api/system-configuration') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .patch() .go() end |
#patch_tenant(tenant_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the tenant with the given Id.
1937 1938 1939 1940 1941 1942 1943 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1937 def patch_tenant(tenant_id, request) start.uri('/api/tenant') .url_segment(tenant_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .patch() .go() end |
#patch_theme(theme_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the theme with the given Id.
1951 1952 1953 1954 1955 1956 1957 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1951 def patch_theme(theme_id, request) start.uri('/api/theme') .url_segment(theme_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .patch() .go() end |
#patch_user(user_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the user with the given Id.
1965 1966 1967 1968 1969 1970 1971 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1965 def patch_user(user_id, request) start.uri('/api/user') .url_segment(user_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .patch() .go() end |
#patch_user_action(user_action_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the user action with the given Id.
1979 1980 1981 1982 1983 1984 1985 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1979 def patch_user_action(user_action_id, request) start.uri('/api/user-action') .url_segment(user_action_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .patch() .go() end |
#patch_user_action_reason(user_action_reason_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, the user action reason with the given Id.
1993 1994 1995 1996 1997 1998 1999 |
# File 'lib/fusionauth/fusionauth_client.rb', line 1993 def patch_user_action_reason(user_action_reason_id, request) start.uri('/api/user-action-reason') .url_segment(user_action_reason_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .patch() .go() end |
#patch_user_consent(user_consent_id, request) ⇒ FusionAuth::ClientResponse
Updates, via PATCH, a single User consent by Id.
2007 2008 2009 2010 2011 2012 2013 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2007 def (, request) start.uri('/api/user/consent') .url_segment() .body_handler(FusionAuth::JSONBodyHandler.new(request)) .patch() .go() end |
#reactivate_application(application_id) ⇒ FusionAuth::ClientResponse
Reactivates the application with the given Id.
2020 2021 2022 2023 2024 2025 2026 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2020 def reactivate_application(application_id) start.uri('/api/application') .url_segment(application_id) .url_parameter('reactivate', true) .put() .go() end |
#reactivate_user(user_id) ⇒ FusionAuth::ClientResponse
Reactivates the user with the given Id.
2033 2034 2035 2036 2037 2038 2039 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2033 def reactivate_user(user_id) start.uri('/api/user') .url_segment(user_id) .url_parameter('reactivate', true) .put() .go() end |
#reactivate_user_action(user_action_id) ⇒ FusionAuth::ClientResponse
Reactivates the user action with the given Id.
2046 2047 2048 2049 2050 2051 2052 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2046 def reactivate_user_action(user_action_id) start.uri('/api/user-action') .url_segment(user_action_id) .url_parameter('reactivate', true) .put() .go() end |
#reconcile_jwt(request) ⇒ FusionAuth::ClientResponse
Reconcile a User to FusionAuth using JWT issued from another Identity Provider.
2059 2060 2061 2062 2063 2064 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2059 def reconcile_jwt(request) startAnonymous.uri('/api/jwt/reconcile') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#refresh_entity_search_index ⇒ FusionAuth::ClientResponse
Request a refresh of the Entity search index. This API is not generally necessary and the search index will become consistent in a reasonable amount of time. There may be scenarios where you may wish to manually request an index refresh. One example may be if you are using the Search API or Delete Tenant API immediately following a Entity Create etc, you may wish to request a refresh to
ensure the index immediately current before making a query request to the search index.
2073 2074 2075 2076 2077 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2073 def refresh_entity_search_index() start.uri('/api/entity/search') .put() .go() end |
#refresh_user_search_index ⇒ FusionAuth::ClientResponse
Request a refresh of the User search index. This API is not generally necessary and the search index will become consistent in a reasonable amount of time. There may be scenarios where you may wish to manually request an index refresh. One example may be if you are using the Search API or Delete Tenant API immediately following a User Create etc, you may wish to request a refresh to
ensure the index immediately current before making a query request to the search index.
2086 2087 2088 2089 2090 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2086 def refresh_user_search_index() start.uri('/api/user/search') .put() .go() end |
#regenerate_reactor_keys ⇒ FusionAuth::ClientResponse
Regenerates any keys that are used by the FusionAuth Reactor.
2096 2097 2098 2099 2100 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2096 def regenerate_reactor_keys() start.uri('/api/reactor') .put() .go() end |
#register(user_id, request) ⇒ FusionAuth::ClientResponse
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.
2112 2113 2114 2115 2116 2117 2118 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2112 def register(user_id, request) start.uri('/api/user/registration') .url_segment(user_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#reindex(request) ⇒ FusionAuth::ClientResponse
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.
2129 2130 2131 2132 2133 2134 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2129 def reindex(request) start.uri('/api/system/reindex') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#remove_user_from_family(family_id, user_id) ⇒ FusionAuth::ClientResponse
Removes a user from the family with the given id.
2142 2143 2144 2145 2146 2147 2148 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2142 def remove_user_from_family(family_id, user_id) start.uri('/api/user/family') .url_segment(family_id) .url_segment(user_id) .delete() .go() end |
#resend_email_verification(email) ⇒ FusionAuth::ClientResponse
Re-sends the verification email to the user.
2155 2156 2157 2158 2159 2160 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2155 def resend_email_verification(email) start.uri('/api/user/verify-email') .url_parameter('email', email) .put() .go() end |
#resend_email_verification_with_application_template(application_id, email) ⇒ FusionAuth::ClientResponse
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.
2169 2170 2171 2172 2173 2174 2175 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2169 def resend_email_verification_with_application_template(application_id, email) start.uri('/api/user/verify-email') .url_parameter('applicationId', application_id) .url_parameter('email', email) .put() .go() end |
#resend_registration_verification(email, application_id) ⇒ FusionAuth::ClientResponse
Re-sends the application registration verification email to the user.
2183 2184 2185 2186 2187 2188 2189 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2183 def resend_registration_verification(email, application_id) start.uri('/api/user/verify-registration') .url_parameter('email', email) .url_parameter('applicationId', application_id) .put() .go() end |
#retrieve_action(action_id) ⇒ FusionAuth::ClientResponse
Retrieves a single action log (the log of a user action that was taken on a user previously) for the given Id.
2208 2209 2210 2211 2212 2213 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2208 def retrieve_action(action_id) start.uri('/api/user/action') .url_segment(action_id) .get() .go() end |
#retrieve_actions(user_id) ⇒ FusionAuth::ClientResponse
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.
2221 2222 2223 2224 2225 2226 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2221 def retrieve_actions(user_id) start.uri('/api/user/action') .url_parameter('userId', user_id) .get() .go() end |
#retrieve_actions_preventing_login(user_id) ⇒ FusionAuth::ClientResponse
Retrieves all the actions for the user with the given Id that are currently preventing the User from logging in.
2233 2234 2235 2236 2237 2238 2239 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2233 def retrieve_actions_preventing_login(user_id) start.uri('/api/user/action') .url_parameter('userId', user_id) .url_parameter('preventingLogin', true) .get() .go() end |
#retrieve_active_actions(user_id) ⇒ FusionAuth::ClientResponse
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.
2247 2248 2249 2250 2251 2252 2253 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2247 def retrieve_active_actions(user_id) start.uri('/api/user/action') .url_parameter('userId', user_id) .url_parameter('active', true) .get() .go() end |
#retrieve_api_key(key_id) ⇒ FusionAuth::ClientResponse
Retrieves an authentication API key for the given id
2196 2197 2198 2199 2200 2201 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2196 def retrieve_api_key(key_id) start.uri('/api/api-key') .url_segment(key_id) .get() .go() end |
#retrieve_application(application_id) ⇒ FusionAuth::ClientResponse
Retrieves the application for the given Id or all the applications if the Id is null.
2260 2261 2262 2263 2264 2265 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2260 def retrieve_application(application_id) start.uri('/api/application') .url_segment(application_id) .get() .go() end |
#retrieve_applications ⇒ FusionAuth::ClientResponse
Retrieves all the applications.
2271 2272 2273 2274 2275 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2271 def retrieve_applications() start.uri('/api/application') .get() .go() end |
#retrieve_audit_log(audit_log_id) ⇒ FusionAuth::ClientResponse
Retrieves a single audit log for the given Id.
2282 2283 2284 2285 2286 2287 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2282 def retrieve_audit_log(audit_log_id) start.uri('/api/system/audit-log') .url_segment(audit_log_id) .get() .go() end |
#retrieve_connector(connector_id) ⇒ FusionAuth::ClientResponse
Retrieves the connector with the given Id.
2294 2295 2296 2297 2298 2299 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2294 def retrieve_connector(connector_id) start.uri('/api/connector') .url_segment(connector_id) .get() .go() end |
#retrieve_connectors ⇒ FusionAuth::ClientResponse
Retrieves all the connectors.
2305 2306 2307 2308 2309 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2305 def retrieve_connectors() start.uri('/api/connector') .get() .go() end |
#retrieve_consent(consent_id) ⇒ FusionAuth::ClientResponse
Retrieves the Consent for the given Id.
2316 2317 2318 2319 2320 2321 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2316 def () start.uri('/api/consent') .url_segment() .get() .go() end |
#retrieve_consents ⇒ FusionAuth::ClientResponse
Retrieves all the consent.
2327 2328 2329 2330 2331 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2327 def () start.uri('/api/consent') .get() .go() end |
#retrieve_daily_active_report(application_id, start, _end) ⇒ FusionAuth::ClientResponse
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.
2341 2342 2343 2344 2345 2346 2347 2348 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2341 def retrieve_daily_active_report(application_id, start, _end) start.uri('/api/report/daily-active-user') .url_parameter('applicationId', application_id) .url_parameter('start', start) .url_parameter('end', _end) .get() .go() end |
#retrieve_email_template(email_template_id) ⇒ FusionAuth::ClientResponse
Retrieves the email template for the given Id. If you don’t specify the id, this will return all the email templates.
2355 2356 2357 2358 2359 2360 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2355 def retrieve_email_template(email_template_id) start.uri('/api/email/template') .url_segment(email_template_id) .get() .go() end |
#retrieve_email_template_preview(request) ⇒ FusionAuth::ClientResponse
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.
2369 2370 2371 2372 2373 2374 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2369 def retrieve_email_template_preview(request) start.uri('/api/email/template/preview') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#retrieve_email_templates ⇒ FusionAuth::ClientResponse
Retrieves all the email templates.
2380 2381 2382 2383 2384 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2380 def retrieve_email_templates() start.uri('/api/email/template') .get() .go() end |
#retrieve_entity(entity_id) ⇒ FusionAuth::ClientResponse
Retrieves the Entity for the given Id.
2391 2392 2393 2394 2395 2396 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2391 def retrieve_entity(entity_id) start.uri('/api/entity') .url_segment(entity_id) .get() .go() end |
#retrieve_entity_grant(entity_id, recipient_entity_id, user_id) ⇒ FusionAuth::ClientResponse
Retrieves an Entity Grant for the given Entity and User/Entity.
2405 2406 2407 2408 2409 2410 2411 2412 2413 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2405 def retrieve_entity_grant(entity_id, recipient_entity_id, user_id) start.uri('/api/entity') .url_segment(entity_id) .url_segment("grant") .url_parameter('recipientEntityId', recipient_entity_id) .url_parameter('userId', user_id) .get() .go() end |
#retrieve_entity_type(entity_type_id) ⇒ FusionAuth::ClientResponse
Retrieves the Entity Type for the given Id.
2420 2421 2422 2423 2424 2425 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2420 def retrieve_entity_type(entity_type_id) start.uri('/api/entity/type') .url_segment(entity_type_id) .get() .go() end |
#retrieve_entity_types ⇒ FusionAuth::ClientResponse
Retrieves all the Entity Types.
2431 2432 2433 2434 2435 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2431 def retrieve_entity_types() start.uri('/api/entity/type') .get() .go() end |
#retrieve_event_log(event_log_id) ⇒ FusionAuth::ClientResponse
Retrieves a single event log for the given Id.
2442 2443 2444 2445 2446 2447 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2442 def retrieve_event_log(event_log_id) start.uri('/api/system/event-log') .url_segment(event_log_id) .get() .go() end |
#retrieve_families(user_id) ⇒ FusionAuth::ClientResponse
Retrieves all the families that a user belongs to.
2454 2455 2456 2457 2458 2459 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2454 def retrieve_families(user_id) start.uri('/api/user/family') .url_parameter('userId', user_id) .get() .go() end |
#retrieve_family_members_by_family_id(family_id) ⇒ FusionAuth::ClientResponse
Retrieves all the members of a family by the unique Family Id.
2466 2467 2468 2469 2470 2471 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2466 def retrieve_family_members_by_family_id(family_id) start.uri('/api/user/family') .url_segment(family_id) .get() .go() end |
#retrieve_form(form_id) ⇒ FusionAuth::ClientResponse
Retrieves the form with the given Id.
2478 2479 2480 2481 2482 2483 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2478 def retrieve_form(form_id) start.uri('/api/form') .url_segment(form_id) .get() .go() end |
#retrieve_form_field(field_id) ⇒ FusionAuth::ClientResponse
Retrieves the form field with the given Id.
2490 2491 2492 2493 2494 2495 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2490 def retrieve_form_field(field_id) start.uri('/api/form/field') .url_segment(field_id) .get() .go() end |
#retrieve_form_fields ⇒ FusionAuth::ClientResponse
Retrieves all the forms fields
2501 2502 2503 2504 2505 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2501 def retrieve_form_fields() start.uri('/api/form/field') .get() .go() end |
#retrieve_forms ⇒ FusionAuth::ClientResponse
Retrieves all the forms.
2511 2512 2513 2514 2515 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2511 def retrieve_forms() start.uri('/api/form') .get() .go() end |
#retrieve_group(group_id) ⇒ FusionAuth::ClientResponse
Retrieves the group for the given Id.
2522 2523 2524 2525 2526 2527 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2522 def retrieve_group(group_id) start.uri('/api/group') .url_segment(group_id) .get() .go() end |
#retrieve_groups ⇒ FusionAuth::ClientResponse
Retrieves all the groups.
2533 2534 2535 2536 2537 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2533 def retrieve_groups() start.uri('/api/group') .get() .go() end |
#retrieve_identity_provider(identity_provider_id) ⇒ FusionAuth::ClientResponse
Retrieves the identity provider for the given Id or all the identity providers if the Id is null.
2556 2557 2558 2559 2560 2561 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2556 def retrieve_identity_provider(identity_provider_id) start.uri('/api/identity-provider') .url_segment(identity_provider_id) .get() .go() end |
#retrieve_identity_provider_by_type(type) ⇒ FusionAuth::ClientResponse
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.
2570 2571 2572 2573 2574 2575 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2570 def retrieve_identity_provider_by_type(type) start.uri('/api/identity-provider') .url_parameter('type', type) .get() .go() end |
#retrieve_identity_providers ⇒ FusionAuth::ClientResponse
Retrieves all the identity providers.
2581 2582 2583 2584 2585 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2581 def retrieve_identity_providers() start.uri('/api/identity-provider') .get() .go() end |
#retrieve_inactive_actions(user_id) ⇒ FusionAuth::ClientResponse
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.
2593 2594 2595 2596 2597 2598 2599 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2593 def retrieve_inactive_actions(user_id) start.uri('/api/user/action') .url_parameter('userId', user_id) .url_parameter('active', false) .get() .go() end |
#retrieve_inactive_applications ⇒ FusionAuth::ClientResponse
Retrieves all the applications that are currently inactive.
2605 2606 2607 2608 2609 2610 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2605 def retrieve_inactive_applications() start.uri('/api/application') .url_parameter('inactive', true) .get() .go() end |
#retrieve_inactive_user_actions ⇒ FusionAuth::ClientResponse
Retrieves all the user actions that are currently inactive.
2616 2617 2618 2619 2620 2621 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2616 def retrieve_inactive_user_actions() start.uri('/api/user-action') .url_parameter('inactive', true) .get() .go() end |
#retrieve_integration ⇒ FusionAuth::ClientResponse
Retrieves the available integrations.
2627 2628 2629 2630 2631 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2627 def retrieve_integration() start.uri('/api/integration') .get() .go() end |
#retrieve_ip_access_control_list(ip_access_control_list_id) ⇒ FusionAuth::ClientResponse
Retrieves the IP Access Control List with the given Id.
2544 2545 2546 2547 2548 2549 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2544 def retrieve_ip_access_control_list(ip_access_control_list_id) start.uri('/api/ip-acl') .url_segment(ip_access_control_list_id) .get() .go() end |
#retrieve_json_web_key_set ⇒ FusionAuth::ClientResponse
Returns public keys used by FusionAuth to cryptographically verify JWTs using the JSON Web Key format.
2671 2672 2673 2674 2675 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2671 def retrieve_json_web_key_set() startAnonymous.uri('/.well-known/jwks.json') .get() .go() end |
#retrieve_jwt_public_key(key_id) ⇒ FusionAuth::ClientResponse
Retrieves the Public Key configured for verifying JSON Web Tokens (JWT) by the key Id (kid).
2638 2639 2640 2641 2642 2643 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2638 def retrieve_jwt_public_key(key_id) startAnonymous.uri('/api/jwt/public-key') .url_parameter('kid', key_id) .get() .go() end |
#retrieve_jwt_public_key_by_application_id(application_id) ⇒ FusionAuth::ClientResponse
Retrieves the Public Key configured for verifying the JSON Web Tokens (JWT) issued by the Login API by the Application Id.
2650 2651 2652 2653 2654 2655 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2650 def retrieve_jwt_public_key_by_application_id(application_id) startAnonymous.uri('/api/jwt/public-key') .url_parameter('applicationId', application_id) .get() .go() end |
#retrieve_jwt_public_keys ⇒ FusionAuth::ClientResponse
Retrieves all Public Keys configured for verifying JSON Web Tokens (JWT).
2661 2662 2663 2664 2665 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2661 def retrieve_jwt_public_keys() startAnonymous.uri('/api/jwt/public-key') .get() .go() end |
#retrieve_key(key_id) ⇒ FusionAuth::ClientResponse
Retrieves the key for the given Id.
2682 2683 2684 2685 2686 2687 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2682 def retrieve_key(key_id) start.uri('/api/key') .url_segment(key_id) .get() .go() end |
#retrieve_keys ⇒ FusionAuth::ClientResponse
Retrieves all the keys.
2693 2694 2695 2696 2697 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2693 def retrieve_keys() start.uri('/api/key') .get() .go() end |
#retrieve_lambda(lambda_id) ⇒ FusionAuth::ClientResponse
Retrieves the lambda for the given Id.
2704 2705 2706 2707 2708 2709 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2704 def retrieve_lambda(lambda_id) start.uri('/api/lambda') .url_segment(lambda_id) .get() .go() end |
#retrieve_lambdas ⇒ FusionAuth::ClientResponse
Retrieves all the lambdas.
2715 2716 2717 2718 2719 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2715 def retrieve_lambdas() start.uri('/api/lambda') .get() .go() end |
#retrieve_lambdas_by_type(type) ⇒ FusionAuth::ClientResponse
Retrieves all the lambdas for the provided type.
2726 2727 2728 2729 2730 2731 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2726 def retrieve_lambdas_by_type(type) start.uri('/api/lambda') .url_parameter('type', type) .get() .go() end |
#retrieve_login_report(application_id, start, _end) ⇒ FusionAuth::ClientResponse
Retrieves the login report between the two instants. If you specify an application id, it will only return the login counts for that application.
2741 2742 2743 2744 2745 2746 2747 2748 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2741 def retrieve_login_report(application_id, start, _end) start.uri('/api/report/login') .url_parameter('applicationId', application_id) .url_parameter('start', start) .url_parameter('end', _end) .get() .go() end |
#retrieve_message_template(message_template_id) ⇒ FusionAuth::ClientResponse
Retrieves the message template for the given Id. If you don’t specify the id, this will return all the message templates.
2755 2756 2757 2758 2759 2760 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2755 def () start.uri('/api/message/template') .url_segment() .get() .go() end |
#retrieve_message_template_preview(request) ⇒ FusionAuth::ClientResponse
Creates a preview of the message template provided in the request, normalized to a given locale.
2767 2768 2769 2770 2771 2772 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2767 def (request) start.uri('/api/message/template/preview') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#retrieve_message_templates ⇒ FusionAuth::ClientResponse
Retrieves all the message templates.
2778 2779 2780 2781 2782 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2778 def () start.uri('/api/message/template') .get() .go() end |
#retrieve_messenger(messenger_id) ⇒ FusionAuth::ClientResponse
Retrieves the messenger with the given Id.
2789 2790 2791 2792 2793 2794 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2789 def retrieve_messenger(messenger_id) start.uri('/api/messenger') .url_segment(messenger_id) .get() .go() end |
#retrieve_messengers ⇒ FusionAuth::ClientResponse
Retrieves all the messengers.
2800 2801 2802 2803 2804 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2800 def retrieve_messengers() start.uri('/api/messenger') .get() .go() end |
#retrieve_monthly_active_report(application_id, start, _end) ⇒ FusionAuth::ClientResponse
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.
2814 2815 2816 2817 2818 2819 2820 2821 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2814 def retrieve_monthly_active_report(application_id, start, _end) start.uri('/api/report/monthly-active-user') .url_parameter('applicationId', application_id) .url_parameter('start', start) .url_parameter('end', _end) .get() .go() end |
#retrieve_oauth_configuration(application_id) ⇒ FusionAuth::ClientResponse
Retrieves the Oauth2 configuration for the application for the given Application Id.
2828 2829 2830 2831 2832 2833 2834 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2828 def retrieve_oauth_configuration(application_id) start.uri('/api/application') .url_segment(application_id) .url_segment("oauth-configuration") .get() .go() end |
#retrieve_open_id_configuration ⇒ FusionAuth::ClientResponse
Returns the well known OpenID Configuration JSON document
2840 2841 2842 2843 2844 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2840 def retrieve_open_id_configuration() startAnonymous.uri('/.well-known/openid-configuration') .get() .go() end |
#retrieve_password_validation_rules ⇒ FusionAuth::ClientResponse
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.
2853 2854 2855 2856 2857 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2853 def retrieve_password_validation_rules() startAnonymous.uri('/api/tenant/password-validation-rules') .get() .go() end |
#retrieve_password_validation_rules_with_tenant_id(tenant_id) ⇒ FusionAuth::ClientResponse
Retrieves the password validation rules for a specific tenant.
This API does not require an API key.
2866 2867 2868 2869 2870 2871 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2866 def retrieve_password_validation_rules_with_tenant_id(tenant_id) startAnonymous.uri('/api/tenant/password-validation-rules') .url_segment(tenant_id) .get() .go() end |
#retrieve_pending_children(parent_email) ⇒ FusionAuth::ClientResponse
Retrieves all the children for the given parent email address.
2878 2879 2880 2881 2882 2883 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2878 def retrieve_pending_children(parent_email) start.uri('/api/user/family/pending') .url_parameter('parentEmail', parent_email) .get() .go() end |
#retrieve_pending_link(pending_link_id, user_id) ⇒ FusionAuth::ClientResponse
Retrieve a pending identity provider link. This is useful to validate a pending link and retrieve meta-data about the identity provider link.
2891 2892 2893 2894 2895 2896 2897 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2891 def retrieve_pending_link(pending_link_id, user_id) start.uri('/api/identity-provider/link/pending') .url_segment(pending_link_id) .url_parameter('userId', user_id) .get() .go() end |
#retrieve_reactor_metrics ⇒ FusionAuth::ClientResponse
Retrieves the FusionAuth Reactor metrics.
2903 2904 2905 2906 2907 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2903 def retrieve_reactor_metrics() start.uri('/api/reactor/metrics') .get() .go() end |
#retrieve_reactor_status ⇒ FusionAuth::ClientResponse
Retrieves the FusionAuth Reactor status.
2913 2914 2915 2916 2917 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2913 def retrieve_reactor_status() start.uri('/api/reactor') .get() .go() end |
#retrieve_recent_logins(offset, limit) ⇒ FusionAuth::ClientResponse
Retrieves the last number of login records.
2925 2926 2927 2928 2929 2930 2931 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2925 def retrieve_recent_logins(offset, limit) start.uri('/api/user/recent-login') .url_parameter('offset', offset) .url_parameter('limit', limit) .get() .go() end |
#retrieve_refresh_token_by_id(token_id) ⇒ FusionAuth::ClientResponse
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.
2938 2939 2940 2941 2942 2943 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2938 def retrieve_refresh_token_by_id(token_id) start.uri('/api/jwt/refresh') .url_segment(token_id) .get() .go() end |
#retrieve_refresh_tokens(user_id) ⇒ FusionAuth::ClientResponse
Retrieves the refresh tokens that belong to the user with the given Id.
2950 2951 2952 2953 2954 2955 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2950 def retrieve_refresh_tokens(user_id) start.uri('/api/jwt/refresh') .url_parameter('userId', user_id) .get() .go() end |
#retrieve_registration(user_id, application_id) ⇒ FusionAuth::ClientResponse
Retrieves the user registration for the user with the given Id and the given application id.
2963 2964 2965 2966 2967 2968 2969 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2963 def retrieve_registration(user_id, application_id) start.uri('/api/user/registration') .url_segment(user_id) .url_segment(application_id) .get() .go() end |
#retrieve_registration_report(application_id, start, _end) ⇒ FusionAuth::ClientResponse
Retrieves the registration report between the two instants. If you specify an application id, it will only return the registration counts for that application.
2979 2980 2981 2982 2983 2984 2985 2986 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2979 def retrieve_registration_report(application_id, start, _end) start.uri('/api/report/registration') .url_parameter('applicationId', application_id) .url_parameter('start', start) .url_parameter('end', _end) .get() .go() end |
#retrieve_reindex_status ⇒ FusionAuth::ClientResponse
Retrieve the status of a re-index process. A status code of 200 indicates the re-index is in progress, a status code of
404 indicates no re-index is in progress.
2993 2994 2995 2996 2997 |
# File 'lib/fusionauth/fusionauth_client.rb', line 2993 def retrieve_reindex_status() start.uri('/api/system/reindex') .get() .go() end |
#retrieve_system_configuration ⇒ FusionAuth::ClientResponse
Retrieves the system configuration.
3003 3004 3005 3006 3007 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3003 def retrieve_system_configuration() start.uri('/api/system-configuration') .get() .go() end |
#retrieve_tenant(tenant_id) ⇒ FusionAuth::ClientResponse
Retrieves the tenant for the given Id.
3014 3015 3016 3017 3018 3019 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3014 def retrieve_tenant(tenant_id) start.uri('/api/tenant') .url_segment(tenant_id) .get() .go() end |
#retrieve_tenants ⇒ FusionAuth::ClientResponse
Retrieves all the tenants.
3025 3026 3027 3028 3029 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3025 def retrieve_tenants() start.uri('/api/tenant') .get() .go() end |
#retrieve_theme(theme_id) ⇒ FusionAuth::ClientResponse
Retrieves the theme for the given Id.
3036 3037 3038 3039 3040 3041 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3036 def retrieve_theme(theme_id) start.uri('/api/theme') .url_segment(theme_id) .get() .go() end |
#retrieve_themes ⇒ FusionAuth::ClientResponse
Retrieves all the themes.
3047 3048 3049 3050 3051 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3047 def retrieve_themes() start.uri('/api/theme') .get() .go() end |
#retrieve_total_report ⇒ FusionAuth::ClientResponse
Retrieves the totals report. This contains all the total counts for each application and the global registration count.
3058 3059 3060 3061 3062 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3058 def retrieve_total_report() start.uri('/api/report/totals') .get() .go() end |
#retrieve_two_factor_recovery_codes(user_id) ⇒ FusionAuth::ClientResponse
Retrieve two-factor recovery codes for a user.
3069 3070 3071 3072 3073 3074 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3069 def retrieve_two_factor_recovery_codes(user_id) start.uri('/api/user/two-factor/recovery-code') .url_segment(user_id) .get() .go() end |
#retrieve_two_factor_status(user_id, application_id, two_factor_trust_id) ⇒ FusionAuth::ClientResponse
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.
3086 3087 3088 3089 3090 3091 3092 3093 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3086 def retrieve_two_factor_status(user_id, application_id, two_factor_trust_id) start.uri('/api/two-factor/status') .url_parameter('userId', user_id) .url_parameter('applicationId', application_id) .url_segment(two_factor_trust_id) .get() .go() end |
#retrieve_user(user_id) ⇒ FusionAuth::ClientResponse
Retrieves the user for the given Id.
3100 3101 3102 3103 3104 3105 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3100 def retrieve_user(user_id) start.uri('/api/user') .url_segment(user_id) .get() .go() end |
#retrieve_user_action(user_action_id) ⇒ FusionAuth::ClientResponse
Retrieves the user action for the given Id. If you pass in null for the id, this will return all the user actions.
3113 3114 3115 3116 3117 3118 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3113 def retrieve_user_action(user_action_id) start.uri('/api/user-action') .url_segment(user_action_id) .get() .go() end |
#retrieve_user_action_reason(user_action_reason_id) ⇒ FusionAuth::ClientResponse
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.
3126 3127 3128 3129 3130 3131 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3126 def retrieve_user_action_reason(user_action_reason_id) start.uri('/api/user-action-reason') .url_segment(user_action_reason_id) .get() .go() end |
#retrieve_user_action_reasons ⇒ FusionAuth::ClientResponse
Retrieves all the user action reasons.
3137 3138 3139 3140 3141 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3137 def retrieve_user_action_reasons() start.uri('/api/user-action-reason') .get() .go() end |
#retrieve_user_actions ⇒ FusionAuth::ClientResponse
Retrieves all the user actions.
3147 3148 3149 3150 3151 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3147 def retrieve_user_actions() start.uri('/api/user-action') .get() .go() end |
#retrieve_user_by_change_password_id(change_password_id) ⇒ FusionAuth::ClientResponse
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.
3159 3160 3161 3162 3163 3164 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3159 def retrieve_user_by_change_password_id(change_password_id) start.uri('/api/user') .url_parameter('changePasswordId', change_password_id) .get() .go() end |
#retrieve_user_by_email(email) ⇒ FusionAuth::ClientResponse
Retrieves the user for the given email.
3171 3172 3173 3174 3175 3176 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3171 def retrieve_user_by_email(email) start.uri('/api/user') .url_parameter('email', email) .get() .go() end |
#retrieve_user_by_login_id(login_id) ⇒ FusionAuth::ClientResponse
Retrieves the user for the loginId. The loginId can be either the username or the email.
3183 3184 3185 3186 3187 3188 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3183 def retrieve_user_by_login_id(login_id) start.uri('/api/user') .url_parameter('loginId', login_id) .get() .go() end |
#retrieve_user_by_username(username) ⇒ FusionAuth::ClientResponse
Retrieves the user for the given username.
3195 3196 3197 3198 3199 3200 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3195 def retrieve_user_by_username(username) start.uri('/api/user') .url_parameter('username', username) .get() .go() end |
#retrieve_user_by_verification_id(verification_id) ⇒ FusionAuth::ClientResponse
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.
3208 3209 3210 3211 3212 3213 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3208 def retrieve_user_by_verification_id(verification_id) start.uri('/api/user') .url_parameter('verificationId', verification_id) .get() .go() end |
#retrieve_user_code(client_id, client_secret, user_code) ⇒ FusionAuth::ClientResponse
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.
3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3224 def retrieve_user_code(client_id, client_secret, user_code) body = { "client_id" => client_id, "client_secret" => client_secret, "user_code" => user_code } startAnonymous.uri('/oauth2/device/user-code') .body_handler(FusionAuth::FormDataBodyHandler.new(body)) .get() .go() end |
#retrieve_user_code_using_api_key(user_code) ⇒ FusionAuth::ClientResponse
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.
3245 3246 3247 3248 3249 3250 3251 3252 3253 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3245 def retrieve_user_code_using_api_key(user_code) body = { "user_code" => user_code } startAnonymous.uri('/oauth2/device/user-code') .body_handler(FusionAuth::FormDataBodyHandler.new(body)) .get() .go() end |
#retrieve_user_comments(user_id) ⇒ FusionAuth::ClientResponse
Retrieves all the comments for the user with the given Id.
3260 3261 3262 3263 3264 3265 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3260 def retrieve_user_comments(user_id) start.uri('/api/user/comment') .url_segment(user_id) .get() .go() end |
#retrieve_user_consent(user_consent_id) ⇒ FusionAuth::ClientResponse
Retrieve a single User consent by Id.
3272 3273 3274 3275 3276 3277 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3272 def () start.uri('/api/user/consent') .url_segment() .get() .go() end |
#retrieve_user_consents(user_id) ⇒ FusionAuth::ClientResponse
Retrieves all the consents for a User.
3284 3285 3286 3287 3288 3289 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3284 def (user_id) start.uri('/api/user/consent') .url_parameter('userId', user_id) .get() .go() end |
#retrieve_user_info_from_access_token(encoded_jwt) ⇒ FusionAuth::ClientResponse
Call the UserInfo endpoint to retrieve User Claims from the access token issued by FusionAuth.
3296 3297 3298 3299 3300 3301 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3296 def retrieve_user_info_from_access_token(encoded_jwt) startAnonymous.uri('/oauth2/userinfo') .('Bearer ' + encoded_jwt) .get() .go() end |
#retrieve_user_link(identity_provider_id, identity_provider_user_id, user_id) ⇒ FusionAuth::ClientResponse
Retrieve a single Identity Provider user (link).
3310 3311 3312 3313 3314 3315 3316 3317 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3310 def retrieve_user_link(identity_provider_id, identity_provider_user_id, user_id) start.uri('/api/identity-provider/link') .url_parameter('identityProviderId', identity_provider_id) .url_parameter('identityProviderUserId', identity_provider_user_id) .url_parameter('userId', user_id) .get() .go() end |
#retrieve_user_links_by_user_id(identity_provider_id, user_id) ⇒ FusionAuth::ClientResponse
Retrieve all Identity Provider users (links) for the user. Specify the optional identityProviderId to retrieve links for a particular IdP.
3325 3326 3327 3328 3329 3330 3331 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3325 def retrieve_user_links_by_user_id(identity_provider_id, user_id) start.uri('/api/identity-provider/link') .url_parameter('identityProviderId', identity_provider_id) .url_parameter('userId', user_id) .get() .go() end |
#retrieve_user_login_report(application_id, user_id, start, _end) ⇒ FusionAuth::ClientResponse
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.
3342 3343 3344 3345 3346 3347 3348 3349 3350 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3342 def retrieve_user_login_report(application_id, user_id, start, _end) start.uri('/api/report/login') .url_parameter('applicationId', application_id) .url_parameter('userId', user_id) .url_parameter('start', start) .url_parameter('end', _end) .get() .go() end |
#retrieve_user_login_report_by_login_id(application_id, login_id, start, _end) ⇒ FusionAuth::ClientResponse
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.
3361 3362 3363 3364 3365 3366 3367 3368 3369 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3361 def retrieve_user_login_report_by_login_id(application_id, login_id, start, _end) start.uri('/api/report/login') .url_parameter('applicationId', application_id) .url_parameter('loginId', login_id) .url_parameter('start', start) .url_parameter('end', _end) .get() .go() end |
#retrieve_user_recent_logins(user_id, offset, limit) ⇒ FusionAuth::ClientResponse
Retrieves the last number of login records for a user.
3378 3379 3380 3381 3382 3383 3384 3385 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3378 def retrieve_user_recent_logins(user_id, offset, limit) start.uri('/api/user/recent-login') .url_parameter('userId', user_id) .url_parameter('offset', offset) .url_parameter('limit', limit) .get() .go() end |
#retrieve_user_using_jwt(encoded_jwt) ⇒ FusionAuth::ClientResponse
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.
3392 3393 3394 3395 3396 3397 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3392 def retrieve_user_using_jwt(encoded_jwt) startAnonymous.uri('/api/user') .('Bearer ' + encoded_jwt) .get() .go() end |
#retrieve_version ⇒ FusionAuth::ClientResponse
Retrieves the FusionAuth version string.
3403 3404 3405 3406 3407 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3403 def retrieve_version() start.uri('/api/system/version') .get() .go() end |
#retrieve_web_authn_credential(id) ⇒ FusionAuth::ClientResponse
Retrieves the WebAuthn credential for the given Id.
3414 3415 3416 3417 3418 3419 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3414 def retrieve_web_authn_credential(id) start.uri('/api/webauthn') .url_segment(id) .get() .go() end |
#retrieve_web_authn_credentials_for_user(user_id) ⇒ FusionAuth::ClientResponse
Retrieves all WebAuthn credentials for the given user.
3426 3427 3428 3429 3430 3431 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3426 def retrieve_web_authn_credentials_for_user(user_id) start.uri('/api/webauthn') .url_parameter('userId', user_id) .get() .go() end |
#retrieve_webhook(webhook_id) ⇒ FusionAuth::ClientResponse
Retrieves the webhook for the given Id. If you pass in null for the id, this will return all the webhooks.
3438 3439 3440 3441 3442 3443 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3438 def retrieve_webhook(webhook_id) start.uri('/api/webhook') .url_segment(webhook_id) .get() .go() end |
#retrieve_webhooks ⇒ FusionAuth::ClientResponse
Retrieves all the webhooks.
3449 3450 3451 3452 3453 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3449 def retrieve_webhooks() start.uri('/api/webhook') .get() .go() end |
#revoke_refresh_token(token, user_id, application_id) ⇒ FusionAuth::ClientResponse
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
3485 3486 3487 3488 3489 3490 3491 3492 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3485 def revoke_refresh_token(token, user_id, application_id) start.uri('/api/jwt/refresh') .url_parameter('token', token) .url_parameter('userId', user_id) .url_parameter('applicationId', application_id) .delete() .go() end |
#revoke_refresh_token_by_id(token_id) ⇒ FusionAuth::ClientResponse
Revokes a single refresh token by the unique Id. The unique Id is not sensitive as it cannot be used to obtain another JWT.
3499 3500 3501 3502 3503 3504 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3499 def revoke_refresh_token_by_id(token_id) start.uri('/api/jwt/refresh') .url_segment(token_id) .delete() .go() end |
#revoke_refresh_token_by_token(token) ⇒ FusionAuth::ClientResponse
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.
3511 3512 3513 3514 3515 3516 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3511 def revoke_refresh_token_by_token(token) start.uri('/api/jwt/refresh') .url_parameter('token', token) .delete() .go() end |
#revoke_refresh_tokens_by_application_id(application_id) ⇒ FusionAuth::ClientResponse
Revoke all refresh tokens that belong to an application by applicationId.
3523 3524 3525 3526 3527 3528 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3523 def revoke_refresh_tokens_by_application_id(application_id) start.uri('/api/jwt/refresh') .url_parameter('applicationId', application_id) .delete() .go() end |
#revoke_refresh_tokens_by_user_id(user_id) ⇒ FusionAuth::ClientResponse
Revoke all refresh tokens that belong to a user by user Id.
3535 3536 3537 3538 3539 3540 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3535 def revoke_refresh_tokens_by_user_id(user_id) start.uri('/api/jwt/refresh') .url_parameter('userId', user_id) .delete() .go() end |
#revoke_refresh_tokens_by_user_id_for_application(user_id, application_id) ⇒ FusionAuth::ClientResponse
Revoke all refresh tokens that belong to a user by user Id for a specific application by applicationId.
3548 3549 3550 3551 3552 3553 3554 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3548 def revoke_refresh_tokens_by_user_id_for_application(user_id, application_id) start.uri('/api/jwt/refresh') .url_parameter('userId', user_id) .url_parameter('applicationId', application_id) .delete() .go() end |
#revoke_refresh_tokens_with_request(request) ⇒ FusionAuth::ClientResponse
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.
3562 3563 3564 3565 3566 3567 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3562 def revoke_refresh_tokens_with_request(request) start.uri('/api/jwt/refresh') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .delete() .go() end |
#revoke_user_consent(user_consent_id) ⇒ FusionAuth::ClientResponse
Revokes a single User consent by Id.
3574 3575 3576 3577 3578 3579 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3574 def () start.uri('/api/user/consent') .url_segment() .delete() .go() end |
#search_applications(request) ⇒ FusionAuth::ClientResponse
Searches applications with the specified criteria and pagination.
3586 3587 3588 3589 3590 3591 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3586 def search_applications(request) start.uri('/api/application/search') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#search_audit_logs(request) ⇒ FusionAuth::ClientResponse
Searches the audit logs with the specified criteria and pagination.
3598 3599 3600 3601 3602 3603 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3598 def search_audit_logs(request) start.uri('/api/system/audit-log/search') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#search_consents(request) ⇒ FusionAuth::ClientResponse
Searches consents with the specified criteria and pagination.
3610 3611 3612 3613 3614 3615 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3610 def (request) start.uri('/api/consent/search') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#search_email_templates(request) ⇒ FusionAuth::ClientResponse
Searches email templates with the specified criteria and pagination.
3622 3623 3624 3625 3626 3627 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3622 def search_email_templates(request) start.uri('/api/email/template/search') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#search_entities(request) ⇒ FusionAuth::ClientResponse
Searches entities with the specified criteria and pagination.
3634 3635 3636 3637 3638 3639 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3634 def search_entities(request) start.uri('/api/entity/search') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#search_entities_by_ids(ids) ⇒ FusionAuth::ClientResponse
Retrieves the entities for the given ids. If any Id is invalid, it is ignored.
3646 3647 3648 3649 3650 3651 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3646 def search_entities_by_ids(ids) start.uri('/api/entity/search') .url_parameter('ids', ids) .get() .go() end |
#search_entity_grants(request) ⇒ FusionAuth::ClientResponse
Searches Entity Grants with the specified criteria and pagination.
3658 3659 3660 3661 3662 3663 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3658 def search_entity_grants(request) start.uri('/api/entity/grant/search') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#search_entity_types(request) ⇒ FusionAuth::ClientResponse
Searches the entity types with the specified criteria and pagination.
3670 3671 3672 3673 3674 3675 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3670 def search_entity_types(request) start.uri('/api/entity/type/search') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#search_event_logs(request) ⇒ FusionAuth::ClientResponse
Searches the event logs with the specified criteria and pagination.
3682 3683 3684 3685 3686 3687 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3682 def search_event_logs(request) start.uri('/api/system/event-log/search') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#search_group_members(request) ⇒ FusionAuth::ClientResponse
Searches group members with the specified criteria and pagination.
3694 3695 3696 3697 3698 3699 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3694 def search_group_members(request) start.uri('/api/group/member/search') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#search_groups(request) ⇒ FusionAuth::ClientResponse
Searches groups with the specified criteria and pagination.
3706 3707 3708 3709 3710 3711 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3706 def search_groups(request) start.uri('/api/group/search') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#search_identity_providers(request) ⇒ FusionAuth::ClientResponse
Searches identity providers with the specified criteria and pagination.
3730 3731 3732 3733 3734 3735 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3730 def search_identity_providers(request) start.uri('/api/identity-provider/search') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#search_ip_access_control_lists(request) ⇒ FusionAuth::ClientResponse
Searches the IP Access Control Lists with the specified criteria and pagination.
3718 3719 3720 3721 3722 3723 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3718 def search_ip_access_control_lists(request) start.uri('/api/ip-acl/search') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#search_keys(request) ⇒ FusionAuth::ClientResponse
Searches keys with the specified criteria and pagination.
3742 3743 3744 3745 3746 3747 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3742 def search_keys(request) start.uri('/api/key/search') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#search_lambdas(request) ⇒ FusionAuth::ClientResponse
Searches lambdas with the specified criteria and pagination.
3754 3755 3756 3757 3758 3759 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3754 def search_lambdas(request) start.uri('/api/lambda/search') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#search_login_records(request) ⇒ FusionAuth::ClientResponse
Searches the login records with the specified criteria and pagination.
3766 3767 3768 3769 3770 3771 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3766 def search_login_records(request) start.uri('/api/system/login-record/search') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#search_tenants(request) ⇒ FusionAuth::ClientResponse
Searches tenants with the specified criteria and pagination.
3778 3779 3780 3781 3782 3783 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3778 def search_tenants(request) start.uri('/api/tenant/search') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#search_themes(request) ⇒ FusionAuth::ClientResponse
Searches themes with the specified criteria and pagination.
3790 3791 3792 3793 3794 3795 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3790 def search_themes(request) start.uri('/api/theme/search') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#search_user_comments(request) ⇒ FusionAuth::ClientResponse
Searches user comments with the specified criteria and pagination.
3802 3803 3804 3805 3806 3807 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3802 def search_user_comments(request) start.uri('/api/user/comment/search') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#search_users(ids) ⇒ FusionAuth::ClientResponse
This method has been renamed to search_users_by_ids, use that method instead.
Retrieves the users for the given ids. If any Id is invalid, it is ignored.
3815 3816 3817 3818 3819 3820 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3815 def search_users(ids) start.uri('/api/user/search') .url_parameter('ids', ids) .get() .go() end |
#search_users_by_ids(ids) ⇒ FusionAuth::ClientResponse
Retrieves the users for the given ids. If any Id is invalid, it is ignored.
3827 3828 3829 3830 3831 3832 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3827 def search_users_by_ids(ids) start.uri('/api/user/search') .url_parameter('ids', ids) .get() .go() end |
#search_users_by_query(request) ⇒ FusionAuth::ClientResponse
Retrieves the users for the given search criteria and pagination.
3840 3841 3842 3843 3844 3845 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3840 def search_users_by_query(request) start.uri('/api/user/search') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#search_users_by_query_string(request) ⇒ FusionAuth::ClientResponse
This method has been renamed to search_users_by_query, use that method instead.
Retrieves the users for the given search criteria and pagination.
3854 3855 3856 3857 3858 3859 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3854 def search_users_by_query_string(request) start.uri('/api/user/search') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#search_webhooks(request) ⇒ FusionAuth::ClientResponse
Searches webhooks with the specified criteria and pagination.
3866 3867 3868 3869 3870 3871 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3866 def search_webhooks(request) start.uri('/api/webhook/search') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#send_email(email_template_id, request) ⇒ FusionAuth::ClientResponse
Send an email using an email template id. You can optionally provide requestData
to access key value pairs in the email template.
3880 3881 3882 3883 3884 3885 3886 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3880 def send_email(email_template_id, request) start.uri('/api/email/send') .url_segment(email_template_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#send_family_request_email(request) ⇒ FusionAuth::ClientResponse
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.
3893 3894 3895 3896 3897 3898 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3893 def send_family_request_email(request) start.uri('/api/user/family/request') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#send_passwordless_code(request) ⇒ FusionAuth::ClientResponse
Send a passwordless authentication code in an email to complete login.
3905 3906 3907 3908 3909 3910 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3905 def send_passwordless_code(request) startAnonymous.uri('/api/passwordless/send') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#send_two_factor_code(request) ⇒ FusionAuth::ClientResponse
This method has been renamed to send_two_factor_code_for_enable_disable, use that method instead.
Send a Two Factor authentication code to assist in setting up Two Factor authentication or disabling.
3918 3919 3920 3921 3922 3923 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3918 def send_two_factor_code(request) start.uri('/api/two-factor/send') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#send_two_factor_code_for_enable_disable(request) ⇒ FusionAuth::ClientResponse
Send a Two Factor authentication code to assist in setting up Two Factor authentication or disabling.
3930 3931 3932 3933 3934 3935 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3930 def send_two_factor_code_for_enable_disable(request) start.uri('/api/two-factor/send') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#send_two_factor_code_for_login(two_factor_id) ⇒ FusionAuth::ClientResponse
This method has been renamed to send_two_factor_code_for_login_using_method, use that method instead.
Send a Two Factor authentication code to allow the completion of Two Factor authentication.
3943 3944 3945 3946 3947 3948 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3943 def send_two_factor_code_for_login(two_factor_id) startAnonymous.uri('/api/two-factor/send') .url_segment(two_factor_id) .post() .go() end |
#send_two_factor_code_for_login_using_method(two_factor_id, request) ⇒ FusionAuth::ClientResponse
Send a Two Factor authentication code to allow the completion of Two Factor authentication.
3956 3957 3958 3959 3960 3961 3962 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3956 def send_two_factor_code_for_login_using_method(two_factor_id, request) startAnonymous.uri('/api/two-factor/send') .url_segment(two_factor_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#set_tenant_id(tenant_id) ⇒ Object
40 41 42 |
# File 'lib/fusionauth/fusionauth_client.rb', line 40 def set_tenant_id(tenant_id) @tenant_id = tenant_id end |
#start_identity_provider_login(request) ⇒ FusionAuth::ClientResponse
Begins a login request for a 3rd party login that requires user interaction such as HYPR.
3970 3971 3972 3973 3974 3975 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3970 def start_identity_provider_login(request) start.uri('/api/identity-provider/start') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#start_passwordless_login(request) ⇒ FusionAuth::ClientResponse
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.
3983 3984 3985 3986 3987 3988 |
# File 'lib/fusionauth/fusionauth_client.rb', line 3983 def start_passwordless_login(request) start.uri('/api/passwordless/start') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#start_two_factor_login(request) ⇒ FusionAuth::ClientResponse
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).
4000 4001 4002 4003 4004 4005 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4000 def start_two_factor_login(request) start.uri('/api/two-factor/start') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#start_web_authn_login(request) ⇒ FusionAuth::ClientResponse
Start a WebAuthn authentication ceremony by generating a new challenge for the user
4012 4013 4014 4015 4016 4017 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4012 def start_web_authn_login(request) start.uri('/api/webauthn/start') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#start_web_authn_registration(request) ⇒ FusionAuth::ClientResponse
Start a WebAuthn registration ceremony by generating a new challenge for the user
4024 4025 4026 4027 4028 4029 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4024 def start_web_authn_registration(request) start.uri('/api/webauthn/register/start') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#two_factor_login(request) ⇒ FusionAuth::ClientResponse
Complete login using a 2FA challenge
4036 4037 4038 4039 4040 4041 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4036 def two_factor_login(request) startAnonymous.uri('/api/two-factor/login') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#update_api_key(api_key_id, request) ⇒ FusionAuth::ClientResponse
Updates an API key by given id
4049 4050 4051 4052 4053 4054 4055 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4049 def update_api_key(api_key_id, request) start.uri('/api/api-key') .url_segment(api_key_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .put() .go() end |
#update_application(application_id, request) ⇒ FusionAuth::ClientResponse
Updates the application with the given Id.
4063 4064 4065 4066 4067 4068 4069 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4063 def update_application(application_id, request) start.uri('/api/application') .url_segment(application_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .put() .go() end |
#update_application_role(application_id, role_id, request) ⇒ FusionAuth::ClientResponse
Updates the application role with the given Id for the application.
4078 4079 4080 4081 4082 4083 4084 4085 4086 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4078 def update_application_role(application_id, role_id, request) start.uri('/api/application') .url_segment(application_id) .url_segment("role") .url_segment(role_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .put() .go() end |
#update_connector(connector_id, request) ⇒ FusionAuth::ClientResponse
Updates the connector with the given Id.
4094 4095 4096 4097 4098 4099 4100 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4094 def update_connector(connector_id, request) start.uri('/api/connector') .url_segment(connector_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .put() .go() end |
#update_consent(consent_id, request) ⇒ FusionAuth::ClientResponse
Updates the consent with the given Id.
4108 4109 4110 4111 4112 4113 4114 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4108 def (, request) start.uri('/api/consent') .url_segment() .body_handler(FusionAuth::JSONBodyHandler.new(request)) .put() .go() end |
#update_email_template(email_template_id, request) ⇒ FusionAuth::ClientResponse
Updates the email template with the given Id.
4122 4123 4124 4125 4126 4127 4128 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4122 def update_email_template(email_template_id, request) start.uri('/api/email/template') .url_segment(email_template_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .put() .go() end |
#update_entity(entity_id, request) ⇒ FusionAuth::ClientResponse
Updates the Entity with the given Id.
4136 4137 4138 4139 4140 4141 4142 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4136 def update_entity(entity_id, request) start.uri('/api/entity') .url_segment(entity_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .put() .go() end |
#update_entity_type(entity_type_id, request) ⇒ FusionAuth::ClientResponse
Updates the Entity Type with the given Id.
4150 4151 4152 4153 4154 4155 4156 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4150 def update_entity_type(entity_type_id, request) start.uri('/api/entity/type') .url_segment(entity_type_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .put() .go() end |
#update_entity_type_permission(entity_type_id, permission_id, request) ⇒ FusionAuth::ClientResponse
Updates the permission with the given Id for the entity type.
4165 4166 4167 4168 4169 4170 4171 4172 4173 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4165 def (entity_type_id, , request) start.uri('/api/entity/type') .url_segment(entity_type_id) .url_segment("permission") .url_segment() .body_handler(FusionAuth::JSONBodyHandler.new(request)) .put() .go() end |
#update_form(form_id, request) ⇒ FusionAuth::ClientResponse
Updates the form with the given Id.
4181 4182 4183 4184 4185 4186 4187 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4181 def update_form(form_id, request) start.uri('/api/form') .url_segment(form_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .put() .go() end |
#update_form_field(field_id, request) ⇒ FusionAuth::ClientResponse
Updates the form field with the given Id.
4195 4196 4197 4198 4199 4200 4201 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4195 def update_form_field(field_id, request) start.uri('/api/form/field') .url_segment(field_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .put() .go() end |
#update_group(group_id, request) ⇒ FusionAuth::ClientResponse
Updates the group with the given Id.
4209 4210 4211 4212 4213 4214 4215 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4209 def update_group(group_id, request) start.uri('/api/group') .url_segment(group_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .put() .go() end |
#update_group_members(request) ⇒ FusionAuth::ClientResponse
Creates a member in a group.
4222 4223 4224 4225 4226 4227 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4222 def update_group_members(request) start.uri('/api/group/member') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .put() .go() end |
#update_identity_provider(identity_provider_id, request) ⇒ FusionAuth::ClientResponse
Updates the identity provider with the given Id.
4249 4250 4251 4252 4253 4254 4255 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4249 def update_identity_provider(identity_provider_id, request) start.uri('/api/identity-provider') .url_segment(identity_provider_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .put() .go() end |
#update_integrations(request) ⇒ FusionAuth::ClientResponse
Updates the available integrations.
4262 4263 4264 4265 4266 4267 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4262 def update_integrations(request) start.uri('/api/integration') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .put() .go() end |
#update_ip_access_control_list(access_control_list_id, request) ⇒ FusionAuth::ClientResponse
Updates the IP Access Control List with the given Id.
4235 4236 4237 4238 4239 4240 4241 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4235 def update_ip_access_control_list(access_control_list_id, request) start.uri('/api/ip-acl') .url_segment(access_control_list_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .put() .go() end |
#update_key(key_id, request) ⇒ FusionAuth::ClientResponse
Updates the key with the given Id.
4275 4276 4277 4278 4279 4280 4281 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4275 def update_key(key_id, request) start.uri('/api/key') .url_segment(key_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .put() .go() end |
#update_lambda(lambda_id, request) ⇒ FusionAuth::ClientResponse
Updates the lambda with the given Id.
4289 4290 4291 4292 4293 4294 4295 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4289 def update_lambda(lambda_id, request) start.uri('/api/lambda') .url_segment(lambda_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .put() .go() end |
#update_message_template(message_template_id, request) ⇒ FusionAuth::ClientResponse
Updates the message template with the given Id.
4303 4304 4305 4306 4307 4308 4309 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4303 def (, request) start.uri('/api/message/template') .url_segment() .body_handler(FusionAuth::JSONBodyHandler.new(request)) .put() .go() end |
#update_messenger(messenger_id, request) ⇒ FusionAuth::ClientResponse
Updates the messenger with the given Id.
4317 4318 4319 4320 4321 4322 4323 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4317 def update_messenger(messenger_id, request) start.uri('/api/messenger') .url_segment(messenger_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .put() .go() end |
#update_registration(user_id, request) ⇒ FusionAuth::ClientResponse
Updates the registration for the user with the given Id and the application defined in the request.
4331 4332 4333 4334 4335 4336 4337 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4331 def update_registration(user_id, request) start.uri('/api/user/registration') .url_segment(user_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .put() .go() end |
#update_system_configuration(request) ⇒ FusionAuth::ClientResponse
Updates the system configuration.
4344 4345 4346 4347 4348 4349 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4344 def update_system_configuration(request) start.uri('/api/system-configuration') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .put() .go() end |
#update_tenant(tenant_id, request) ⇒ FusionAuth::ClientResponse
Updates the tenant with the given Id.
4357 4358 4359 4360 4361 4362 4363 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4357 def update_tenant(tenant_id, request) start.uri('/api/tenant') .url_segment(tenant_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .put() .go() end |
#update_theme(theme_id, request) ⇒ FusionAuth::ClientResponse
Updates the theme with the given Id.
4371 4372 4373 4374 4375 4376 4377 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4371 def update_theme(theme_id, request) start.uri('/api/theme') .url_segment(theme_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .put() .go() end |
#update_user(user_id, request) ⇒ FusionAuth::ClientResponse
Updates the user with the given Id.
4385 4386 4387 4388 4389 4390 4391 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4385 def update_user(user_id, request) start.uri('/api/user') .url_segment(user_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .put() .go() end |
#update_user_action(user_action_id, request) ⇒ FusionAuth::ClientResponse
Updates the user action with the given Id.
4399 4400 4401 4402 4403 4404 4405 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4399 def update_user_action(user_action_id, request) start.uri('/api/user-action') .url_segment(user_action_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .put() .go() end |
#update_user_action_reason(user_action_reason_id, request) ⇒ FusionAuth::ClientResponse
Updates the user action reason with the given Id.
4413 4414 4415 4416 4417 4418 4419 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4413 def update_user_action_reason(user_action_reason_id, request) start.uri('/api/user-action-reason') .url_segment(user_action_reason_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .put() .go() end |
#update_user_consent(user_consent_id, request) ⇒ FusionAuth::ClientResponse
Updates a single User consent by Id.
4427 4428 4429 4430 4431 4432 4433 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4427 def (, request) start.uri('/api/user/consent') .url_segment() .body_handler(FusionAuth::JSONBodyHandler.new(request)) .put() .go() end |
#update_webhook(webhook_id, request) ⇒ FusionAuth::ClientResponse
Updates the webhook with the given Id.
4441 4442 4443 4444 4445 4446 4447 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4441 def update_webhook(webhook_id, request) start.uri('/api/webhook') .url_segment(webhook_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) .put() .go() end |
#upsert_entity_grant(entity_id, request) ⇒ FusionAuth::ClientResponse
Creates or updates an Entity Grant. This is when a User/Entity is granted permissions to an Entity.
4455 4456 4457 4458 4459 4460 4461 4462 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4455 def upsert_entity_grant(entity_id, request) start.uri('/api/entity') .url_segment(entity_id) .url_segment("grant") .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#validate_device(user_code, client_id) ⇒ FusionAuth::ClientResponse
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.
4471 4472 4473 4474 4475 4476 4477 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4471 def validate_device(user_code, client_id) startAnonymous.uri('/oauth2/device/validate') .url_parameter('user_code', user_code) .url_parameter('client_id', client_id) .get() .go() end |
#validate_jwt(encoded_jwt) ⇒ FusionAuth::ClientResponse
Validates the provided JWT (encoded JWT string) to ensure the token is valid. A valid access token is properly signed and not expired. <p> This API may be used to verify the JWT as well as decode the encoded JWT into human readable identity claims.
4487 4488 4489 4490 4491 4492 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4487 def validate_jwt(encoded_jwt) startAnonymous.uri('/api/jwt/validate') .('Bearer ' + encoded_jwt) .get() .go() end |
#vend_jwt(request) ⇒ FusionAuth::ClientResponse
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. <p> 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.
4507 4508 4509 4510 4511 4512 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4507 def vend_jwt(request) start.uri('/api/jwt/vend') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#verify_email(verification_id) ⇒ FusionAuth::ClientResponse
This method has been renamed to verify_email_address and changed to take a JSON request body, use that method instead.
Confirms a email verification. The Id given is usually from an email sent to the user.
4520 4521 4522 4523 4524 4525 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4520 def verify_email(verification_id) startAnonymous.uri('/api/user/verify-email') .url_segment(verification_id) .post() .go() end |
#verify_email_address(request) ⇒ FusionAuth::ClientResponse
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.
4537 4538 4539 4540 4541 4542 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4537 def verify_email_address(request) startAnonymous.uri('/api/user/verify-email') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#verify_email_address_by_user_id(request) ⇒ FusionAuth::ClientResponse
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.
4551 4552 4553 4554 4555 4556 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4551 def verify_email_address_by_user_id(request) start.uri('/api/user/verify-email') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |
#verify_registration(verification_id) ⇒ FusionAuth::ClientResponse
This method has been renamed to verify_user_registration and changed to take a JSON request body, use that method instead.
Confirms an application registration. The Id given is usually from an email sent to the user.
4564 4565 4566 4567 4568 4569 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4564 def verify_registration(verification_id) startAnonymous.uri('/api/user/verify-registration') .url_segment(verification_id) .post() .go() end |
#verify_user_registration(request) ⇒ FusionAuth::ClientResponse
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.
4581 4582 4583 4584 4585 4586 |
# File 'lib/fusionauth/fusionauth_client.rb', line 4581 def verify_user_registration(request) startAnonymous.uri('/api/user/verify-registration') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() .go() end |