factom_sdk.utils.identities package¶
Submodules¶
factom_sdk.utils.identities.identities_key_util module¶
-
class
factom_sdk.utils.identities.identities_key_util.IdentitiesKeyUtil(base_url: str, app_id: str, app_key: str)¶ Bases:
object-
get(identity_chain_id: str, key: str)¶ Gets information about a specific public key for a given Identity, including the heights at which the key was activated and retired if applicable.
- Args:
- identity_chain_id (str): The unique identifier for the Identity that the key belongs to. key (str): The public key string to get information, which must be in base58 idpub format.
- Returns:
- Identity key object.
-
list(identity_chain_id: str, limit: int = -1, offset: int = -1)¶ Returns all of the keys that were ever active for this Identity. Results are paginated.
- Args:
- identity_chain_id (str): The unique identifier of the identity chain whose keys are being requested.
limit (
int, optional): The maximum number of keys you would like to be returned. offset (int, optional): The key index (in number of keys from the first key) to start from in the list of all keys. - Returns:
- List identity key object.
-
replace(identity_chain_id: str, old_public_key: str, signer_private_key: str, new_public_key: str = None, callback_url: str = '', callback_stages: factom_sdk.utils.identities.identities_key_util.IdentitiesKeyUtil.list = None)¶ Creates an entry in the Identity Chain for a key replacement.
- Args:
- identity_chain_id (str): The unique identifier of the identity chain being requested.
old_public_key (str): base58 string in Idpub format. The public key to be retired and replaced.
signer_private_key (str): base58 string in Idsec format. The private key to use to create the signature,
which must be the same or higher priority than the public key to be replaced.
new_public_key (
str, optional): base58 string in Idpub format. The new public key to be activated and take its place. callback_url (str, optional): The URL you would like the callbacks to be sent to. callback_stages (list, optional): The immutability stages you’d like to be notified about. This list can include any or all of these three stages: replicated, factom, and anchored - Returns:
- Replacement result object.
-