fireblocks_sdk::apis::workspace_management_api

Trait WorkspaceManagementApi

Source 
pub trait WorkspaceManagementApi: Send + Sync {

Show 17 methods    // Required methods
    fn create_api_user<'life0, 'async_trait>(
        &'life0 self,
        params: CreateApiUserParams,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error<CreateApiUserError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn create_console_user<'life0, 'async_trait>(
        &'life0 self,
        params: CreateConsoleUserParams,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error<CreateConsoleUserError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn create_user_group<'life0, 'async_trait>(
        &'life0 self,
        params: CreateUserGroupParams,
    ) -> Pin<Box<dyn Future<Output = Result<CreateUserGroupResponse, Error<CreateUserGroupError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn delete_user_group<'life0, 'async_trait>(
        &'life0 self,
        params: DeleteUserGroupParams,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error<DeleteUserGroupError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_api_users<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = Result<GetApiUsersResponse, Error<GetApiUsersError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_audit_logs<'life0, 'async_trait>(
        &'life0 self,
        params: GetAuditLogsParams,
    ) -> Pin<Box<dyn Future<Output = Result<GetAuditLogsResponse, Error<GetAuditLogsError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_audits<'life0, 'async_trait>(
        &'life0 self,
        params: GetAuditsParams,
    ) -> Pin<Box<dyn Future<Output = Result<GetAuditLogsResponseDto, Error<GetAuditsError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_console_users<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = Result<GetConsoleUsersResponse, Error<GetConsoleUsersError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_ota_status<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = Result<GetOtaStatusResponse, Error<GetOtaStatusError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_user_group<'life0, 'async_trait>(
        &'life0 self,
        params: GetUserGroupParams,
    ) -> Pin<Box<dyn Future<Output = Result<UserGroupResponse, Error<GetUserGroupError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_user_groups<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<UserGroupResponse>, Error<GetUserGroupsError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_users<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<UserResponse>, Error<GetUsersError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_whitelist_ip_addresses<'life0, 'async_trait>(
        &'life0 self,
        params: GetWhitelistIpAddressesParams,
    ) -> Pin<Box<dyn Future<Output = Result<GetWhitelistIpAddressesResponse, Error<GetWhitelistIpAddressesError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_workspace_status<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = Result<GetWorkspaceStatusResponse, Error<GetWorkspaceStatusError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn reset_device<'life0, 'async_trait>(
        &'life0 self,
        params: ResetDeviceParams,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error<ResetDeviceError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn set_ota_status<'life0, 'async_trait>(
        &'life0 self,
        params: SetOtaStatusParams,
    ) -> Pin<Box<dyn Future<Output = Result<SetOtaStatusResponse, Error<SetOtaStatusError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn update_user_group<'life0, 'async_trait>(
        &'life0 self,
        params: UpdateUserGroupParams,
    ) -> Pin<Box<dyn Future<Output = Result<UserGroupCreateResponse, Error<UpdateUserGroupError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;

}

Required Methods§

Source

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

POST /management/api_users

Create a new API key in your workspace. Learn more about Fireblocks API Keys management in the following guide.
Endpoint Permission: Admin, Non-Signing Admin.

Source

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

POST /management/users

Create console users in your workspace - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. Learn more about Fireblocks Users management in the following guide.
Endpoint Permission: Admin, Non-Signing Admin.

Source

fn create_user_group<'life0, 'async_trait>( &'life0 self, params: CreateUserGroupParams, ) -> Pin<Box<dyn Future<Output = Result<CreateUserGroupResponse, Error<CreateUserGroupError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

POST /management/user_groups

Create a new user group. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. Learn more about Fireblocks Users management in the following guide.
Endpoint Permission: Admin, Non-Signing Admin.

Source

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

DELETE /management/user_groups/{groupId}

Delete a user group by ID.
- Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions.
Endpoint Permission: Admin, Non-Signing Admin.

Source

fn get_api_users<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<GetApiUsersResponse, Error<GetApiUsersError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /management/api_users

List all API keys in your workspace. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions.
Endpoint Permission: Admin, Non-Signing Admin.

Source

fn get_audit_logs<'life0, 'async_trait>( &'life0 self, params: GetAuditLogsParams, ) -> Pin<Box<dyn Future<Output = Result<GetAuditLogsResponse, Error<GetAuditLogsError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /management/audit_logs

Get Audit logs for the last Day/Week. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions.
Endpoint Permission: Admin, Non-Signing Admin.

Source

fn get_audits<'life0, 'async_trait>( &'life0 self, params: GetAuditsParams, ) -> Pin<Box<dyn Future<Output = Result<GetAuditLogsResponseDto, Error<GetAuditsError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /audits

Deprecated. Please use the GET /management/audit_logs endpoint instead.
Endpoint Permission: Admin, Non-Signing Admin.

Source

fn get_console_users<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<GetConsoleUsersResponse, Error<GetConsoleUsersError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /management/users

Get console users for your workspace. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions.
Endpoint Permission: Admin, Non-Signing Admin.

Source

fn get_ota_status<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<GetOtaStatusResponse, Error<GetOtaStatusError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /management/ota

Returns current One Time Address status. Learn more about One Time Addresses - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions.
Endpoint Permission: Admin, Non-Signing Admin.

Source

fn get_user_group<'life0, 'async_trait>( &'life0 self, params: GetUserGroupParams, ) -> Pin<Box<dyn Future<Output = Result<UserGroupResponse, Error<GetUserGroupError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /management/user_groups/{groupId}

Get a user group by ID - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions.
Endpoint Permission: Admin, Non-Signing Admin.

Source

fn get_user_groups<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<UserGroupResponse>, Error<GetUserGroupsError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /management/user_groups

Get all user groups in your workspace - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions.
Endpoint Permission: Admin, Non-Signing Admin.

Source

fn get_users<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<UserResponse>, Error<GetUsersError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /users

DEPRECATED - please use GET /management/users instead
Endpoint Permission: Admin, Non-Signing Admin.

Source

fn get_whitelist_ip_addresses<'life0, 'async_trait>( &'life0 self, params: GetWhitelistIpAddressesParams, ) -> Pin<Box<dyn Future<Output = Result<GetWhitelistIpAddressesResponse, Error<GetWhitelistIpAddressesError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /management/api_users/{userId}/whitelist_ip_addresses

Get a list of the whitelisted IP addresses for a specific API Key - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions.
Endpoint Permission: Admin, Non-Signing Admin.

Source

fn get_workspace_status<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<GetWorkspaceStatusResponse, Error<GetWorkspaceStatusError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /management/workspace_status

Returns current workspace status (Beta). Note: - This endpoint is now in Beta, disabled for general availability at this time. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions.
Endpoint Permission: Admin, Non-Signing Admin.

Source

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

POST /management/users/{id}/reset_device

Resets mobile device for given console user, that user will need to do mobile onboarding again. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions.
Endpoint Permission: Admin, Non-Signing Admin.

Source

fn set_ota_status<'life0, 'async_trait>( &'life0 self, params: SetOtaStatusParams, ) -> Pin<Box<dyn Future<Output = Result<SetOtaStatusResponse, Error<SetOtaStatusError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

PUT /management/ota

Enable or disable transactions to One Time Addresses (Non Whitelisted addresses). Learn more about One Time Addresses - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions.
Endpoint Permission: Admin, Non-Signing Admin.

Source

fn update_user_group<'life0, 'async_trait>( &'life0 self, params: UpdateUserGroupParams, ) -> Pin<Box<dyn Future<Output = Result<UserGroupCreateResponse, Error<UpdateUserGroupError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

PUT /management/user_groups/{groupId}

Update a user group by ID - Please note that this endpoint is available only for API keys with Admin permissions.
Endpoint Permission: Admin, Non-Signing Admin.

Implementors§