[][src]Module factom::identity

Relating to identity functions.

Structs

ActiveIdKeys

active-identity-keys function

IdKeys

all-identity-keys function

Key

identity-key function

RemoveIdKey

remove-id-key function

Functions

active_id_keys

This command will return an identity’s set of public keys (in order of decreasing priority) that were active at a specific block, or at the most recent height if the "height" parameter is not included. This is useful for validating entries containing identity signatures (e.g. on identity attributes and endorsements), allowing you to tell if a given signature was created with a key that was valid at the time that the entry was published. Time is measured in directory blocks.

all_id_keys

Returns all of the identity key pairs that are currently stored in the wallet. If the wallet is encrypted, it must be unlocked prior to using this command.

id_key

Given an identity public key as input, this command will respond with the corresponding public/private key pair from the wallet. If the desired identity key isn’t currently stored in the wallet, an error is returned to indicate this. If the wallet is encrypted, it must be unlocked prior to using this command.

remove_id_key

Be careful using this function! Ensure that you have backups of important keys before removing them. Given an identity public key, this command deletes the corresponding identity key pair from the wallet. Once executed, the user will no longer be able to retrieve that key pair or sign attributes/endorsements with the key pair from this wallet. If the wallet is encrypted, it must be unlocked prior to using this command.