customer_password_hash_types : Foxy hAPI

customer_password_hash_types

Description

This property helper lets you know which password hashing mechanisms we support and you can use for your customer passwords. This is important if you're syncronizing your FoxyCart passwords with your own system in such a way as to keep the passwords functional in both places.

The values JSON object has the following properties

description: The human readable description of this password hashing mechanism.
config: The default configuration settings specific to this hashing mechanism.

Interact with this resource

To interact with this resource and see it in the context of the API, you can utilise Postman or your Terminal/Console to perform requests. If you have a Foxy store, you can also use the API browser in the admin to interact with resources connected to your store.

Actions

GET: View a customer_password_hash_types
HEAD: Get just the header response
OPTIONS: Get a response explaining which HTTP methods are supported

Properties

Property	Description	Type	Constraints
message	A small, human readable explanation of this property helper.	String	Read only
values	JSON objects with the password hash type as the object key. This key is the value you use for the Store resource's `customer_password_hash_type` property and the Customer resource's `password_hash_type` property.	JSON	Read only

Example Representation

{
    "_links": {
        "curies": [
            {
                "name": "fx",
                "href": "https://api.foxycart.com/rels/{rel}",
                "templated": true
            }
        ],
        "self": {
            "href": "https://api.foxycart.com/property_helpers/customer_password_hash_types",
            "title": "List of valid customer password hash type values for the Store resource customer_password_hash_type setting."
        },
        "fx:property_helpers": {
            "href": "https://api.foxycart.com/property_helpers",
            "title": "Property Helpers Home"
        }
    },
    "message": "The values listed here are the correct values for the Store customer_password_hash_type field. The values are listed in the format value => description.",
    "values": {
        "joomla": {
            "description": "Joomla (v1.0.13+)",
            "config": 32
        },
        "drupal": {
            "description": "Drupal SHA512",
            "config": 15
        },
        "craftcms": {
            "description": "Craft CMS",
            "config": 13
        },
        "magento": {
            "description": "Magento MD5",
            "config": 2
        },
        "bcrypt": {
            "description": "BCrypt (with cost)",
            "config": 15
        }
        ...
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<resource href="https://api.foxycart.com/property_helpers/customer_password_hash_types">
  <link rel="self" href="https://api.foxycart.com/property_helpers/customer_password_hash_types" title="List of valid customer password hash type values for the Store resource customer_password_hash_type setting."/>
  <link rel="https://api.foxycart.com/rels/property_helpers" href="https://api.foxycart.com/property_helpers" title="Property Helpers Home"/>
  <message>The values listed here are the correct values for the Store customer_password_hash_type field. The values are listed in the format value =&amp;gt; description.</message>
  <values>
    <phpass>
      <description>phpass, portable mode (Wordpress, osCommerce 2.3+, etc.)</description>
      <config>8</config>
    </phpass>
    <bcrypt>
      <description>BCrypt (with cost)</description>
      <config>15</config>
    </bcrypt>
    ...
  </values>
</resource>

{
    "properties": {
        "message": "The values listed here are the correct values for the Store customer_password_hash_type field. The values are listed in the format value => description.",
        "values": {
            "phpass": {
                "description": "phpass, portable mode (Wordpress, osCommerce 2.3+, etc.)",
                "config": 8
            },
            "drupal": {
                "description": "Drupal SHA512",
                "config": 15
            },
            "bcrypt": {
                "description": "BCrypt (with cost)",
                "config": 15
            },
            ...
        }
    },
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "https://api.foxycart.com/property_helpers/customer_password_hash_types"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/property_helpers"
            ],
            "href": "https://api.foxycart.com/property_helpers"
        }
    ]
}

Zoomable Resources

This resource has no linked resources which can be "zoomed" in on, filtered and embedded within this resource.