# Class KeyRef

- [TopLevel.Object](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md)
  - [dw.crypto.KeyRef](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.crypto.KeyRef.md)

This class is used as a reference to a private key in the keystore
which can be managed in the Business Manager.

**Note:** this class handles sensitive security-related data.
Pay special attention to PCI DSS v3. requirements 2, 4, and 12.

## Constructor Summary

| Constructor                                                                                                                                                                                                | Description                               |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
| [KeyRef](#keyrefstring)([String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md))                                                                                                | Creates a `KeyRef` from the passed alias. |
| ~~[KeyRef](#keyrefstring-string)([String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md), [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md))~~ | Creates a `KeyRef` from the passed alias. |

## Method Summary

| Method                                                                                           | Description                                       |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------- |
| [toString](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.crypto.KeyRef.md#tostring)() | Returns the string representation of this KeyRef. |

### Methods inherited from class Object

[assign](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#assignobject-object), [create](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#createobject), [create](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#createobject-object), [defineProperties](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#definepropertiesobject-object), [defineProperty](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#definepropertyobject-object-object), [entries](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#entriesobject), [freeze](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#freezeobject), [fromEntries](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#hasownpropertystring), [is](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#isobject-object), [isExtensible](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#isextensibleobject), [isFrozen](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#isfrozenobject), [isPrototypeOf](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#isprototypeofobject), [isSealed](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#issealedobject), [keys](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#keysobject), [preventExtensions](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#propertyisenumerablestring), [seal](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#sealobject), [setPrototypeOf](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#tolocalestring), [toString](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#tostring), [valueOf](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#valueof), [values](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#valuesobject)

## Constructor Details

### KeyRef(String)

- KeyRef(alias: [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md))
  - : Creates a `KeyRef` from the passed alias. No check
    is made whether the alias is actually referring to a key in the keystore,
    this check is made when the `KeyRef` is used.

    **Parameters:**

    - alias - an alias that should refer to a key in the keystore.

***

### KeyRef(String, String)

- ~~KeyRef(alias: [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md), password: [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md))~~
  - : Creates a `KeyRef` from the passed alias. No check
    is made whether the alias is actually referring to a key in the keystore,
    this check is made when the `KeyRef` is used.

    **Parameters:**

    - alias - an alias that should refer to a key in the keystore.
    - password - the password that should be used to get the key from the keystore.

    **Deprecated:**

:::warning
use [KeyRef(String)](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.crypto.KeyRef.md#keyrefstring) instead
:::

***

## Method Details

### toString()

- toString(): [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md)
  - : Returns the string representation of this KeyRef.

    **Returns:**

    - The string representation of this KeyRef.

***