Site:API:Authentication - Revision history

MetrixAdmin: /* Required Parameters */

2013-01-09T05:48:48Z

‎Required Parameters

MetrixAdmin: /* Required Parameters */

2013-01-09T05:48:29Z

‎Required Parameters

MetrixAdmin: /* Required Parameters */

2013-01-09T05:48:11Z

‎Required Parameters

MetrixAdmin: /* Logout */

2013-01-09T05:47:42Z

‎Logout

MetrixAdmin: /* Optional Parameters */

2013-01-09T05:43:14Z

‎Optional Parameters

MetrixAdmin: /* Signup */

2013-01-09T05:42:07Z

‎Signup

MetrixAdmin: /* Logout */

2013-01-09T05:22:43Z

‎Logout

MetrixAdmin: /* Login */

2013-01-09T05:21:19Z

‎Login

MetrixJustin: /* Login */

2012-07-03T00:53:19Z

‎Login

MetrixJustin: /* Error Handling */

2012-07-03T00:52:28Z

‎Error Handling

← Older revision		Revision as of 05:48, 9 January 2013
Line 88:		Line 88:
	=== Required Parameters ===		=== Required Parameters ===

		+	* <code>action=forgotpassword</code>
	* <code>username</code>: the username of the user; an email address can also be passed to this same field as a convenience		* <code>username</code>: the username of the user; an email address can also be passed to this same field as a convenience

@@ Line 72: / Line 72: @@
 === Required Parameters ===
-None.
+* <code>action=logout</code>
 === Successful Response ===

@@ Line 29: / Line 29: @@
 === Required Parameters ===
 * <code>username</code>: the username of the user; this must adhere to the site restrictions for username requirements
 * <code>password</code>: the password of the user; this must adhere to the site restrictions for password requirements

← Older revision		Revision as of 05:47, 9 January 2013
Line 76:		Line 76:

	* <code>status=ok</code>		* <code>status=ok</code>
		+
		+	== Forgot Password ==
		+
		+	This API call is responsible for sending a forgot password email to a successful match of a username or email address.
		+
		+	=== Authentication Restrictions ===
		+
		+	None.
		+
		+	=== Required Parameters ===
		+
		+	* <code>username</code>: the username of the user; an email address can also be passed to this same field as a convenience
		+
		+	=== Successful Response ===
		+
		+	* <code>status=ok</code>: this response is returned regardless if the param:username field actually matches a user's username or email address; the reason for this is so that someone can't run a brute force attack and discover all the email addresses that belong to your users

@@ Line 36: / Line 36: @@
 * <code>password2</code>: this can be used to verify the user didn't make a typo mistake with their password choice
-* <code>phone<code>: the primary phone number for this user
+* <code>phone</code>: the primary phone number for this user
-* <code>fax<code>: the primary fax number for this user
+* <code>fax</code>: the primary fax number for this user
-* <code>dob<code>: the user's date of birth; this is
+* <code>dob</code>: the user's date of birth; this is
-* <code>sex<code>: the sex of the user
+* <code>sex</code>: the sex of the user
-* <code>description<code>: the bio of the user
+* <code>description</code>: the bio of the user
-* <code>display_name<code>: the display name of the user; this is a non-unique field and is used for display only
+* <code>display_name</code>: the display name of the user; this is a non-unique field and is used for display only
-* <code>display_status<code>: the display status of the user; this is common for social websites
+* <code>display_status</code>: the display status of the user; this is common for social websites
-* <code>billing_first_name<code>: the first name of the billing contact
+* <code>billing_first_name</code>: the first name of the billing contact
-* <code>billing_last_name<code>: the last name of the billing contact
+* <code>billing_last_name</code>: the last name of the billing contact
-* <code>billing_company<code>: the company name of the billing contact
+* <code>billing_company</code>: the company name of the billing contact
-* <code>billing_address<code>: the address of the billing contact
+* <code>billing_address</code>: the address of the billing contact
-* <code>billing_address2<code>: an optional 2nd line for the address of the billing contact
+* <code>billing_address2</code>: an optional 2nd line for the address of the billing contact
-* <code>billing_city<code>: the city of the billing contact
+* <code>billing_city</code>: the city of the billing contact
-* <code>billing_state<code>: the state of the billing contact
+* <code>billing_state</code>: the state of the billing contact
-* <code>billing_zip<code>: the zip code of the billing contact
+* <code>billing_zip</code>: the zip code of the billing contact
-* <code>billing_country<code>: the country of the billing contact
+* <code>billing_country</code>: the country of the billing contact
-* <code>billing_phone<code>: an optional phone number related to the billing contact
+* <code>billing_phone</code>: an optional phone number related to the billing contact
-* <code>billing_fax<code>: an optional fax number related to the billing contact
+* <code>billing_fax</code>: an optional fax number related to the billing contact
-* <code>billing_email<code>: an optional email related to the billing contact
+* <code>billing_email</code>: an optional email related to the billing contact
 * <code>attr:user:$name</code>: $name should be replaced by the name of any custom fields that have been created for all user objects; make sure to set the permission of "editable" on each custom field you want the user to be able to specify themselves

@@ Line 19: / Line 19: @@
 * <code>status=ok</code>
-= Signup =
+== Signup ==
 == Logout ==

← Older revision		Revision as of 05:22, 9 January 2013
Line 21:		Line 21:
	= Signup =		= Signup =

−	= Logout =	+	== Logout ==
		+
		+	This API call is responsible for logging out a user.
		+
		+	=== Authentication Restrictions ===
		+
		+	Any authenticated user.
		+
		+	=== Required Parameters ===
		+
		+	None.
		+
		+	=== Successful Response ===
		+
		+	* <code>status=ok</code>

@@ Line 1: / Line 1: @@
-= Login =
+= Authentication =
-== Post URL ==
+== Login ==
-The login post URL can be generated using the getLoginPostUrl() macro, or posting to getBasePostUrl() with an action of login.
+This API call is responsible for logging in a user.
-Example:
+=== Authentication Restrictions ===
-  <?cs call:getLoginPostUrl() ?>
-or
-  <?cs call:getBasePostUrl() ?>?action=login
-== Required Parameters ==
+None.
-  Username
-  Password
-== Optional Parameters ==
+=== Required Parameters ===
-  mode
-  continue
-  retry
-== Error Handling ==
+* <code>action=login</code>
-A failed form submission will populate MS.error in the retry page HDF with the reason why the form has failed.
+* <code>username</code>: the username of the user
-== Complete Example ==
+=== Successful Response ===
-  <nowiki><form action="<?cs call:getLoginPostUrl() ?>" method="post">
+* <code>status=ok</code>
-    <input type="hidden" name="continue" value="<?cs call:getPageUrl('successPage') ?>" />
-    <input type="hidden" name="retry" value="<?cs call:getPageUrl('retryPage') ?>" />
-−
-    <?cs if:MS.error ?>
-      <div id="error"><?cs var:MS.error ?></div>
-    <?cs /if ?>
-−
-    <label>Username</label>
-    <input type="text" name="username" value="" />
-−
-    <label>Password</label>
-    <input type="text" name="password" value="" />
-−
-    <input type="submit" value="Login" />
-  </form></nowiki>
 = Signup =
 = Logout =

← Older revision		Revision as of 00:53, 3 July 2012
Line 40:		Line 40:
	<input type="submit" value="Login" />		<input type="submit" value="Login" />
	</form></nowiki>		</form></nowiki>
		+
		+	= Signup =
		+
		+	= Logout =