AutoAuth - Revision history

SarahK at 19:42, 18 April 2022

2022-04-18T19:42:11Z

SarahK at 18:09, 7 February 2022

2022-02-07T18:09:15Z

Lawrence: /* Enabling/Disabling AutoAuth */

2021-01-14T19:41:42Z

‎Enabling/Disabling AutoAuth

Lawrence: /* Enabling/Disabling AutoAuth */

2021-01-14T19:39:23Z

‎Enabling/Disabling AutoAuth

Lawrence: /* Enabling/Disabling AutoAuth */

2021-01-14T19:38:36Z

‎Enabling/Disabling AutoAuth

Marcus.allen: corrected variable to timestamp instead of xtamp

2020-12-22T01:17:54Z

corrected variable to timestamp instead of xtamp

SarahK at 23:39, 20 November 2020

2020-11-20T23:39:35Z

SarahK at 23:39, 20 November 2020

2020-11-20T23:39:15Z

SarahK at 23:38, 20 November 2020

2020-11-20T23:38:49Z

SarahK at 20:27, 5 August 2020

2020-08-05T20:27:43Z

@@ Line 24: / Line 24: @@
 # Add the following line to your WHMCS <tt>configuration.php</tt> file to define an AutoAuth key. The value needs to be a randomly-generated sequence of letters and numbers:<div class="source-cli">$autoauthkey = "abcXYZ123"</div>
-# If you use WHMCS 7.10 or later, enable '''Allow AutoAuth''' in the '''[[Security Tab|Security]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' (WHMCS 8.0) or, for WHMCS 7.10,  '''Setup > General Settings > Security'''.
+# If you use WHMCS 7.10 or later, enable '''Allow AutoAuth''' in the '''[[Security Tab|Security]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' (WHMCS 8.0) or, for WHMCS 7.10,  '''Setup > General Settings'''.
 ==Using AutoAuth==

@@ Line 19: / Line 19: @@
 ==Enabling/Disabling AutoAuth==
-AutoAuth is disabled by default. Up to two actions must be taken to enable it, depending on the installed version of WHMCS. First, you will need to add the following line to your WHMCS <tt>configuration.php</tt> file to define an AutoAuth key. The value needs to be a randomly-generated sequence of letters and numbers:
+AutoAuth is disabled by default.
-−
-<div class="source-cli">
+To enable it:
-$autoauthkey = "abcXYZ123";
-</div>
+# Add the following line to your WHMCS <tt>configuration.php</tt> file to define an AutoAuth key. The value needs to be a randomly-generated sequence of letters and numbers:<div class="source-cli">$autoauthkey = "abcXYZ123"</div>
+# If you use WHMCS 7.10 or later, enable '''Allow AutoAuth''' in the '''[[Security Tab|Security]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' (WHMCS 8.0) or, for WHMCS 7.10,  '''Setup > General Settings > Security'''.
 ==Using AutoAuth==

@@ Line 19: / Line 19: @@
 ==Enabling/Disabling AutoAuth==
-AutoAuth is disabled by default. Two actions must be taken to enable it, depending on the installed version of WHMCS. First, you will need to add the following line to your WHMCS <tt>configuration.php</tt> file to define an AutoAuth key. The value needs to be a randomly-generated sequence of letters and numbers:
+AutoAuth is disabled by default. Up to two actions must be taken to enable it, depending on the installed version of WHMCS. First, you will need to add the following line to your WHMCS <tt>configuration.php</tt> file to define an AutoAuth key. The value needs to be a randomly-generated sequence of letters and numbers:
 <div class="source-cli">
@@ Line 25: / Line 25: @@
 </div>
-Second, you must enable '''Allow AutoAuth''' in the '''Security''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, for WHMCS 7.10,  '''Setup > General Settings > Security'''. This doesn't apply to WHMCS 7.9 and older.
+Second, you must enable '''Allow AutoAuth''' in the '''Security''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' (WHMCS 8.0) or, for WHMCS 7.10,  '''Setup > General Settings > Security'''. This step doesn't apply to WHMCS 7.9 and older.
 ==Using AutoAuth==

@@ Line 19: / Line 19: @@
 ==Enabling/Disabling AutoAuth==
-AutoAuth is disabled by default. Two actions must be taken to enable it. First, you will need to add the following line to your WHMCS <tt>configuration.php</tt> file to define an AutoAuth key. The value needs to be a randomly-generated sequence of letters and numbers:
+AutoAuth is disabled by default. Two actions must be taken to enable it, depending on the installed version of WHMCS. First, you will need to add the following line to your WHMCS <tt>configuration.php</tt> file to define an AutoAuth key. The value needs to be a randomly-generated sequence of letters and numbers:
 <div class="source-cli">

@@ Line 25: / Line 25: @@
 </div>
-Second, you must enable '''Allow AutoAuth''' in the '''Security''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0,  '''Setup > General Settings > Security'''.
+Second, you must enable '''Allow AutoAuth''' in the '''Security''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, for WHMCS 7.10,  '''Setup > General Settings > Security'''. This doesn't apply to WHMCS 7.9 and older.
-−
 ==Using AutoAuth==

@@ Line 32: / Line 32: @@
 <div class="source-cli">
-dologin.php?email=demo@whmcs.com×tamp=1290100706&hash=0ec890a9a733d723eca637401ba2b7afb34cdf45&goto=index.php
+dologin.php?email=demo@whmcs.com&timestamp=1290100706&hash=0ec890a9a733d723eca637401ba2b7afb34cdf45&goto=index.php
 </div>
@@ Line 67: / Line 67: @@
 // Generate AutoAuth URL & Redirect
-$url = $whmcsurl . "?email=$email×tamp=$timestamp&hash=$hash&goto=" . urlencode($goto);
+$url = $whmcsurl . "?email=$email&timestamp=$timestamp&hash=$hash&goto=" . urlencode($goto);
 header("Location: $url");
 exit;
 </source>

@@ Line 1: / Line 1: @@
 <div class="docs-alert-info">
-<i class="fa fa-info-circle fa-fw"></i>AutoAuth was deprecated in WHMCS 7.10 and removed in WHMCS 8.1.
+AutoAuth was deprecated in WHMCS 7.10 and removed in WHMCS 8.1.
 * We recommend that you replace this with the [https://developers.whmcs.com/api-reference/createssotoken/ CreateSsoToken API] using [[WHMCS Single Sign-On]].
 * The information in this document only applies to WHMCS 7.9 and earlier.

@@ Line 1: / Line 1: @@
-<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i>  AutoAuth is deprecated as of v7.10 will be removed in v8.1.  Please utilize the [https://developers.whmcs.com/api-reference/createssotoken/ CreateSsoToken API] which utilises [[WHMCS Single Sign-On]]
+<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i>
 </div>
 ==What is AutoAuth?==
-−
-AutoAuth stands for Automatic Authentication and is a method for you to be able to automatically log a user in from your own trusted third party code. For example you might use it if you have another software on your website which clients already log into, and once they have logged into that you don't want them to have to re-authenticate again separately to access WHMCS.
+AutoAuth stands for Automatic Authentication and is a method that lets you automatically log a user in from your own trusted third-party code. For example, you might use it if you have another software on your website that clients already log in to, and, once they have logged in to that, you don't want them to have to reauthenticate separately to access WHMCS.
-−
 ==How does it work?==
-AutoAuth is disabled by default.  Two actions must be taken to enable it.  First, you will need to add the following line to your WHMCS configuration.php file to define an AutoAuth key.  The value needs to be a randomly generated sequence of letters and numbers:
+AutoAuth works by constructing a special URL to redirect the user to WHMCS, which WHMCS then verifies. If it is valid, it activates the user's login session in WHMCS automatically before redirecting the user to the page you specified in the link.
 <div class="source-cli">
 $autoauthkey = "abcXYZ123";
 </div>
 ==Using AutoAuth==
-−
-To use AutoAuth, you simply need to formulate a request like the example below containing the users email address, timestamp of the time the request was generated, the AutoAuth hash and then optionally a "goto" parameter to specify where to send the user after successful authentication.
+To use AutoAuth, formulate a request like the example below. This must contain the user's email address, the timestamp of the time the request was generated, the AutoAuth hash, and, optionally, a <tt>goto</tt> parameter to specify where to send the user after successful authentication.
-−
-<div class="source-cli">dologin.php?email=demo@whmcs.com&timestamp=1290100706&hash=0ec890a9a733d723eca637401ba2b7afb34cdf45&goto=index.php
+<div class="source-cli">
 </div>
-−
-So in this example, it would login the client demo@whmcs.com and take them to the homepage after login.
+In this example, it would <tt>demo@whmcs.com</tt> in as the client and take them to the homepage after login.
-−
-*The email variable needs to be the email address for the clients account you wish to login to
+*The email variable needs to be the email address for the client account you wish to log in to.
-*The timestamp must be within 15 minutes of the server time for the autoauth to be accepted, otherwise the link is considered to be expired
+*The timestamp must be within 15 minutes of the server time for AutoAuth to be accepted. Otherwise, the link is considered expired.
-*The AutoAuth hash is generated by performing an sha1 hash of the email, timestamp and AutoAuth key you defined earlier in the WHMCS configuration.php file as follows:
+*The AutoAuth hash is generated by performing an SHA-1 hash of the email, timestamp, and AutoAuth key you defined earlier in the WHMCS <tt>configuration.php</tt> file. This should appear as follows:
-−
 <div class="source-cli">
 $hash = sha1($email.$timestamp.$autoauthkey);
 </div>
-−
 ==Sample Script==
-−
-The sample code below demonstrates how you can use AutoAuth in your external app to a log a user into WHMCS:
+The sample code below demonstrates how you can use AutoAuth in your external application to a log a user in to WHMCS:
-−
 <source lang="php">
 <?php
@@ Line 52: / Line 55: @@
   *  Docs: http://docs.whmcs.com/AutoAuth
   */
-−
 // Define WHMCS URL & AutoAuth Key
 $whmcsurl = "https://www.example.com/whmcs/dologin.php";
 $autoauthkey = "strong_auto_auth_key_goes_here";
-−
 $timestamp = time(); // Get current timestamp
 $email = 'demo@whmcs.com'; // Clients Email Address to Login
 $goto = 'clientarea.php?action=products';
-−
 $hash = sha1($email . $timestamp . $autoauthkey); // Generate Hash
-−
 // Generate AutoAuth URL & Redirect
-$url = $whmcsurl . "?email=$email&timestamp=$timestamp&hash=$hash&goto=" . urlencode($goto);
+$url = $whmcsurl . "?email=$email×tamp=$timestamp&hash=$hash&goto=" . urlencode($goto);
 header("Location: $url");
 exit;
 </source>

@@ Line 21: / Line 21: @@
 </div>
-Second, the feature must be enabled by saving the '''Setup >> General Settings >> Security >> Allow AutoAuth''' setting to ''Enabled''.
+Second, the feature must be enabled by enabling '''Allow AutoAuth''' at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Security''' or, prior to WHMCS 8.0,  '''Setup > General Settings > Security'''.
 <div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i>  AutoAuth cannot be enabled in v8.1 or greater.  Please utilize the [https://developers.whmcs.com/api-reference/createssotoken/ CreateSsoToken API] which utilises [[WHMCS Single Sign-On]]
 </div>