createKey

Creates and saves a cryptographic key in the OS key chain.

Field Configurations

Key	Type	Description	Default Value
"params" (required)	Object	undefined	null

Parameters

Key	Type	Description	Default Value
"async"	Boolean	Specifies whether the action should perform asynchronously.	null
"name" (required)	String	The name of the cryptographic key for later usage.	null
"onError"	String	Event that will be fired if the decryption was successfull.	null
"onErrorType"	OnErrorType	Type of event that will be fired on error.	null
"onSuccess"	String	Event that will be fired if the decryption was successfull.	null
"onSuccessType"	OnSuccessType	Type of event that will be fired on success.	null
"type" (required)	String	The type of the cryptographic key.	null

Inherited

From Base Action

Base Action

Field Configurations

Key	Type	Description	Default Value
"dynamicParams"	Object	Dynamic params to retrieve data from a specific context e.g. a userSetting.	null
"leadingDelimiter"	String	The leading mustache delimiter to use.	null
"params"	Object,Array	Object containing the properties of the action.	null
"trailingDelimiter"	String	The trailing mustache delimiter to use.	null
"type"	String	Type name of the action.	null

Examples

Example 1: Create an RSA key

Show ExampleHide Example

Goal: An RSA key is created and ready to be used.

Creates a RSA key with the name primaryKey which is stored in the OS key chain. It can later be used for decryption.

{
  "type": "createKey",
  "params": {
    "name": "primaryKey"
  }
}