fusionauth_client 1.49.1 → 1.50.0

data/doc/FusionAuth/FusionAuthClient.md

@@ -17,40 +17,45 @@ noinspection RubyInstanceMethodNamingConvention,RubyTooManyMethodsInspection,Rub
  ### action_user(request) [](#method-i-action_user)
  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.
 
-@param request [OpenStruct, Hash] The action request that includes all of the information about the action being taken including
+@param request [OpenStruct, Hash] The action request that includes all the information about the action being taken including
 
 ```
-the id of the action, any options and the duration (if applicable).
+the Id of the action, any options and the duration (if applicable).
 ```
 
 @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### activate_reactor(request) [](#method-i-activate_reactor)
- Activates the [`FusionAuth`](../FusionAuth.html) Reactor using a license id and optionally a license text (for air-gapped deployments)
+ Activates the [`FusionAuth`](../FusionAuth.html) Reactor using a license Id and optionally a license text (for air-gapped deployments)
 
 @param request [OpenStruct, Hash] An optional request that contains the license text to activate Reactor (useful for air-gap deployments of [`FusionAuth`](../FusionAuth.html)). @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### add_user_to_family(family_id, request) [](#method-i-add_user_to_family)
- Adds a user to an existing family. The family id must be specified.
+ 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 the information used to determine which user to add to the family. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param family\_id [string] The Id of 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.
+
+ ### approve_device(client_id, client_secret, token, user_code) [](#method-i-approve_device)
+ Approve a device grant.
+
+@param client\_id [string] (Optional) The unique client identifier. The client Id is the Id of the [`FusionAuth`](../FusionAuth.html) Application in which you are attempting to authenticate. @param client\_secret [string] (Optional) The client secret. This value will be required if client authentication is enabled. @param token [string] The access token used to identify the user. @param user\_code [string] The end-user verification code. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### cancel_action(action_id, request) [](#method-i-cancel_action)
  Cancels the user action.
 
-@param action\_id [string] The action id of the action to cancel. @param request [OpenStruct, Hash] The action request that contains the information about the cancellation. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param action\_id [string] The action Id of the action to cancel. @param request [OpenStruct, Hash] The action request that contains the information about the cancellation. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### change_password(change_password_id, request) [](#method-i-change_password)
  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.
 
-@param change\_password\_id [string] The change password Id used to find the user. This value is generated by [`FusionAuth`](../FusionAuth.html) once the change password workflow has been initiated. @param request [OpenStruct, Hash] The change password request that contains all of the information used to change the password. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param change\_password\_id [string] The change password Id used to find the user. This value is generated by [`FusionAuth`](../FusionAuth.html) once the change password workflow has been initiated. @param request [OpenStruct, Hash] The change password request that contains all the information used to change the password. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### change_password_by_identity(request) [](#method-i-change_password_by_identity)
- Changes a user’s password using their identity (login id 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.
+ 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.
 
-@param request [OpenStruct, Hash] The change password request that contains all of the information used to change the password. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param request [OpenStruct, Hash] The change password request that contains all the information used to change the password. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### check_change_password_using_id(change_password_id) [](#method-i-check_change_password_using_id)
  Check to see if the user must obtain a Trust Token Id in order to complete a change password request. When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change your password, you must obtain a Trust Token by completing a Two-Factor Step-Up authentication.
@@ -76,7 +81,19 @@ An HTTP status code of 400 with a general error code of [TrustTokenRequired] ind
  ### client_credentials_grant(client_id, client_secret, scope) [](#method-i-client_credentials_grant)
  Make a Client Credentials grant request to obtain an access token.
 
-@param client\_id [string] The client identifier. The client Id is the Id of the [`FusionAuth`](../FusionAuth.html) Entity in which you are attempting to authenticate. @param client\_secret [string] The client secret used to authenticate this request. @param scope [string] (Optional) This parameter is used to indicate which target entity you are requesting access. To request access to an entity, use the format target-entity:<target-entity-id>:<roles>. Roles are an optional comma separated list. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param client\_id [string] (Optional) The client identifier. The client Id is the Id of the [`FusionAuth`](../FusionAuth.html) Entity in which you are attempting to authenticate.
+
+```
+This parameter is optional when Basic Authorization is used to authenticate this request.
+```
+
+@param client\_secret [string] (Optional) The client secret used to authenticate this request.
+
+```
+This parameter is optional when Basic Authorization is used to authenticate this request.
+```
+
+@param scope [string] (Optional) This parameter is used to indicate which target entity you are requesting access. To request access to an entity, use the format target-entity:<target-entity-id>:<roles>. Roles are an optional comma separated list. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### comment_on_user(request) [](#method-i-comment_on_user)
  Adds a comment to the user’s account.
@@ -103,7 +120,7 @@ An HTTP status code of 400 with a general error code of [TrustTokenRequired] ind
 
 If an API key is locked to a tenant, it can only create API Keys for that same tenant.
 
-@param key\_id [string] (Optional) The unique Id of the API key. If not provided a secure random Id will be generated. @param request [OpenStruct, Hash] The request object that contains all of the information needed to create the APIKey. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param key\_id [string] (Optional) The unique Id of the API key. If not provided a secure random Id will be generated. @param request [OpenStruct, Hash] The request object that contains all the information needed to create the APIKey. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### create_application(application_id, request) [](#method-i-create_application)
  Creates an application. You can optionally specify an Id for the application, if not provided one will be generated.
@@ -111,7 +128,7 @@ If an API key is locked to a tenant, it can only create API Keys for that same t
 @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 the information used to create the application. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### create_application_role(application_id, role_id, request) [](#method-i-create_application_role)
- Creates a new role for an application. You must specify the id of the application you are creating the role for. You can optionally specify an Id for the role inside the ApplicationRole object itself, if not provided one will be generated.
+ 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 the information used to create the application role. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
@@ -146,14 +163,14 @@ If an API key is locked to a tenant, it can only create API Keys for that same t
 @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 the information used to create the Entity Type. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### create_entity_type_permission(entity_type_id, permission_id, request) [](#method-i-create_entity_type_permission)
- Creates a new permission for an entity type. You must specify the id of the entity type you are creating the permission for. You can optionally specify an Id for the permission inside the EntityTypePermission object itself, if not provided one will be generated.
+ 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 the information used to create the permission. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### create_family(family_id, request) [](#method-i-create_family)
- Creates a family with the user id in the request as the owner and sole member of the family. You can optionally specify an id for the family, if not provided one will be generated.
+ 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 the information used to create the family. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@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 the information used to create the family. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### create_form(form_id, request) [](#method-i-create_form)
  Creates a form. You can optionally specify an Id for the form, if not provided one will be generated.
@@ -338,7 +355,7 @@ If an API key is locked to a tenant, it can only create API Keys for that same t
  ### delete_group_members(request) [](#method-i-delete_group_members)
  Removes users as members of a group.
 
-@param request [OpenStruct, Hash] The member request that contains all of the information used to remove members to the group. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param request [OpenStruct, Hash] The member request that contains all the information used to remove members to the group. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### delete_identity_provider(identity_provider_id) [](#method-i-delete_identity_provider)
  Deletes the identity provider for the given Id.
@@ -467,17 +484,35 @@ This method can be used to deactivate or permanently delete (hard-delete) users
  ### exchange_o_auth_code_for_access_token(code, client_id, client_secret, redirect_uri) [](#method-i-exchange_o_auth_code_for_access_token)
  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.
 
-@param code [string] The authorization code returned on the /oauth2/authorize response. @param client\_id [string] The unique client identifier. The client Id is the Id of the [`FusionAuth`](../FusionAuth.html) Application in which you are attempting to authenticate. @param client\_secret [string] (Optional) The client secret. This value will be required if client authentication is enabled. @param redirect\_uri [string] The URI to redirect to upon a successful request. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param code [string] The authorization code returned on the /oauth2/authorize response. @param client\_id [string] (Optional) The unique client identifier. The client Id is the Id of the [`FusionAuth`](../FusionAuth.html) Application in which you are attempting to authenticate.
+
+```
+This parameter is optional when Basic Authorization is used to authenticate this request.
+```
+
+@param client\_secret [string] (Optional) The client secret. This value will be required if client authentication is enabled. @param redirect\_uri [string] The URI to redirect to upon a successful request. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### exchange_o_auth_code_for_access_token_using_pkce(code, client_id, client_secret, redirect_uri, code_verifier) [](#method-i-exchange_o_auth_code_for_access_token_using_pkce)
  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.
 
-@param code [string] The authorization code returned on the /oauth2/authorize response. @param client\_id [string] (Optional) The unique client identifier. The client Id is the Id of the [`FusionAuth`](../FusionAuth.html) Application in which you are attempting to authenticate. This parameter is optional when the Authorization header is provided. @param client\_secret [string] (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header. @param redirect\_uri [string] The URI to redirect to upon a successful request. @param code\_verifier [string] The random string generated previously. Will be compared with the code\_challenge sent previously, which allows the OAuth provider to authenticate your app. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param code [string] The authorization code returned on the /oauth2/authorize response. @param client\_id [string] (Optional) The unique client identifier. The client Id is the Id of the [`FusionAuth`](../FusionAuth.html) Application in which you are attempting to authenticate. This parameter is optional when the Authorization header is provided.
+
+```
+This parameter is optional when Basic Authorization is used to authenticate this request.
+```
+
+@param client\_secret [string] (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header. @param redirect\_uri [string] The URI to redirect to upon a successful request. @param code\_verifier [string] The random string generated previously. Will be compared with the code\_challenge sent previously, which allows the OAuth provider to authenticate your app. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### exchange_refresh_token_for_access_token(refresh_token, client_id, client_secret, scope, user_code) [](#method-i-exchange_refresh_token_for_access_token)
  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.
 
-@param refresh\_token [string] The refresh token that you would like to use to exchange for an access token. @param client\_id [string] (Optional) The unique client identifier. The client Id is the Id of the [`FusionAuth`](../FusionAuth.html) Application in which you are attempting to authenticate. This parameter is optional when the Authorization header is provided. @param client\_secret [string] (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header. @param scope [string] (Optional) This parameter is optional and if omitted, the same scope requested during the authorization request will be used. If provided the scopes must match those requested during the initial authorization request. @param user\_code [string] (Optional) The end-user verification code. This code is required if using this endpoint to approve the Device Authorization. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param refresh\_token [string] The refresh token that you would like to use to exchange for an access token. @param client\_id [string] (Optional) The unique client identifier. The client Id is the Id of the [`FusionAuth`](../FusionAuth.html) Application in which you are attempting to authenticate. This parameter is optional when the Authorization header is provided.
+
+```
+This parameter is optional when Basic Authorization is used to authenticate this request.
+```
+
+@param client\_secret [string] (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header. @param scope [string] (Optional) This parameter is optional and if omitted, the same scope requested during the authorization request will be used. If provided the scopes must match those requested during the initial authorization request. @param user\_code [string] (Optional) The end-user verification code. This code is required if using this endpoint to approve the Device Authorization. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### exchange_refresh_token_for_jwt(request) [](#method-i-exchange_refresh_token_for_jwt)
  Exchange a refresh token for a new JWT.
@@ -487,7 +522,13 @@ This method can be used to deactivate or permanently delete (hard-delete) users
  ### exchange_user_credentials_for_access_token(username, password, client_id, client_secret, scope, user_code) [](#method-i-exchange_user_credentials_for_access_token)
  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.
 
-@param username [string] The login identifier of the user. The login identifier can be either the email or the username. @param password [string] The user’s password. @param client\_id [string] (Optional) The unique client identifier. The client Id is the Id of the [`FusionAuth`](../FusionAuth.html) Application in which you are attempting to authenticate. This parameter is optional when the Authorization header is provided. @param client\_secret [string] (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header. @param scope [string] (Optional) This parameter is optional and if omitted, the same scope requested during the authorization request will be used. If provided the scopes must match those requested during the initial authorization request. @param user\_code [string] (Optional) The end-user verification code. This code is required if using this endpoint to approve the Device Authorization. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param username [string] The login identifier of the user. The login identifier can be either the email or the username. @param password [string] The user’s password. @param client\_id [string] (Optional) The unique client identifier. The client Id is the Id of the [`FusionAuth`](../FusionAuth.html) Application in which you are attempting to authenticate. This parameter is optional when the Authorization header is provided.
+
+```
+This parameter is optional when Basic Authorization is used to authenticate this request.
+```
+
+@param client\_secret [string] (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header. @param scope [string] (Optional) This parameter is optional and if omitted, the same scope requested during the authorization request will be used. If provided the scopes must match those requested during the initial authorization request. @param user\_code [string] (Optional) The end-user verification code. This code is required if using this endpoint to approve the Device Authorization. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### forgot_password(request) [](#method-i-forgot_password)
  Begins the forgot password sequence, which kicks off an email to the user so that they can reset their password.
@@ -545,14 +586,14 @@ providers that FusionAuth uses to reconcile the user's account.
 
 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.
 
-@param request [OpenStruct, Hash] The request that contains all of the information about all of the refresh tokens to import. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param request [OpenStruct, Hash] The request that contains all the information about all the refresh tokens to import. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### import_users(request) [](#method-i-import_users)
  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`](../FusionAuth.html) 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.
 
-@param request [OpenStruct, Hash] The request that contains all of the information about all of the users to import. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param request [OpenStruct, Hash] The request that contains all the information about all the users to import. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### import_web_authn_credential(request) [](#method-i-import_web_authn_credential)
  Import a WebAuthn credential
@@ -560,9 +601,14 @@ Therefore, if you encounter an error due to a database key violation, the respon
 @param request [OpenStruct, Hash] An object containing data necessary for importing the credential @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### introspect_access_token(client_id, token) [](#method-i-introspect_access_token)
- Inspect an access token issued by [`FusionAuth`](../FusionAuth.html).
+ 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.
 
-@param client\_id [string] The unique client identifier. The client Id is the Id of the [`FusionAuth`](../FusionAuth.html) Application for which this token was generated. @param token [string] The access token returned by this OAuth provider as the result of a successful authentication. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param client\_id [string] The unique client identifier. The client Id is the Id of the [`FusionAuth`](../FusionAuth.html) Application for which this token was generated. @param token [string] The access token returned by this OAuth provider as the result of a successful client credentials grant. @return [FusionAuth::ClientResponse] The ClientResponse object.
+
+ ### introspect_client_credentials_access_token(token) [](#method-i-introspect_client_credentials_access_token)
+ Inspect an access token issued as the result of the Client Credentials Grant.
+
+@param token [string] The access token returned by this OAuth provider as the result of a successful client credentials grant. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### issue_jwt(application_id, encoded_jwt, refresh_token) [](#method-i-issue_jwt)
  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.
@@ -602,7 +648,7 @@ the IP address will be that of the client or last proxy that sent the request.
  ### logout(global, refresh_token) [](#method-i-logout)
  The Logout API is intended to be used to remove the refresh token and access token cookies if they exist on the client and revoke the refresh token stored. This API does nothing if the request does not contain an access token or refresh token cookies.
 
-@param global [Boolean] When this value is set to true all of the refresh tokens issued to the owner of the
+@param global [Boolean] When this value is set to true all the refresh tokens issued to the owner of the
 
 ```
 provided token will be revoked.
@@ -629,17 +675,17 @@ If provided this takes precedence over the cookie.
  ### modify_action(action_id, request) [](#method-i-modify_action)
  Modifies a temporal user action by changing the expiration of the action and optionally adding a comment to the action.
 
-@param action\_id [string] The Id of the action to modify. This is technically the user action log id. @param request [OpenStruct, Hash] The request that contains all of the information about the modification. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param action\_id [string] The Id of the action to modify. This is technically the user action log id. @param request [OpenStruct, Hash] The request that contains all the information about the modification. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### passwordless_login(request) [](#method-i-passwordless_login)
  Complete a login request using a passwordless code
 
-@param request [OpenStruct, Hash] The passwordless login request that contains all of the information used to complete login. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param request [OpenStruct, Hash] The passwordless login request that contains all the information used to complete login. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### patch_api_key(key_id, request) [](#method-i-patch_api_key)
  Updates an authentication API key by given id
 
-@param key\_id [string] The Id of the authentication key. If not provided a secure random api key will be generated. @param request [OpenStruct, Hash] The request object that contains all of the information needed to create the APIKey. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param key\_id [string] The Id of the authentication key. If not provided a secure random api key will be generated. @param request [OpenStruct, Hash] The request object that contains all the information needed to create the APIKey. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### patch_application(application_id, request) [](#method-i-patch_application)
  Updates, via PATCH, the application with the given Id.
@@ -647,7 +693,7 @@ If provided this takes precedence over the cookie.
 @param application\_id [string] The Id of the application to update. @param request [OpenStruct, Hash] The request that contains just the new application information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### patch_application_role(application_id, role_id, request) [](#method-i-patch_application_role)
- Updates, via PATCH, the application role with the given id for the application.
+ Updates, via PATCH, the application role with the given Id for the application.
 
 @param application\_id [string] The Id of the application that the role belongs to. @param role\_id [string] The Id of the role to update. @param request [OpenStruct, Hash] The request that contains just the new role information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
@@ -702,7 +748,7 @@ If provided this takes precedence over the cookie.
 @param messenger\_id [string] The Id of the messenger to update. @param request [OpenStruct, Hash] The request that contains just the new messenger information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### patch_registration(user_id, request) [](#method-i-patch_registration)
- Updates, via PATCH, the registration for the user with the given id and the application defined in the request.
+ Updates, via PATCH, the registration for the user with the given Id and the application defined in the request.
 
 @param user\_id [string] The Id of the user whose registration is going to be updated. @param request [OpenStruct, Hash] The request that contains just the new registration information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
@@ -785,7 +831,7 @@ ensure the index immediately current before making a query request to the search
 @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### register(user_id, request) [](#method-i-register)
- Registers a user for an application. If you provide the User and the UserRegistration object on this request, it will create the user as well as register them for the application. This is called a Full Registration. However, if you only provide the UserRegistration object, then the user must already exist and they will be registered for the application. The user id can also be provided and it will either be used to look up an existing user or it will be used for the newly created User.
+ 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.
 
 @param user\_id [string] (Optional) The Id of the user being registered for the application and optionally created. @param request [OpenStruct, Hash] The request that optionally contains the User and must contain the UserRegistration. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
@@ -799,7 +845,7 @@ You have been warned.
  ### remove_user_from_family(family_id, user_id) [](#method-i-remove_user_from_family)
  Removes a user from the family with the given id.
 
-@param family\_id [string] The id of the family to remove the user from. @param user\_id [string] The id of the user to remove from the family. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param family\_id [string] The Id of the family to remove the user from. @param user\_id [string] The Id of the user to remove from the family. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### resend_email_verification(email) [](#method-i-resend_email_verification)
  Re-sends the verification email to the user.
@@ -842,7 +888,7 @@ You have been warned.
 @param key\_id [string] The Id of the API key to retrieve. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### retrieve_application(application_id) [](#method-i-retrieve_application)
- Retrieves the application for the given id or all of the applications if the id is null.
+ Retrieves the application for the given Id or all the applications if the Id is null.
 
 @param application\_id [string] (Optional) The application id. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
@@ -882,7 +928,7 @@ You have been warned.
 @param application\_id [string] (Optional) The application id. @param start [OpenStruct, Hash] The start instant as UTC milliseconds since Epoch. @param \_end [OpenStruct, Hash] The end instant as UTC milliseconds since Epoch. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### retrieve_email_template(email_template_id) [](#method-i-retrieve_email_template)
- Retrieves the email template for the given Id. If you don’t specify the id, this will return all of the email templates.
+ Retrieves the email template for the given Id. If you don’t specify the id, this will return all the email templates.
 
 @param email\_template\_id [string] (Optional) The Id of the email template. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
@@ -962,7 +1008,7 @@ You have been warned.
 @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### retrieve_identity_provider(identity_provider_id) [](#method-i-retrieve_identity_provider)
- Retrieves the identity provider for the given id or all of the identity providers if the id is null.
+ Retrieves the identity provider for the given Id or all the identity providers if the Id is null.
 
 @param identity\_provider\_id [string] The identity provider Id. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
@@ -1052,7 +1098,7 @@ You have been warned.
 @param application\_id [string] (Optional) The application id. @param start [OpenStruct, Hash] The start instant as UTC milliseconds since Epoch. @param \_end [OpenStruct, Hash] The end instant as UTC milliseconds since Epoch. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### retrieve_message_template(message_template_id) [](#method-i-retrieve_message_template)
- Retrieves the message template for the given Id. If you don’t specify the id, this will return all of the message templates.
+ Retrieves the message template for the given Id. If you don’t specify the id, this will return all the message templates.
 
 @param message\_template\_id [string] (Optional) The Id of the message template. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
@@ -1110,6 +1156,11 @@ This API does not require an API key.
 
 @param parent\_email [string] The email of the parent. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
+ ### retrieve_pending_link(pending_link_id, user_id) [](#method-i-retrieve_pending_link)
+ Retrieve a pending identity provider link. This is useful to validate a pending link and retrieve meta-data about the identity provider link.
+
+@param p\_ending\_link\_id [string] The pending link Id. @param user\_id [string] The optional userId. When provided additional meta-data will be provided to identify how many links if any the user already has. @return [FusionAuth::ClientResponse] The ClientResponse object.
+
  ### retrieve_reactor_metrics() [](#method-i-retrieve_reactor_metrics)
  Retrieves the [`FusionAuth`](../FusionAuth.html) Reactor metrics.
 
@@ -1136,7 +1187,7 @@ This API does not require an API key.
 @param user\_id [string] The Id of the user. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### retrieve_registration(user_id, application_id) [](#method-i-retrieve_registration)
- Retrieves the user registration for the user with the given id and the given application id.
+ Retrieves the user registration for the user with the given Id and the given application id.
 
 @param user\_id [string] The Id of the user. @param application\_id [string] The Id of the application. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
@@ -1178,7 +1229,7 @@ This API does not require an API key.
 @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### retrieve_total_report() [](#method-i-retrieve_total_report)
- Retrieves the totals report. This contains all of the total counts for each application and the global registration count.
+ Retrieves the totals report. This contains all the total counts for each application and the global registration count.
 
 @return [FusionAuth::ClientResponse] The ClientResponse object.
 
@@ -1200,12 +1251,12 @@ This can be used to see if a user will need to complete a two-factor challenge t
 @param user\_id [string] The Id of the user. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### retrieve_user_action(user_action_id) [](#method-i-retrieve_user_action)
- Retrieves the user action for the given Id. If you pass in null for the id, this will return all of the user actions.
+ Retrieves the user action for the given Id. If you pass in null for the id, this will return all the user actions.
 
 @param user\_action\_id [string] (Optional) The Id of the user action. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### retrieve_user_action_reason(user_action_reason_id) [](#method-i-retrieve_user_action_reason)
- Retrieves the user action reason for the given Id. If you pass in null for the id, this will return all of the user action reasons.
+ 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.
 
 @param user\_action\_reason\_id [string] (Optional) The Id of the user action reason. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
@@ -1244,6 +1295,22 @@ This can be used to see if a user will need to complete a two-factor challenge t
 
 @param verification\_id [string] The unique verification Id that has been set on the user object. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
+ ### retrieve_user_code(client_id, client_secret, user_code) [](#method-i-retrieve_user_code)
+ Retrieve a user\_code that is part of an in-progress Device Authorization Grant.
+
+This API is useful if you want to build your own login workflow to complete a device grant.
+
+@param client\_id [string] The client id. @param client\_secret [string] The client id. @param user\_code [string] The end-user verification code. @return [FusionAuth::ClientResponse] The ClientResponse object.
+
+ ### retrieve_user_code_using_api_key(user_code) [](#method-i-retrieve_user_code_using_api_key)
+ 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.
+
+@param user\_code [string] The end-user verification code. @return [FusionAuth::ClientResponse] The ClientResponse object.
+
  ### retrieve_user_comments(user_id) [](#method-i-retrieve_user_comments)
  Retrieves all the comments for the user with the given Id.
 
@@ -1346,7 +1413,7 @@ See also: (method names may vary by language… but you’ll figure it out)
 -revokeRefreshTokenById-revokeRefreshTokenByToken-revokeRefreshTokensByUserId-revokeRefreshTokensByApplicationId-revokeRefreshTokensByUserIdForApplication
 ```
 
-@param token [string] (Optional) The refresh token to delete. @param user\_id [string] (Optional) The user id whose tokens to delete. @param application\_id [string] (Optional) The application id of the tokens to delete. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param token [string] (Optional) The refresh token to delete. @param user\_id [string] (Optional) The user Id whose tokens to delete. @param application\_id [string] (Optional) The application Id of the tokens to delete. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### revoke_refresh_token_by_id(token_id) [](#method-i-revoke_refresh_token_by_id)
  Revokes a single refresh token by the unique Id. The unique Id is not sensitive as it cannot be used to obtain another JWT.
@@ -1383,9 +1450,24 @@ See also: (method names may vary by language… but you’ll figure it out)
 
 @param user\_consent\_id [string] The User Consent Id @return [FusionAuth::ClientResponse] The ClientResponse object.
 
+ ### search_applications(request) [](#method-i-search_applications)
+ Searches applications with the specified criteria and pagination.
+
+@param request [OpenStruct, Hash] The search criteria and pagination information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+
  ### search_audit_logs(request) [](#method-i-search_audit_logs)
  Searches the audit logs with the specified criteria and pagination.
 
+@param request [OpenStruct, Hash] The search criteria and pagination information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+
+ ### search_consents(request) [](#method-i-search_consents)
+ Searches consents with the specified criteria and pagination.
+
+@param request [OpenStruct, Hash] The search criteria and pagination information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+
+ ### search_email_templates(request) [](#method-i-search_email_templates)
+ Searches email templates with the specified criteria and pagination.
+
 @param request [OpenStruct, Hash] The search criteria and pagination information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### search_entities(request) [](#method-i-search_entities)
@@ -1394,7 +1476,7 @@ See also: (method names may vary by language… but you’ll figure it out)
 @param request [OpenStruct, Hash] The search criteria and pagination information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### search_entities_by_ids(ids) [](#method-i-search_entities_by_ids)
- Retrieves the entities for the given ids. If any id is invalid, it is ignored.
+ Retrieves the entities for the given ids. If any Id is invalid, it is ignored.
 
 @param ids [Array] The entity ids to search for. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
@@ -1421,25 +1503,55 @@ See also: (method names may vary by language… but you’ll figure it out)
  ### search_groups(request) [](#method-i-search_groups)
  Searches groups with the specified criteria and pagination.
 
+@param request [OpenStruct, Hash] The search criteria and pagination information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+
+ ### search_identity_providers(request) [](#method-i-search_identity_providers)
+ Searches identity providers with the specified criteria and pagination.
+
 @param request [OpenStruct, Hash] The search criteria and pagination information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### search_ip_access_control_lists(request) [](#method-i-search_ip_access_control_lists)
  Searches the IP Access Control Lists with the specified criteria and pagination.
 
+@param request [OpenStruct, Hash] The search criteria and pagination information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+
+ ### search_keys(request) [](#method-i-search_keys)
+ Searches keys with the specified criteria and pagination.
+
+@param request [OpenStruct, Hash] The search criteria and pagination information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+
+ ### search_lambdas(request) [](#method-i-search_lambdas)
+ Searches lambdas with the specified criteria and pagination.
+
 @param request [OpenStruct, Hash] The search criteria and pagination information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### search_login_records(request) [](#method-i-search_login_records)
  Searches the login records with the specified criteria and pagination.
 
+@param request [OpenStruct, Hash] The search criteria and pagination information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+
+ ### search_tenants(request) [](#method-i-search_tenants)
+ Searches tenants with the specified criteria and pagination.
+
+@param request [OpenStruct, Hash] The search criteria and pagination information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+
+ ### search_themes(request) [](#method-i-search_themes)
+ Searches themes with the specified criteria and pagination.
+
+@param request [OpenStruct, Hash] The search criteria and pagination information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+
+ ### search_user_comments(request) [](#method-i-search_user_comments)
+ Searches user comments with the specified criteria and pagination.
+
 @param request [OpenStruct, Hash] The search criteria and pagination information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### search_users(ids) [](#method-i-search_users)
- Retrieves the users for the given ids. If any id is invalid, it is ignored.
+ Retrieves the users for the given ids. If any Id is invalid, it is ignored.
 
 @param ids [Array] The user ids to search for. @return [FusionAuth::ClientResponse] The ClientResponse object. @deprecated This method has been renamed to [`search_users_by_ids`](FusionAuthClient.html#method-i-search_users_by_ids), use that method instead.
 
  ### search_users_by_ids(ids) [](#method-i-search_users_by_ids)
- Retrieves the users for the given ids. If any id is invalid, it is ignored.
+ Retrieves the users for the given ids. If any Id is invalid, it is ignored.
 
 @param ids [Array] The user ids to search for. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
@@ -1465,10 +1577,15 @@ and sortFields.
 
 @return [FusionAuth::ClientResponse] The ClientResponse object. @deprecated This method has been renamed to [`search_users_by_query`](FusionAuthClient.html#method-i-search_users_by_query), use that method instead.
 
+ ### search_webhooks(request) [](#method-i-search_webhooks)
+ Searches webhooks with the specified criteria and pagination.
+
+@param request [OpenStruct, Hash] The search criteria and pagination information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+
  ### send_email(email_template_id, request) [](#method-i-send_email)
  Send an email using an email template id. You can optionally provide `requestData` to access key value pairs in the email template.
 
-@param email\_template\_id [string] The id for the template. @param request [OpenStruct, Hash] The send email request that contains all of the information used to send the email. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param email\_template\_id [string] The Id for the template. @param request [OpenStruct, Hash] The send email request that contains all the information used to send the email. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### send_family_request_email(request) [](#method-i-send_family_request_email)
  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.
@@ -1478,7 +1595,7 @@ and sortFields.
  ### send_passwordless_code(request) [](#method-i-send_passwordless_code)
  Send a passwordless authentication code in an email to complete login.
 
-@param request [OpenStruct, Hash] The passwordless send request that contains all of the information used to send an email containing a code. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param request [OpenStruct, Hash] The passwordless send request that contains all the information used to send an email containing a code. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### send_two_factor_code(request) [](#method-i-send_two_factor_code)
  Send a Two Factor authentication code to assist in setting up Two Factor authentication or disabling.
@@ -1498,7 +1615,7 @@ and sortFields.
  ### send_two_factor_code_for_login_using_method(two_factor_id, request) [](#method-i-send_two_factor_code_for_login_using_method)
  Send a Two Factor authentication code to allow the completion of Two Factor authentication.
 
-@param two\_factor\_id [string] The Id returned by the Login API necessary to complete Two Factor authentication. @param request [OpenStruct, Hash] The Two Factor send request that contains all of the information used to send the Two Factor code to the user. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param two\_factor\_id [string] The Id returned by the Login API necessary to complete Two Factor authentication. @param request [OpenStruct, Hash] The Two Factor send request that contains all the information used to send the Two Factor code to the user. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### set_tenant_id(tenant_id) [](#method-i-set_tenant_id)
  ### start_identity_provider_login(request) [](#method-i-start_identity_provider_login)
@@ -1515,14 +1632,14 @@ providers that FusionAuth uses to reconcile the user's account.
  ### start_passwordless_login(request) [](#method-i-start_passwordless_login)
  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`](../FusionAuth.html). The passwordless login is completed by using the Passwordless Login API with this code.
 
-@param request [OpenStruct, Hash] The passwordless start request that contains all of the information used to begin the passwordless login request. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param request [OpenStruct, Hash] The passwordless start request that contains all the information used to begin the passwordless login request. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### start_two_factor_login(request) [](#method-i-start_two_factor_login)
  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 of a normal login that originated from the Login API (/api/login).
+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).
 
-@param request [OpenStruct, Hash] The Two-Factor start request that contains all of the information used to begin the Two-Factor login request. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param request [OpenStruct, Hash] The Two-Factor start request that contains all the information used to begin the Two-Factor login request. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### start_web_authn_login(request) [](#method-i-start_web_authn_login)
  Start a WebAuthn authentication ceremony by generating a new challenge for the user
@@ -1547,57 +1664,57 @@ This API is intended to allow you to begin a Two-Factor login outside of a norma
  ### update_application(application_id, request) [](#method-i-update_application)
  Updates the application with the given Id.
 
-@param application\_id [string] The Id of the application to update. @param request [OpenStruct, Hash] The request that contains all of the new application information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param application\_id [string] The Id of the application to update. @param request [OpenStruct, Hash] The request that contains all the new application information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### update_application_role(application_id, role_id, request) [](#method-i-update_application_role)
- Updates the application role with the given id for the application.
+ Updates the application role with the given Id for the application.
 
-@param application\_id [string] The Id of the application that the role belongs to. @param role\_id [string] The Id of the role to update. @param request [OpenStruct, Hash] The request that contains all of the new role information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param application\_id [string] The Id of the application that the role belongs to. @param role\_id [string] The Id of the role to update. @param request [OpenStruct, Hash] The request that contains all the new role information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### update_connector(connector_id, request) [](#method-i-update_connector)
  Updates the connector with the given Id.
 
-@param connector\_id [string] The Id of the connector to update. @param request [OpenStruct, Hash] The request object that contains all of the new connector information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param connector\_id [string] The Id of the connector to update. @param request [OpenStruct, Hash] The request object that contains all the new connector information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### update_consent(consent_id, request) [](#method-i-update_consent)
  Updates the consent with the given Id.
 
-@param consent\_id [string] The Id of the consent to update. @param request [OpenStruct, Hash] The request that contains all of the new consent information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param consent\_id [string] The Id of the consent to update. @param request [OpenStruct, Hash] The request that contains all the new consent information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### update_email_template(email_template_id, request) [](#method-i-update_email_template)
  Updates the email template with the given Id.
 
-@param email\_template\_id [string] The Id of the email template to update. @param request [OpenStruct, Hash] The request that contains all of the new email template information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param email\_template\_id [string] The Id of the email template to update. @param request [OpenStruct, Hash] The request that contains all the new email template information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### update_entity(entity_id, request) [](#method-i-update_entity)
  Updates the Entity with the given Id.
 
-@param entity\_id [string] The Id of the Entity to update. @param request [OpenStruct, Hash] The request that contains all of the new Entity information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param entity\_id [string] The Id of the Entity to update. @param request [OpenStruct, Hash] The request that contains all the new Entity information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### update_entity_type(entity_type_id, request) [](#method-i-update_entity_type)
  Updates the Entity Type with the given Id.
 
-@param entity\_type\_id [string] The Id of the Entity Type to update. @param request [OpenStruct, Hash] The request that contains all of the new Entity Type information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param entity\_type\_id [string] The Id of the Entity Type to update. @param request [OpenStruct, Hash] The request that contains all the new Entity Type information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### update_entity_type_permission(entity_type_id, permission_id, request) [](#method-i-update_entity_type_permission)
- Updates the permission with the given id for the entity type.
+ Updates the permission with the given Id for the entity type.
 
-@param entity\_type\_id [string] The Id of the entityType that the permission belongs to. @param permission\_id [string] The Id of the permission to update. @param request [OpenStruct, Hash] The request that contains all of the new permission information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param entity\_type\_id [string] The Id of the entityType that the permission belongs to. @param permission\_id [string] The Id of the permission to update. @param request [OpenStruct, Hash] The request that contains all the new permission information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### update_form(form_id, request) [](#method-i-update_form)
  Updates the form with the given Id.
 
-@param form\_id [string] The Id of the form to update. @param request [OpenStruct, Hash] The request object that contains all of the new form information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param form\_id [string] The Id of the form to update. @param request [OpenStruct, Hash] The request object that contains all the new form information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### update_form_field(field_id, request) [](#method-i-update_form_field)
  Updates the form field with the given Id.
 
-@param field\_id [string] The Id of the form field to update. @param request [OpenStruct, Hash] The request object that contains all of the new form field information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param field\_id [string] The Id of the form field to update. @param request [OpenStruct, Hash] The request object that contains all the new form field information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### update_group(group_id, request) [](#method-i-update_group)
  Updates the group with the given Id.
 
-@param group\_id [string] The Id of the group to update. @param request [OpenStruct, Hash] The request that contains all of the new group information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param group\_id [string] The Id of the group to update. @param request [OpenStruct, Hash] The request that contains all the new group information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### update_group_members(request) [](#method-i-update_group_members)
  Creates a member in a group.
@@ -1612,67 +1729,67 @@ This API is intended to allow you to begin a Two-Factor login outside of a norma
  ### update_integrations(request) [](#method-i-update_integrations)
  Updates the available integrations.
 
-@param request [OpenStruct, Hash] The request that contains all of the new integration information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param request [OpenStruct, Hash] The request that contains all the new integration information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### update_ip_access_control_list(access_control_list_id, request) [](#method-i-update_ip_access_control_list)
  Updates the IP Access Control List with the given Id.
 
-@param access\_control\_list\_id [string] The Id of the IP Access Control List to update. @param request [OpenStruct, Hash] The request that contains all of the new IP Access Control List information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param access\_control\_list\_id [string] The Id of the IP Access Control List to update. @param request [OpenStruct, Hash] The request that contains all the new IP Access Control List information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### update_key(key_id, request) [](#method-i-update_key)
  Updates the key with the given Id.
 
-@param key\_id [string] The Id of the key to update. @param request [OpenStruct, Hash] The request that contains all of the new key information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param key\_id [string] The Id of the key to update. @param request [OpenStruct, Hash] The request that contains all the new key information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### update_lambda(lambda_id, request) [](#method-i-update_lambda)
  Updates the lambda with the given Id.
 
-@param lambda\_id [string] The Id of the lambda to update. @param request [OpenStruct, Hash] The request that contains all of the new lambda information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param lambda\_id [string] The Id of the lambda to update. @param request [OpenStruct, Hash] The request that contains all the new lambda information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### update_message_template(message_template_id, request) [](#method-i-update_message_template)
  Updates the message template with the given Id.
 
-@param message\_template\_id [string] The Id of the message template to update. @param request [OpenStruct, Hash] The request that contains all of the new message template information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param message\_template\_id [string] The Id of the message template to update. @param request [OpenStruct, Hash] The request that contains all the new message template information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### update_messenger(messenger_id, request) [](#method-i-update_messenger)
  Updates the messenger with the given Id.
 
-@param messenger\_id [string] The Id of the messenger to update. @param request [OpenStruct, Hash] The request object that contains all of the new messenger information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param messenger\_id [string] The Id of the messenger to update. @param request [OpenStruct, Hash] The request object that contains all the new messenger information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### update_registration(user_id, request) [](#method-i-update_registration)
- Updates the registration for the user with the given id and the application defined in the request.
+ Updates the registration for the user with the given Id and the application defined in the request.
 
-@param user\_id [string] The Id of the user whose registration is going to be updated. @param request [OpenStruct, Hash] The request that contains all of the new registration information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param user\_id [string] The Id of the user whose registration is going to be updated. @param request [OpenStruct, Hash] The request that contains all the new registration information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### update_system_configuration(request) [](#method-i-update_system_configuration)
  Updates the system configuration.
 
-@param request [OpenStruct, Hash] The request that contains all of the new system configuration information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param request [OpenStruct, Hash] The request that contains all the new system configuration information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### update_tenant(tenant_id, request) [](#method-i-update_tenant)
  Updates the tenant with the given Id.
 
-@param [`tenant_id`](FusionAuthClient.html#attribute-i-tenant_id) [string] The Id of the tenant to update. @param request [OpenStruct, Hash] The request that contains all of the new tenant information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param [`tenant_id`](FusionAuthClient.html#attribute-i-tenant_id) [string] The Id of the tenant to update. @param request [OpenStruct, Hash] The request that contains all the new tenant information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### update_theme(theme_id, request) [](#method-i-update_theme)
  Updates the theme with the given Id.
 
-@param theme\_id [string] The Id of the theme to update. @param request [OpenStruct, Hash] The request that contains all of the new theme information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param theme\_id [string] The Id of the theme to update. @param request [OpenStruct, Hash] The request that contains all the new theme information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### update_user(user_id, request) [](#method-i-update_user)
  Updates the user with the given Id.
 
-@param user\_id [string] The Id of the user to update. @param request [OpenStruct, Hash] The request that contains all of the new user information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param user\_id [string] The Id of the user to update. @param request [OpenStruct, Hash] The request that contains all the new user information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### update_user_action(user_action_id, request) [](#method-i-update_user_action)
  Updates the user action with the given Id.
 
-@param user\_action\_id [string] The Id of the user action to update. @param request [OpenStruct, Hash] The request that contains all of the new user action information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param user\_action\_id [string] The Id of the user action to update. @param request [OpenStruct, Hash] The request that contains all the new user action information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### update_user_action_reason(user_action_reason_id, request) [](#method-i-update_user_action_reason)
  Updates the user action reason with the given Id.
 
-@param user\_action\_reason\_id [string] The Id of the user action reason to update. @param request [OpenStruct, Hash] The request that contains all of the new user action reason information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param user\_action\_reason\_id [string] The Id of the user action reason to update. @param request [OpenStruct, Hash] The request that contains all the new user action reason information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### update_user_consent(user_consent_id, request) [](#method-i-update_user_consent)
  Updates a single User consent by Id.
@@ -1682,7 +1799,7 @@ This API is intended to allow you to begin a Two-Factor login outside of a norma
  ### update_webhook(webhook_id, request) [](#method-i-update_webhook)
  Updates the webhook with the given Id.
 
-@param webhook\_id [string] The Id of the webhook to update. @param request [OpenStruct, Hash] The request that contains all of the new webhook information. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param webhook\_id [string] The Id of the webhook to update. @param request [OpenStruct, Hash] The request that contains all the new webhook information. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### upsert_entity_grant(entity_id, request) [](#method-i-upsert_entity_grant)
  Creates or updates an Entity Grant. This is when a User/Entity is granted permissions to an Entity.
@@ -1706,12 +1823,12 @@ Issue a new access token (JWT) with the provided claims in the request. This JWT
 
 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.
 
-@param request [OpenStruct, Hash] The request that contains all of the claims for this JWT. @return [FusionAuth::ClientResponse] The ClientResponse object.
+@param request [OpenStruct, Hash] The request that contains all the claims for this JWT. @return [FusionAuth::ClientResponse] The ClientResponse object.
 
  ### verify_email(verification_id) [](#method-i-verify_email)
  Confirms a email verification. The Id given is usually from an email sent to the user.
 
-@param verification\_id [string] The email verification id sent to the user. @return [FusionAuth::ClientResponse] The ClientResponse object. @deprecated This method has been renamed to [`verify_email_address`](FusionAuthClient.html#method-i-verify_email_address) and changed to take a JSON request body, use that method instead.
+@param verification\_id [string] The email verification Id sent to the user. @return [FusionAuth::ClientResponse] The ClientResponse object. @deprecated This method has been renamed to [`verify_email_address`](FusionAuthClient.html#method-i-verify_email_address) and changed to take a JSON request body, use that method instead.
 
  ### verify_email_address(request) [](#method-i-verify_email_address)
  Confirms a user’s email address.