HMAC SHA256 - List all user's shares

GET 
/hmac-sha256/list-key-shares

notice

This API endpoint part of the Exchange API Vault. Please contact the Sodot team for access.

authorization

This API endpoint requires an API Key with at least one of the following Roles: KeysManager

Lists all the key shares associated with an authenticated user.

Request

Header Parameters

AUTHORIZATION stringrequired

The AUTHORIZATION header must be set to the API Key of the user. The API Key is returned when a new user is created using the /admin/create-user endpoint.

Responses

200

application/json

Schema

Schema

key_shares

object[]

required

Array [

key_idKeyIdrequired

key_typeKeyTyperequired

Represents the various types of cryptographic keys supported in the system.

Possible values: [NotInititalizedYet, Ecdsa, Ed25519, ExportableEd25519, BIP340, Sr25519, HmacSha256]

key_users

object[]

required

Array [

usage_permissionKeyUsagePermissionrequired

Specifies the permission levels for key usage within the system.

Possible values: [use, admin]

user_idUserIdrequired

]

namestring | nullnullable

]

Example (from schema)

{
  "key_shares": [
    {
      "key_id": "string",
      "key_type": "NotInititalizedYet",
      "key_users": [
        {
          "usage_permission": "use",
          "user_id": "string"
        }
      ]
    }
  ]
}

400

application/json

Schema

Schema

err_msgstringrequired
err_typestringrequired

Possible values: [already_performed_keygen, api_key_not_found, bad_n_and_t_params, bad_request_params, batch_too_large, cant_delete_boot_admin, cluster_already_exists, cluster_not_found, executor_result, invalid_domain, key_not_found, key_operation_before_keygen, policy_already_exists, policy_in_use_by_keys, policy_in_use_by_users, policy_not_found, policy_validation_failed, room_creation_problem, rule_already_exists, rule_in_use, rule_not_found, rule_not_in_policy, server_share_backup_setting_disabled, server_share_backup_setting_incompatible, user_already_exists, user_has_associated_keys, user_not_found, vertex_already_exists, vertex_not_found]

Example (from schema)

{
  "err_msg": "string",
  "err_type": "already_performed_keygen"
}

401

application/json

Schema

Schema

err_msgstringrequired
err_typestringrequired

Possible values: [access_denied, bad_key_permission]

Example (from schema)

{
  "err_msg": "string",
  "err_type": "access_denied"
}

404

application/json

Schema

Schema

err_msgstringrequired
err_typestringrequired

Possible values: [not_found]

Example (from schema)

{
  "err_msg": "string",
  "err_type": "not_found"
}

500

application/json

Schema

Schema

err_msgstringrequired
err_typestringrequired

Possible values: [internal_problem]

Example (from schema)

{
  "err_msg": "string",
  "err_type": "internal_problem"
}