lib/fusionauth/fusionauth_client.rb in fusionauth_client-1.31.0 vs lib/fusionauth/fusionauth_client.rb in fusionauth_client-1.32.0

- old
+ new

@@ -69,11 +69,11 @@ # # Adds a user to an existing family. The family id must be specified. # # @param family_id [string] The id of the family. - # @param request [OpenStruct, Hash] The request object that contains all of the information used to determine which user to add to the family. + # @param request [OpenStruct, Hash] The request object that contains all the information used to determine which user to add to the family. # @return [FusionAuth::ClientResponse] The ClientResponse object. def add_user_to_family(family_id, request) start.uri('/api/user/family') .url_segment(family_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) @@ -125,11 +125,11 @@ end # # Adds a comment to the user's account. # - # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the user comment. + # @param request [OpenStruct, Hash] The request object that contains all the information used to create the user comment. # @return [FusionAuth::ClientResponse] The ClientResponse object. def comment_on_user(request) start.uri('/api/user/comment') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() @@ -156,11 +156,11 @@ # # Creates an application. You can optionally specify an Id for the application, if not provided one will be generated. # # @param application_id [string] (Optional) The Id to use for the application. If not provided a secure random UUID will be generated. - # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the application. + # @param request [OpenStruct, Hash] The request object that contains all the information used to create the application. # @return [FusionAuth::ClientResponse] The ClientResponse object. def create_application(application_id, request) start.uri('/api/application') .url_segment(application_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) @@ -172,11 +172,11 @@ # 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. # # @param application_id [string] The Id of the application to create the role on. # @param role_id [string] (Optional) The Id of the role. If not provided a secure random UUID will be generated. - # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the application role. + # @param request [OpenStruct, Hash] The request object that contains all the information used to create the application role. # @return [FusionAuth::ClientResponse] The ClientResponse object. def create_application_role(application_id, role_id, request) start.uri('/api/application') .url_segment(application_id) .url_segment("role") @@ -189,11 +189,11 @@ # # 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. # - # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the audit log entry. + # @param request [OpenStruct, Hash] The request object that contains all the information used to create the audit log entry. # @return [FusionAuth::ClientResponse] The ClientResponse object. def create_audit_log(request) start.uri('/api/system/audit-log') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() @@ -202,11 +202,11 @@ # # Creates a connector. You can optionally specify an Id for the connector, if not provided one will be generated. # # @param connector_id [string] (Optional) The Id for the connector. If not provided a secure random UUID will be generated. - # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the connector. + # @param request [OpenStruct, Hash] The request object that contains all the information used to create the connector. # @return [FusionAuth::ClientResponse] The ClientResponse object. def create_connector(connector_id, request) start.uri('/api/connector') .url_segment(connector_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) @@ -216,11 +216,11 @@ # # Creates a user consent type. You can optionally specify an Id for the consent type, if not provided one will be generated. # # @param consent_id [string] (Optional) The Id for the consent. If not provided a secure random UUID will be generated. - # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the consent. + # @param request [OpenStruct, Hash] The request object that contains all the information used to create the consent. # @return [FusionAuth::ClientResponse] The ClientResponse object. def create_consent(consent_id, request) start.uri('/api/consent') .url_segment(consent_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) @@ -230,11 +230,11 @@ # # Creates an email template. You can optionally specify an Id for the template, if not provided one will be generated. # # @param email_template_id [string] (Optional) The Id for the template. If not provided a secure random UUID will be generated. - # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the email template. + # @param request [OpenStruct, Hash] The request object that contains all the information used to create the email template. # @return [FusionAuth::ClientResponse] The ClientResponse object. def create_email_template(email_template_id, request) start.uri('/api/email/template') .url_segment(email_template_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) @@ -244,11 +244,11 @@ # # Creates an Entity. You can optionally specify an Id for the Entity. If not provided one will be generated. # # @param entity_id [string] (Optional) The Id for the Entity. If not provided a secure random UUID will be generated. - # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the Entity. + # @param request [OpenStruct, Hash] The request object that contains all the information used to create the Entity. # @return [FusionAuth::ClientResponse] The ClientResponse object. def create_entity(entity_id, request) start.uri('/api/entity') .url_segment(entity_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) @@ -258,11 +258,11 @@ # # Creates a Entity Type. You can optionally specify an Id for the Entity Type, if not provided one will be generated. # # @param entity_type_id [string] (Optional) The Id for the Entity Type. If not provided a secure random UUID will be generated. - # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the Entity Type. + # @param request [OpenStruct, Hash] The request object that contains all the information used to create the Entity Type. # @return [FusionAuth::ClientResponse] The ClientResponse object. def create_entity_type(entity_type_id, request) start.uri('/api/entity/type') .url_segment(entity_type_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) @@ -274,11 +274,11 @@ # 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. # # @param entity_type_id [string] The Id of the entity type to create the permission on. # @param permission_id [string] (Optional) The Id of the permission. If not provided a secure random UUID will be generated. - # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the permission. + # @param request [OpenStruct, Hash] The request object that contains all the information used to create the permission. # @return [FusionAuth::ClientResponse] The ClientResponse object. def create_entity_type_permission(entity_type_id, permission_id, request) start.uri('/api/entity/type') .url_segment(entity_type_id) .url_segment("permission") @@ -291,11 +291,11 @@ # # 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. # # @param family_id [string] (Optional) The id for the family. If not provided a secure random UUID will be generated. - # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the family. + # @param request [OpenStruct, Hash] The request object that contains all the information used to create the family. # @return [FusionAuth::ClientResponse] The ClientResponse object. def create_family(family_id, request) start.uri('/api/user/family') .url_segment(family_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) @@ -305,11 +305,11 @@ # # Creates a form. You can optionally specify an Id for the form, if not provided one will be generated. # # @param form_id [string] (Optional) The Id for the form. If not provided a secure random UUID will be generated. - # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the form. + # @param request [OpenStruct, Hash] The request object that contains all the information used to create the form. # @return [FusionAuth::ClientResponse] The ClientResponse object. def create_form(form_id, request) start.uri('/api/form') .url_segment(form_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) @@ -319,11 +319,11 @@ # # Creates a form field. You can optionally specify an Id for the form, if not provided one will be generated. # # @param field_id [string] (Optional) The Id for the form field. If not provided a secure random UUID will be generated. - # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the form field. + # @param request [OpenStruct, Hash] The request object that contains all the information used to create the form field. # @return [FusionAuth::ClientResponse] The ClientResponse object. def create_form_field(field_id, request) start.uri('/api/form/field') .url_segment(field_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) @@ -333,11 +333,11 @@ # # Creates a group. You can optionally specify an Id for the group, if not provided one will be generated. # # @param group_id [string] (Optional) The Id for the group. If not provided a secure random UUID will be generated. - # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the group. + # @param request [OpenStruct, Hash] The request object that contains all the information used to create the group. # @return [FusionAuth::ClientResponse] The ClientResponse object. def create_group(group_id, request) start.uri('/api/group') .url_segment(group_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) @@ -346,11 +346,11 @@ end # # Creates a member in a group. # - # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the group member(s). + # @param request [OpenStruct, Hash] The request object that contains all the information used to create the group member(s). # @return [FusionAuth::ClientResponse] The ClientResponse object. def create_group_members(request) start.uri('/api/group/member') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() @@ -359,11 +359,11 @@ # # 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. # # @param access_control_list_id [string] (Optional) The Id for the IP Access Control List. If not provided a secure random UUID will be generated. - # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the IP Access Control List. + # @param request [OpenStruct, Hash] The request object that contains all the information used to create the IP Access Control List. # @return [FusionAuth::ClientResponse] The ClientResponse object. 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)) @@ -373,11 +373,11 @@ # # Creates an identity provider. You can optionally specify an Id for the identity provider, if not provided one will be generated. # # @param identity_provider_id [string] (Optional) The Id of the identity provider. If not provided a secure random UUID will be generated. - # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the identity provider. + # @param request [OpenStruct, Hash] The request object that contains all the information used to create the identity provider. # @return [FusionAuth::ClientResponse] The ClientResponse object. def create_identity_provider(identity_provider_id, request) start.uri('/api/identity-provider') .url_segment(identity_provider_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) @@ -387,11 +387,11 @@ # # Creates a Lambda. You can optionally specify an Id for the lambda, if not provided one will be generated. # # @param lambda_id [string] (Optional) The Id for the lambda. If not provided a secure random UUID will be generated. - # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the lambda. + # @param request [OpenStruct, Hash] The request object that contains all the information used to create the lambda. # @return [FusionAuth::ClientResponse] The ClientResponse object. def create_lambda(lambda_id, request) start.uri('/api/lambda') .url_segment(lambda_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) @@ -401,11 +401,11 @@ # # Creates an message template. You can optionally specify an Id for the template, if not provided one will be generated. # # @param message_template_id [string] (Optional) The Id for the template. If not provided a secure random UUID will be generated. - # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the message template. + # @param request [OpenStruct, Hash] The request object that contains all the information used to create the message template. # @return [FusionAuth::ClientResponse] The ClientResponse object. def create_message_template(message_template_id, request) start.uri('/api/message/template') .url_segment(message_template_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) @@ -415,11 +415,11 @@ # # Creates a messenger. You can optionally specify an Id for the messenger, if not provided one will be generated. # # @param messenger_id [string] (Optional) The Id for the messenger. If not provided a secure random UUID will be generated. - # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the messenger. + # @param request [OpenStruct, Hash] The request object that contains all the information used to create the messenger. # @return [FusionAuth::ClientResponse] The ClientResponse object. def create_messenger(messenger_id, request) start.uri('/api/messenger') .url_segment(messenger_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) @@ -429,11 +429,11 @@ # # Creates a tenant. You can optionally specify an Id for the tenant, if not provided one will be generated. # # @param tenant_id [string] (Optional) The Id for the tenant. If not provided a secure random UUID will be generated. - # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the tenant. + # @param request [OpenStruct, Hash] The request object that contains all the information used to create the tenant. # @return [FusionAuth::ClientResponse] The ClientResponse object. def create_tenant(tenant_id, request) start.uri('/api/tenant') .url_segment(tenant_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) @@ -443,11 +443,11 @@ # # Creates a Theme. You can optionally specify an Id for the theme, if not provided one will be generated. # # @param theme_id [string] (Optional) The Id for the theme. If not provided a secure random UUID will be generated. - # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the theme. + # @param request [OpenStruct, Hash] The request object that contains all the information used to create the theme. # @return [FusionAuth::ClientResponse] The ClientResponse object. def create_theme(theme_id, request) start.uri('/api/theme') .url_segment(theme_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) @@ -457,11 +457,11 @@ # # Creates a user. You can optionally specify an Id for the user, if not provided one will be generated. # # @param user_id [string] (Optional) The Id for the user. If not provided a secure random UUID will be generated. - # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the user. + # @param request [OpenStruct, Hash] The request object that contains all the information used to create the user. # @return [FusionAuth::ClientResponse] The ClientResponse object. def create_user(user_id, request) start.uri('/api/user') .url_segment(user_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) @@ -472,11 +472,11 @@ # # 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. # # @param user_action_id [string] (Optional) The Id for the user action. If not provided a secure random UUID will be generated. - # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the user action. + # @param request [OpenStruct, Hash] The request object that contains all the information used to create the user action. # @return [FusionAuth::ClientResponse] The ClientResponse object. def create_user_action(user_action_id, request) start.uri('/api/user-action') .url_segment(user_action_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) @@ -487,11 +487,11 @@ # # 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. # # @param user_action_reason_id [string] (Optional) The Id for the user action reason. If not provided a secure random UUID will be generated. - # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the user action reason. + # @param request [OpenStruct, Hash] The request object that contains all the information used to create the user action reason. # @return [FusionAuth::ClientResponse] The ClientResponse object. 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)) @@ -514,11 +514,11 @@ end # # Link an external user from a 3rd party identity provider to a FusionAuth user. # - # @param request [OpenStruct, Hash] The request object that contains all of the information used to link the FusionAuth user. + # @param request [OpenStruct, Hash] The request object that contains all the information used to link the FusionAuth user. # @return [FusionAuth::ClientResponse] The ClientResponse object. def create_user_link(request) start.uri('/api/identity-provider/link') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() @@ -527,11 +527,11 @@ # # Creates a webhook. You can optionally specify an Id for the webhook, if not provided one will be generated. # # @param webhook_id [string] (Optional) The Id for the webhook. If not provided a secure random UUID will be generated. - # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the webhook. + # @param request [OpenStruct, Hash] The request object that contains all the information used to create the webhook. # @return [FusionAuth::ClientResponse] The ClientResponse object. def create_webhook(webhook_id, request) start.uri('/api/webhook') .url_segment(webhook_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) @@ -931,11 +931,11 @@ # # 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). # # @param tenant_id [string] The Id of the tenant to delete. - # @param request [OpenStruct, Hash] The request object that contains all of the information used to delete the user. + # @param request [OpenStruct, Hash] The request object that contains all the information used to delete the user. # @return [FusionAuth::ClientResponse] The ClientResponse object. def delete_tenant_with_request(tenant_id, request) start.uri('/api/tenant') .url_segment(tenant_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) @@ -1014,11 +1014,11 @@ # # 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. # # @param user_id [string] The Id of the user to delete (required). - # @param request [OpenStruct, Hash] The request object that contains all of the information used to delete the user. + # @param request [OpenStruct, Hash] The request object that contains all the information used to delete the user. # @return [FusionAuth::ClientResponse] The ClientResponse object. def delete_user_with_request(user_id, request) start.uri('/api/user') .url_segment(user_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) @@ -1255,11 +1255,11 @@ # # Generate a new RSA or EC key pair or an HMAC secret. # # @param key_id [string] (Optional) The Id for the key. If not provided a secure random UUID will be generated. - # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the key. + # @param request [OpenStruct, Hash] The request object that contains all the information used to create the key. # @return [FusionAuth::ClientResponse] The ClientResponse object. def generate_key(key_id, request) start.uri('/api/key/generate') .url_segment(key_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) @@ -1337,11 +1337,11 @@ # # Import an existing RSA or EC key pair or an HMAC secret. # # @param key_id [string] (Optional) The Id for the key. If not provided a secure random UUID will be generated. - # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the key. + # @param request [OpenStruct, Hash] The request object that contains all the information used to create the key. # @return [FusionAuth::ClientResponse] The ClientResponse object. def import_key(key_id, request) start.uri('/api/key/import') .url_segment(key_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) @@ -1480,11 +1480,11 @@ # # 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. # - # @param request [OpenStruct, Hash] The request object that contains all of the information used to logout the user. + # @param request [OpenStruct, Hash] The request object that contains all the information used to logout the user. # @return [FusionAuth::ClientResponse] The ClientResponse object. def logout_with_request(request) startAnonymous.uri('/api/logout') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() @@ -3481,11 +3481,11 @@ end # # Send a Two Factor authentication code to assist in setting up Two Factor authentication or disabling. # - # @param request [OpenStruct, Hash] The request object that contains all of the information used to send the code. + # @param request [OpenStruct, Hash] The request object that contains all the information used to send the code. # @return [FusionAuth::ClientResponse] The ClientResponse object. # @deprecated This method has been renamed to send_two_factor_code_for_enable_disable, use that method instead. def send_two_factor_code(request) start.uri('/api/two-factor/send') .body_handler(FusionAuth::JSONBodyHandler.new(request)) @@ -3494,11 +3494,11 @@ end # # Send a Two Factor authentication code to assist in setting up Two Factor authentication or disabling. # - # @param request [OpenStruct, Hash] The request object that contains all of the information used to send the code. + # @param request [OpenStruct, Hash] The request object that contains all the information used to send the code. # @return [FusionAuth::ClientResponse] The ClientResponse object. def send_two_factor_code_for_enable_disable(request) start.uri('/api/two-factor/send') .body_handler(FusionAuth::JSONBodyHandler.new(request)) .post() @@ -3589,11 +3589,11 @@ # # Updates an API key by given id # # @param api_key_id [string] The Id of the API key to update. - # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the API Key. + # @param request [OpenStruct, Hash] The request object that contains all the information used to create the API Key. # @return [FusionAuth::ClientResponse] The ClientResponse object. def update_api_key(api_key_id, request) start.uri('/api/api-key') .url_segment(api_key_id) .body_handler(FusionAuth::JSONBodyHandler.new(request)) @@ -3983,10 +3983,10 @@ # # Creates or updates an Entity Grant. This is when a User/Entity is granted permissions to an Entity. # # @param entity_id [string] The Id of the Entity that the User/Entity is being granted access to. - # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the Entity Grant. + # @param request [OpenStruct, Hash] The request object that contains all the information used to create the Entity Grant. # @return [FusionAuth::ClientResponse] The ClientResponse object. def upsert_entity_grant(entity_id, request) start.uri('/api/entity') .url_segment(entity_id) .url_segment("grant")