fireblocks_sdk::apis::key_link_api

Trait KeyLinkApi

Source 
pub trait KeyLinkApi: Send + Sync {
    // Required methods
    fn create_signing_key<'life0, 'async_trait>(
        &'life0 self,
        params: CreateSigningKeyParams,
    ) -> Pin<Box<dyn Future<Output = Result<SigningKeyDto, Error<CreateSigningKeyError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn create_validation_key<'life0, 'async_trait>(
        &'life0 self,
        params: CreateValidationKeyParams,
    ) -> Pin<Box<dyn Future<Output = Result<CreateValidationKeyResponseDto, Error<CreateValidationKeyError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn disable_validation_key<'life0, 'async_trait>(
        &'life0 self,
        params: DisableValidationKeyParams,
    ) -> Pin<Box<dyn Future<Output = Result<ValidationKeyDto, Error<DisableValidationKeyError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_signing_key<'life0, 'async_trait>(
        &'life0 self,
        params: GetSigningKeyParams,
    ) -> Pin<Box<dyn Future<Output = Result<SigningKeyDto, Error<GetSigningKeyError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_signing_keys_list<'life0, 'async_trait>(
        &'life0 self,
        params: GetSigningKeysListParams,
    ) -> Pin<Box<dyn Future<Output = Result<GetSigningKeyResponseDto, Error<GetSigningKeysListError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_validation_key<'life0, 'async_trait>(
        &'life0 self,
        params: GetValidationKeyParams,
    ) -> Pin<Box<dyn Future<Output = Result<ValidationKeyDto, Error<GetValidationKeyError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_validation_keys_list<'life0, 'async_trait>(
        &'life0 self,
        params: GetValidationKeysListParams,
    ) -> Pin<Box<dyn Future<Output = Result<GetValidationKeyResponseDto, Error<GetValidationKeysListError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn set_agent_id<'life0, 'async_trait>(
        &'life0 self,
        params: SetAgentIdParams,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error<SetAgentIdError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn update_signing_key<'life0, 'async_trait>(
        &'life0 self,
        params: UpdateSigningKeyParams,
    ) -> Pin<Box<dyn Future<Output = Result<SigningKeyDto, Error<UpdateSigningKeyError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
}

Required Methods§

Source

fn create_signing_key<'life0, 'async_trait>( &'life0 self, params: CreateSigningKeyParams, ) -> Pin<Box<dyn Future<Output = Result<SigningKeyDto, Error<CreateSigningKeyError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

POST /key_link/signing_keys

Adds a new signing key to the workspace. The added key will be linked to the specific Fireblocks agent user ID. The same user will receive the proof of ownership message to be signed, and upon successful proof, the key will become enabled. Please note that this endpoint is available only for Key Link enabled workspaces.
Endpoint Permission: Admin and Non-Signing Admin.

Source

fn create_validation_key<'life0, 'async_trait>( &'life0 self, params: CreateValidationKeyParams, ) -> Pin<Box<dyn Future<Output = Result<CreateValidationKeyResponseDto, Error<CreateValidationKeyError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

POST /key_link/validation_keys

Adds a new validation key used to validate signing keys. The new validation key will undergo an approval process by the workspace quorum. Please note that this endpoint is available only for Key Link enabled workspaces.
Endpoint Permission: Admin and Non-Signing Admin.

Source

fn disable_validation_key<'life0, 'async_trait>( &'life0 self, params: DisableValidationKeyParams, ) -> Pin<Box<dyn Future<Output = Result<ValidationKeyDto, Error<DisableValidationKeyError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

PATCH /key_link/validation_keys/{keyId}

Allows disabling validation key even if it has not expired yet. It is not allowed to enable the validation key back. Another key has to be used for future validations. Please note that this endpoint is available only for Key Link enabled workspaces.
Endpoint Permission: Admin and Non-Signing Admin.

Source

fn get_signing_key<'life0, 'async_trait>( &'life0 self, params: GetSigningKeyParams, ) -> Pin<Box<dyn Future<Output = Result<SigningKeyDto, Error<GetSigningKeyError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /key_link/signing_keys/{keyId}

Returns a signing key if it exists, identified by the specified Fireblocks provided keyId. Please note that this endpoint is available only for Key Link enabled workspaces.
Endpoint Permission: Admin and Non-Signing Admin.

Source

fn get_signing_keys_list<'life0, 'async_trait>( &'life0 self, params: GetSigningKeysListParams, ) -> Pin<Box<dyn Future<Output = Result<GetSigningKeyResponseDto, Error<GetSigningKeysListError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /key_link/signing_keys

Returns the list of signing keys in the workspace Please note that this endpoint is available only for Key Link enabled workspaces.
Endpoint Permission: Admin and Non-Signing Admin.

Source

fn get_validation_key<'life0, 'async_trait>( &'life0 self, params: GetValidationKeyParams, ) -> Pin<Box<dyn Future<Output = Result<ValidationKeyDto, Error<GetValidationKeyError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /key_link/validation_keys/{keyId}

Returns a validation key if it exists, identified by the specified keyId. Please note that this endpoint is available only for Key Link enabled workspaces.
Endpoint Permission: Admin and Non-Signing Admin.

Source

fn get_validation_keys_list<'life0, 'async_trait>( &'life0 self, params: GetValidationKeysListParams, ) -> Pin<Box<dyn Future<Output = Result<GetValidationKeyResponseDto, Error<GetValidationKeysListError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /key_link/validation_keys

Returns the list of validation keys in the workspace Please note that this endpoint is available only for Key Link enabled workspaces.
Endpoint Permission: Admin and Non-Signing Admin.

Source

fn set_agent_id<'life0, 'async_trait>( &'life0 self, params: SetAgentIdParams, ) -> Pin<Box<dyn Future<Output = Result<(), Error<SetAgentIdError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

PATCH /key_link/signing_keys/{keyId}/agent_user_id

Can modify existing signing key id if the key is not enabled. The change done in background and will be visible once applied. If key is already enabled (after proof of ownership) the user cannot be changed. Please note that this endpoint is available only for Key Link enabled workspaces.
Endpoint Permission: Admin and Non-Signing Admin.

Source

fn update_signing_key<'life0, 'async_trait>( &'life0 self, params: UpdateSigningKeyParams, ) -> Pin<Box<dyn Future<Output = Result<SigningKeyDto, Error<UpdateSigningKeyError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

PATCH /key_link/signing_keys/{keyId}

Allows assigning the signing key to a vault account, if it hasn’t been assigned to any other vault accounts yet. Please note that this endpoint is available only for Key Link enabled workspaces.
Endpoint Permission: Admin and Non-Signing Admin.

Implementors§