Struct TurnkeyClient 

pub struct TurnkeyClient<S: Stamp> { /* private fields */ }

Base client. To create a new client, see TurnkeyClient::<S>::builder.

Implementations

impl<S: Stamp> TurnkeyClient<S>

pub async fn get_whoami( &self, request: GetWhoamiRequest, ) -> Result<GetWhoamiResponse, TurnkeyClientError>

Who am I?

Get basic information about your current API or WebAuthN user and their organization. Affords sub-organization look ups via parent organization for WebAuthN or API key users.

pub async fn get_sub_org_ids( &self, request: GetSubOrgIdsRequest, ) -> Result<GetSubOrgIdsResponse, TurnkeyClientError>

Get sub-organizations

Get all suborg IDs associated given a parent org ID and an optional filter.

pub async fn get_verified_sub_org_ids( &self, request: GetVerifiedSubOrgIdsRequest, ) -> Result<GetVerifiedSubOrgIdsResponse, TurnkeyClientError>

Get verified sub-organizations

Get all email or phone verified suborg IDs associated given a parent org ID.

pub async fn get_activity( &self, request: GetActivityRequest, ) -> Result<ActivityResponse, TurnkeyClientError>

Get activity

Get details about an activity.

pub async fn get_activities( &self, request: GetActivitiesRequest, ) -> Result<GetActivitiesResponse, TurnkeyClientError>

List activities

List all activities within an organization.

pub async fn approve_activity( &self, organization_id: String, timestamp_ms: u128, params: ApproveActivityIntent, ) -> Result<Activity, TurnkeyClientError>

Approve activity

Approve an activity.

pub async fn reject_activity( &self, organization_id: String, timestamp_ms: u128, params: RejectActivityIntent, ) -> Result<Activity, TurnkeyClientError>

Reject activity

Reject an activity.

pub async fn get_user( &self, request: GetUserRequest, ) -> Result<GetUserResponse, TurnkeyClientError>

Get user

Get details about a user.

pub async fn get_users( &self, request: GetUsersRequest, ) -> Result<GetUsersResponse, TurnkeyClientError>

List users

List all users within an organization.

pub async fn delete_users( &self, organization_id: String, timestamp_ms: u128, params: DeleteUsersIntent, ) -> Result<ActivityResult<DeleteUsersResult>, TurnkeyClientError>

Delete users

Delete users within an organization.

pub async fn create_policy( &self, organization_id: String, timestamp_ms: u128, params: CreatePolicyIntentV3, ) -> Result<ActivityResult<CreatePolicyResult>, TurnkeyClientError>

Create policy

Create a new policy.

pub async fn create_policies( &self, organization_id: String, timestamp_ms: u128, params: CreatePoliciesIntent, ) -> Result<ActivityResult<CreatePoliciesResult>, TurnkeyClientError>

Create policies

Create new policies.

pub async fn update_policy( &self, organization_id: String, timestamp_ms: u128, params: UpdatePolicyIntentV2, ) -> Result<ActivityResult<UpdatePolicyResultV2>, TurnkeyClientError>

Update policy

Update an existing policy.

pub async fn delete_policy( &self, organization_id: String, timestamp_ms: u128, params: DeletePolicyIntent, ) -> Result<ActivityResult<DeletePolicyResult>, TurnkeyClientError>

Delete policy

Delete an existing policy.

pub async fn delete_policies( &self, organization_id: String, timestamp_ms: u128, params: DeletePoliciesIntent, ) -> Result<ActivityResult<DeletePoliciesResult>, TurnkeyClientError>

Delete policies

Delete existing policies.

pub async fn get_policies( &self, request: GetPoliciesRequest, ) -> Result<GetPoliciesResponse, TurnkeyClientError>

List policies

List all policies within an organization.

pub async fn get_policy( &self, request: GetPolicyRequest, ) -> Result<GetPolicyResponse, TurnkeyClientError>

Get policy

Get details about a policy.

pub async fn create_read_only_session( &self, organization_id: String, timestamp_ms: u128, params: CreateReadOnlySessionIntent, ) -> Result<ActivityResult<CreateReadOnlySessionResult>, TurnkeyClientError>

Create read only session

Create a read only session for a user (valid for 1 hour).

pub async fn create_read_write_session( &self, organization_id: String, timestamp_ms: u128, params: CreateReadWriteSessionIntentV2, ) -> Result<ActivityResult<CreateReadWriteSessionResultV2>, TurnkeyClientError>

Create read write session

Create a read write session for a user.

pub async fn oauth_login( &self, organization_id: String, timestamp_ms: u128, params: OauthLoginIntent, ) -> Result<ActivityResult<OauthLoginResult>, TurnkeyClientError>

Login with Oauth

Create an Oauth session for a user.

pub async fn stamp_login( &self, organization_id: String, timestamp_ms: u128, params: StampLoginIntent, ) -> Result<ActivityResult<StampLoginResult>, TurnkeyClientError>

Login with a stamp

Create a session for a user through stamping client side (API key, wallet client, or passkey client).

pub async fn otp_login( &self, organization_id: String, timestamp_ms: u128, params: OtpLoginIntentV2, ) -> Result<ActivityResult<OtpLoginResult>, TurnkeyClientError>

Login with OTP

Create an OTP session for a user.

pub async fn create_private_keys( &self, organization_id: String, timestamp_ms: u128, params: CreatePrivateKeysIntentV2, ) -> Result<ActivityResult<CreatePrivateKeysResultV2>, TurnkeyClientError>

Create private keys

Create new private keys.

pub async fn get_private_key( &self, request: GetPrivateKeyRequest, ) -> Result<GetPrivateKeyResponse, TurnkeyClientError>

Get private key

Get details about a private key.

pub async fn get_private_keys( &self, request: GetPrivateKeysRequest, ) -> Result<GetPrivateKeysResponse, TurnkeyClientError>

List private keys

List all private keys within an organization.

pub async fn create_api_keys( &self, organization_id: String, timestamp_ms: u128, params: CreateApiKeysIntentV2, ) -> Result<ActivityResult<CreateApiKeysResult>, TurnkeyClientError>

Create API keys

Add API keys to an existing user.

pub async fn delete_api_keys( &self, organization_id: String, timestamp_ms: u128, params: DeleteApiKeysIntent, ) -> Result<ActivityResult<DeleteApiKeysResult>, TurnkeyClientError>

Delete API keys

Remove api keys from a user.

pub async fn get_oauth_providers( &self, request: GetOauthProvidersRequest, ) -> Result<GetOauthProvidersResponse, TurnkeyClientError>

Get Oauth providers

Get details about Oauth providers for a user.

pub async fn get_api_keys( &self, request: GetApiKeysRequest, ) -> Result<GetApiKeysResponse, TurnkeyClientError>

Get API keys

Get details about API keys for a user.

pub async fn get_on_ramp_transaction_status( &self, request: GetOnRampTransactionStatusRequest, ) -> Result<GetOnRampTransactionStatusResponse, TurnkeyClientError>

Get On Ramp transaction status

Get the status of an on ramp transaction.

pub async fn get_send_transaction_status( &self, request: GetSendTransactionStatusRequest, ) -> Result<GetSendTransactionStatusResponse, TurnkeyClientError>

Get send transaction status

Get the status of a send transaction request.

pub async fn get_api_key( &self, request: GetApiKeyRequest, ) -> Result<GetApiKeyResponse, TurnkeyClientError>

Get API key

Get details about an API key.

pub async fn create_authenticators( &self, organization_id: String, timestamp_ms: u128, params: CreateAuthenticatorsIntentV2, ) -> Result<ActivityResult<CreateAuthenticatorsResult>, TurnkeyClientError>

Create authenticators

Create authenticators to authenticate requests to Turnkey.

pub async fn delete_authenticators( &self, organization_id: String, timestamp_ms: u128, params: DeleteAuthenticatorsIntent, ) -> Result<ActivityResult<DeleteAuthenticatorsResult>, TurnkeyClientError>

Delete authenticators

Remove authenticators from a user.

pub async fn get_authenticators( &self, request: GetAuthenticatorsRequest, ) -> Result<GetAuthenticatorsResponse, TurnkeyClientError>

Get authenticators

Get details about authenticators for a user.

pub async fn get_authenticator( &self, request: GetAuthenticatorRequest, ) -> Result<GetAuthenticatorResponse, TurnkeyClientError>

Get authenticator

Get details about an authenticator.

pub async fn create_invitations( &self, organization_id: String, timestamp_ms: u128, params: CreateInvitationsIntent, ) -> Result<ActivityResult<CreateInvitationsResult>, TurnkeyClientError>

Create invitations

Create invitations to join an existing organization.

pub async fn delete_invitation( &self, organization_id: String, timestamp_ms: u128, params: DeleteInvitationIntent, ) -> Result<ActivityResult<DeleteInvitationResult>, TurnkeyClientError>

Delete invitation

Delete an existing invitation.

pub async fn create_users( &self, organization_id: String, timestamp_ms: u128, params: CreateUsersIntentV4, ) -> Result<ActivityResult<CreateUsersResult>, TurnkeyClientError>

Create users

Create users in an existing organization. Each user must have at least one valid credential: an API key, an authenticator, an OAuth provider, or an email or phone number with a login method enabled on the organization (email, email OTP, or SMS).

pub async fn update_user( &self, organization_id: String, timestamp_ms: u128, params: UpdateUserIntent, ) -> Result<ActivityResult<UpdateUserResult>, TurnkeyClientError>

Update user

Update a user in an existing organization.

pub async fn update_user_name( &self, organization_id: String, timestamp_ms: u128, params: UpdateUserNameIntent, ) -> Result<ActivityResult<UpdateUserNameResult>, TurnkeyClientError>

Update user’s name

Update a user’s name in an existing organization.

pub async fn update_user_email( &self, organization_id: String, timestamp_ms: u128, params: UpdateUserEmailIntent, ) -> Result<ActivityResult<UpdateUserEmailResult>, TurnkeyClientError>

Update user’s email

Update a user’s email in an existing organization.

pub async fn update_user_phone_number( &self, organization_id: String, timestamp_ms: u128, params: UpdateUserPhoneNumberIntent, ) -> Result<ActivityResult<UpdateUserPhoneNumberResult>, TurnkeyClientError>

Update user’s phone number

Update a user’s phone number in an existing organization.

pub async fn create_user_tag( &self, organization_id: String, timestamp_ms: u128, params: CreateUserTagIntent, ) -> Result<ActivityResult<CreateUserTagResult>, TurnkeyClientError>

Create user tag

Create a user tag and add it to users.

pub async fn create_private_key_tag( &self, organization_id: String, timestamp_ms: u128, params: CreatePrivateKeyTagIntent, ) -> Result<ActivityResult<CreatePrivateKeyTagResult>, TurnkeyClientError>

Create private key tag

Create a private key tag and add it to private keys.

pub async fn update_user_tag( &self, organization_id: String, timestamp_ms: u128, params: UpdateUserTagIntent, ) -> Result<ActivityResult<UpdateUserTagResult>, TurnkeyClientError>

Update user tag

Update human-readable name or associated users. Note that this activity is atomic: all of the updates will succeed at once, or all of them will fail.

pub async fn list_user_tags( &self, request: ListUserTagsRequest, ) -> Result<ListUserTagsResponse, TurnkeyClientError>

List user tags

List all user tags within an organization.

pub async fn delete_user_tags( &self, organization_id: String, timestamp_ms: u128, params: DeleteUserTagsIntent, ) -> Result<ActivityResult<DeleteUserTagsResult>, TurnkeyClientError>

Delete user tags

Delete user tags within an organization.

pub async fn update_private_key_tag( &self, organization_id: String, timestamp_ms: u128, params: UpdatePrivateKeyTagIntent, ) -> Result<ActivityResult<UpdatePrivateKeyTagResult>, TurnkeyClientError>

Update private key tag

Update human-readable name or associated private keys. Note that this activity is atomic: all of the updates will succeed at once, or all of them will fail.

pub async fn list_private_key_tags( &self, request: ListPrivateKeyTagsRequest, ) -> Result<ListPrivateKeyTagsResponse, TurnkeyClientError>

List private key tags

List all private key tags within an organization.

pub async fn delete_private_key_tags( &self, organization_id: String, timestamp_ms: u128, params: DeletePrivateKeyTagsIntent, ) -> Result<ActivityResult<DeletePrivateKeyTagsResult>, TurnkeyClientError>

Delete private key tags

Delete private key tags within an organization.

pub async fn sign_raw_payload( &self, organization_id: String, timestamp_ms: u128, params: SignRawPayloadIntentV2, ) -> Result<ActivityResult<SignRawPayloadResult>, TurnkeyClientError>

Sign raw payload

Sign a raw payload.

pub async fn sign_raw_payloads( &self, organization_id: String, timestamp_ms: u128, params: SignRawPayloadsIntent, ) -> Result<ActivityResult<SignRawPayloadsResult>, TurnkeyClientError>

Sign raw payloads

Sign multiple raw payloads with the same signing parameters.

pub async fn sign_transaction( &self, organization_id: String, timestamp_ms: u128, params: SignTransactionIntentV2, ) -> Result<ActivityResult<SignTransactionResult>, TurnkeyClientError>

Sign transaction

Sign a transaction.

pub async fn create_smart_contract_interface( &self, organization_id: String, timestamp_ms: u128, params: CreateSmartContractInterfaceIntent, ) -> Result<ActivityResult<CreateSmartContractInterfaceResult>, TurnkeyClientError>

Create smart contract interface

Create an ABI/IDL in JSON.

pub async fn delete_smart_contract_interface( &self, organization_id: String, timestamp_ms: u128, params: DeleteSmartContractInterfaceIntent, ) -> Result<ActivityResult<DeleteSmartContractInterfaceResult>, TurnkeyClientError>

Delete smart contract interface

Delete a smart contract interface.

pub async fn get_smart_contract_interfaces( &self, request: GetSmartContractInterfacesRequest, ) -> Result<GetSmartContractInterfacesResponse, TurnkeyClientError>

List smart contract interfaces

List all smart contract interfaces within an organization.

pub async fn get_smart_contract_interface( &self, request: GetSmartContractInterfaceRequest, ) -> Result<GetSmartContractInterfaceResponse, TurnkeyClientError>

Get smart contract interface

Get details about a smart contract interface.

pub async fn update_root_quorum( &self, organization_id: String, timestamp_ms: u128, params: UpdateRootQuorumIntent, ) -> Result<ActivityResult<UpdateRootQuorumResult>, TurnkeyClientError>

Update root quorum

Set the threshold and members of the root quorum. This activity must be approved by the current root quorum.

pub async fn create_wallet( &self, organization_id: String, timestamp_ms: u128, params: CreateWalletIntent, ) -> Result<ActivityResult<CreateWalletResult>, TurnkeyClientError>

Create wallet

Create a wallet and derive addresses.

pub async fn get_wallets( &self, request: GetWalletsRequest, ) -> Result<GetWalletsResponse, TurnkeyClientError>

List wallets

List all wallets within an organization.

pub async fn get_wallet( &self, request: GetWalletRequest, ) -> Result<GetWalletResponse, TurnkeyClientError>

Get wallet

Get details about a wallet.

pub async fn create_wallet_accounts( &self, organization_id: String, timestamp_ms: u128, params: CreateWalletAccountsIntent, ) -> Result<ActivityResult<CreateWalletAccountsResult>, TurnkeyClientError>

Create wallet accounts

Derive additional addresses using an existing wallet.

pub async fn get_wallet_accounts( &self, request: GetWalletAccountsRequest, ) -> Result<GetWalletAccountsResponse, TurnkeyClientError>

List wallets accounts

List all accounts within a wallet.

pub async fn get_wallet_account( &self, request: GetWalletAccountRequest, ) -> Result<GetWalletAccountResponse, TurnkeyClientError>

Get wallet account

Get a single wallet account.

pub async fn create_sub_organization( &self, organization_id: String, timestamp_ms: u128, params: CreateSubOrganizationIntentV8, ) -> Result<ActivityResult<CreateSubOrganizationResultV8>, TurnkeyClientError>

Create sub-organization

Create a new sub-organization. Each root user must have at least one valid credential: an API key, an authenticator, an OAuth provider, or an email or phone number with a login method enabled on the sub-organization (email, email OTP, or SMS).

pub async fn update_organization_name( &self, organization_id: String, timestamp_ms: u128, params: UpdateOrganizationNameIntent, ) -> Result<ActivityResult<UpdateOrganizationNameResult>, TurnkeyClientError>

Update organization name

Update the name of an organization.

pub async fn init_user_email_recovery( &self, organization_id: String, timestamp_ms: u128, params: InitUserEmailRecoveryIntentV2, ) -> Result<ActivityResult<InitUserEmailRecoveryResult>, TurnkeyClientError>

Init email recovery

Initialize a new email recovery.

pub async fn recover_user( &self, organization_id: String, timestamp_ms: u128, params: RecoverUserIntent, ) -> Result<ActivityResult<RecoverUserResult>, TurnkeyClientError>

Recover a user

Complete the process of recovering a user by adding an authenticator.

pub async fn set_organization_feature( &self, organization_id: String, timestamp_ms: u128, params: SetOrganizationFeatureIntent, ) -> Result<ActivityResult<SetOrganizationFeatureResult>, TurnkeyClientError>

Set organization feature

Set an organization feature. This activity must be approved by the current root quorum.

pub async fn remove_organization_feature( &self, organization_id: String, timestamp_ms: u128, params: RemoveOrganizationFeatureIntent, ) -> Result<ActivityResult<RemoveOrganizationFeatureResult>, TurnkeyClientError>

Remove organization feature

Remove an organization feature. This activity must be approved by the current root quorum.

pub async fn export_private_key( &self, organization_id: String, timestamp_ms: u128, params: ExportPrivateKeyIntent, ) -> Result<ActivityResult<ExportPrivateKeyResult>, TurnkeyClientError>

Export private key

Export a private key.

pub async fn export_wallet( &self, organization_id: String, timestamp_ms: u128, params: ExportWalletIntent, ) -> Result<ActivityResult<ExportWalletResult>, TurnkeyClientError>

Export wallet

Export a wallet.

pub async fn email_auth( &self, organization_id: String, timestamp_ms: u128, params: EmailAuthIntentV3, ) -> Result<ActivityResult<EmailAuthResult>, TurnkeyClientError>

Perform email auth

Authenticate a user via email.

pub async fn export_wallet_account( &self, organization_id: String, timestamp_ms: u128, params: ExportWalletAccountIntent, ) -> Result<ActivityResult<ExportWalletAccountResult>, TurnkeyClientError>

Export wallet account

Export a wallet account.

pub async fn init_fiat_on_ramp( &self, organization_id: String, timestamp_ms: u128, params: InitFiatOnRampIntent, ) -> Result<ActivityResult<InitFiatOnRampResult>, TurnkeyClientError>

Init fiat on ramp

Initiate a fiat on ramp flow.

pub async fn init_import_wallet( &self, organization_id: String, timestamp_ms: u128, params: InitImportWalletIntent, ) -> Result<ActivityResult<InitImportWalletResult>, TurnkeyClientError>

Init import wallet

Initialize a new wallet import.

pub async fn import_wallet( &self, organization_id: String, timestamp_ms: u128, params: ImportWalletIntent, ) -> Result<ActivityResult<ImportWalletResult>, TurnkeyClientError>

Import wallet

Import a wallet.

pub async fn init_import_private_key( &self, organization_id: String, timestamp_ms: u128, params: InitImportPrivateKeyIntent, ) -> Result<ActivityResult<InitImportPrivateKeyResult>, TurnkeyClientError>

Init import private key

Initialize a new private key import.

pub async fn import_private_key( &self, organization_id: String, timestamp_ms: u128, params: ImportPrivateKeyIntent, ) -> Result<ActivityResult<ImportPrivateKeyResult>, TurnkeyClientError>

Import private key

Import a private key.

pub async fn oauth( &self, organization_id: String, timestamp_ms: u128, params: OauthIntent, ) -> Result<ActivityResult<OauthResult>, TurnkeyClientError>

Oauth

Authenticate a user with an OIDC token (Oauth).

pub async fn init_otp( &self, organization_id: String, timestamp_ms: u128, params: InitOtpIntentV3, ) -> Result<ActivityResult<InitOtpResultV2>, TurnkeyClientError>

Init generic OTP

Initiate a generic OTP activity.

pub async fn verify_otp( &self, organization_id: String, timestamp_ms: u128, params: VerifyOtpIntentV2, ) -> Result<ActivityResult<VerifyOtpResult>, TurnkeyClientError>

Verify generic OTP

Verify a generic OTP.

pub async fn init_otp_auth( &self, organization_id: String, timestamp_ms: u128, params: InitOtpAuthIntentV3, ) -> Result<ActivityResult<InitOtpAuthResultV2>, TurnkeyClientError>

Init OTP auth

Initiate an OTP auth activity.

pub async fn otp_auth( &self, organization_id: String, timestamp_ms: u128, params: OtpAuthIntent, ) -> Result<ActivityResult<OtpAuthResult>, TurnkeyClientError>

OTP auth

Authenticate a user with an OTP code sent via email or SMS.

pub async fn create_oauth_providers( &self, organization_id: String, timestamp_ms: u128, params: CreateOauthProvidersIntentV2, ) -> Result<ActivityResult<CreateOauthProvidersResultV2>, TurnkeyClientError>

Create Oauth providers

Create Oauth providers for a specified user.

pub async fn delete_oauth_providers( &self, organization_id: String, timestamp_ms: u128, params: DeleteOauthProvidersIntent, ) -> Result<ActivityResult<DeleteOauthProvidersResult>, TurnkeyClientError>

Delete Oauth providers

Remove Oauth providers for a specified user.

pub async fn get_organization_configs( &self, request: GetOrganizationConfigsRequest, ) -> Result<GetOrganizationConfigsResponse, TurnkeyClientError>

Get configs

Get quorum settings and features for an organization.

pub async fn delete_private_keys( &self, organization_id: String, timestamp_ms: u128, params: DeletePrivateKeysIntent, ) -> Result<ActivityResult<DeletePrivateKeysResult>, TurnkeyClientError>

Delete private keys

Delete private keys for an organization.

pub async fn update_wallet( &self, organization_id: String, timestamp_ms: u128, params: UpdateWalletIntent, ) -> Result<ActivityResult<UpdateWalletResult>, TurnkeyClientError>

Update wallet

Update a wallet for an organization.

pub async fn delete_wallets( &self, organization_id: String, timestamp_ms: u128, params: DeleteWalletsIntent, ) -> Result<ActivityResult<DeleteWalletsResult>, TurnkeyClientError>

Delete wallets

Delete wallets for an organization.

pub async fn delete_sub_organization( &self, organization_id: String, timestamp_ms: u128, params: DeleteSubOrganizationIntent, ) -> Result<ActivityResult<DeleteSubOrganizationResult>, TurnkeyClientError>

Delete sub-organization

Delete a sub-organization.

pub async fn get_policy_evaluations( &self, request: GetPolicyEvaluationsRequest, ) -> Result<GetPolicyEvaluationsResponse, TurnkeyClientError>

Get policy evaluations

Get the policy evaluations for an activity.

pub async fn create_oauth2_credential( &self, organization_id: String, timestamp_ms: u128, params: CreateOauth2CredentialIntent, ) -> Result<ActivityResult<CreateOauth2CredentialResult>, TurnkeyClientError>

Create an OAuth 2.0 Credential

Enable authentication for end users with an OAuth 2.0 provider

pub async fn update_oauth2_credential( &self, organization_id: String, timestamp_ms: u128, params: UpdateOauth2CredentialIntent, ) -> Result<ActivityResult<UpdateOauth2CredentialResult>, TurnkeyClientError>

Update an OAuth 2.0 Credential

Update an OAuth 2.0 provider credential

pub async fn delete_oauth2_credential( &self, organization_id: String, timestamp_ms: u128, params: DeleteOauth2CredentialIntent, ) -> Result<ActivityResult<DeleteOauth2CredentialResult>, TurnkeyClientError>

Delete an OAuth 2.0 Credential

Disable authentication for end users with an OAuth 2.0 provider

pub async fn create_webhook_endpoint( &self, organization_id: String, timestamp_ms: u128, params: CreateWebhookEndpointIntent, ) -> Result<ActivityResult<CreateWebhookEndpointResult>, TurnkeyClientError>

Create webhook endpoint

Create a webhook endpoint for an organization.

pub async fn update_webhook_endpoint( &self, organization_id: String, timestamp_ms: u128, params: UpdateWebhookEndpointIntent, ) -> Result<ActivityResult<UpdateWebhookEndpointResult>, TurnkeyClientError>

Update webhook endpoint

Update a webhook endpoint for an organization.

pub async fn delete_webhook_endpoint( &self, organization_id: String, timestamp_ms: u128, params: DeleteWebhookEndpointIntent, ) -> Result<ActivityResult<DeleteWebhookEndpointResult>, TurnkeyClientError>

Delete webhook endpoint

Delete a webhook endpoint for an organization.

pub async fn get_boot_proof( &self, request: GetBootProofRequest, ) -> Result<BootProofResponse, TurnkeyClientError>

Get a specific boot proof

Get the boot proof for a given ephemeral key.

pub async fn get_latest_boot_proof( &self, request: GetLatestBootProofRequest, ) -> Result<BootProofResponse, TurnkeyClientError>

Get the latest boot proof for an app

Get the latest boot proof for a given enclave app name.

pub async fn get_app_proofs( &self, request: GetAppProofsRequest, ) -> Result<GetAppProofsResponse, TurnkeyClientError>

List App Proofs for an activity

List the App Proofs for the given activity.

pub async fn list_oauth2_credentials( &self, request: ListOauth2CredentialsRequest, ) -> Result<ListOauth2CredentialsResponse, TurnkeyClientError>

List OAuth 2.0 Credentials

List all OAuth 2.0 credentials within an organization.

pub async fn list_webhook_endpoints( &self, request: ListWebhookEndpointsRequest, ) -> Result<ListWebhookEndpointsResponse, TurnkeyClientError>

List webhook endpoints

List webhook endpoints within an organization.

pub async fn get_oauth2_credential( &self, request: GetOauth2CredentialRequest, ) -> Result<GetOauth2CredentialResponse, TurnkeyClientError>

Get OAuth 2.0 credential

Get details about an OAuth 2.0 credential.

pub async fn oauth2_authenticate( &self, organization_id: String, timestamp_ms: u128, params: Oauth2AuthenticateIntent, ) -> Result<ActivityResult<Oauth2AuthenticateResult>, TurnkeyClientError>

OAuth 2.0 authentication

Authenticate a user with an OAuth 2.0 provider and receive an OIDC token to use with the LoginWithOAuth or CreateSubOrganization activities

pub async fn delete_wallet_accounts( &self, organization_id: String, timestamp_ms: u128, params: DeleteWalletAccountsIntent, ) -> Result<ActivityResult<DeleteWalletAccountsResult>, TurnkeyClientError>

Delete wallet accounts

Delete wallet accounts for an organization.

pub async fn create_fiat_on_ramp_credential( &self, organization_id: String, timestamp_ms: u128, params: CreateFiatOnRampCredentialIntent, ) -> Result<ActivityResult<CreateFiatOnRampCredentialResult>, TurnkeyClientError>

Create a Fiat On Ramp Credential

Create a fiat on ramp provider credential

pub async fn update_fiat_on_ramp_credential( &self, organization_id: String, timestamp_ms: u128, params: UpdateFiatOnRampCredentialIntent, ) -> Result<ActivityResult<UpdateFiatOnRampCredentialResult>, TurnkeyClientError>

Update a Fiat On Ramp Credential

Update a fiat on ramp provider credential

pub async fn delete_fiat_on_ramp_credential( &self, organization_id: String, timestamp_ms: u128, params: DeleteFiatOnRampCredentialIntent, ) -> Result<ActivityResult<DeleteFiatOnRampCredentialResult>, TurnkeyClientError>

Delete a Fiat On Ramp Credential

Delete a fiat on ramp provider credential

pub async fn list_fiat_on_ramp_credentials( &self, request: ListFiatOnRampCredentialsRequest, ) -> Result<ListFiatOnRampCredentialsResponse, TurnkeyClientError>

List Fiat On Ramp Credentials

List all fiat on ramp provider credentials within an organization.

pub async fn eth_send_transaction( &self, organization_id: String, timestamp_ms: u128, params: EthSendTransactionIntent, ) -> Result<ActivityResult<EthSendTransactionResult>, TurnkeyClientError>

Broadcast EVM transaction

Submit a transaction intent describing an EVM transaction you would like to broadcast.

pub async fn sol_send_transaction( &self, organization_id: String, timestamp_ms: u128, params: SolSendTransactionIntentV2, ) -> Result<ActivityResult<SolSendTransactionResultV2>, TurnkeyClientError>

Broadcast SVM transaction

Submit a transaction intent describing an SVM transaction you would like to broadcast. Supports single- and multi-signer intents via activity type versioning.

pub async fn earn_deploy_wrapper( &self, organization_id: String, timestamp_ms: u128, params: EarnDeployWrapperIntent, ) -> Result<ActivityResult<EarnDeployWrapperResult>, TurnkeyClientError>

Deploy Earn wrapper

Enable a yield vault for an organization by deploying its fee wrapper. Must be called before any deposits into the vault.

pub async fn earn_deposit( &self, organization_id: String, timestamp_ms: u128, params: EarnDepositIntent, ) -> Result<ActivityResult<EarnDepositResult>, TurnkeyClientError>

Deposit into Earn vault

Deposit assets from a wallet into an enabled yield vault.

pub async fn earn_withdraw( &self, organization_id: String, timestamp_ms: u128, params: EarnWithdrawIntent, ) -> Result<ActivityResult<EarnWithdrawResult>, TurnkeyClientError>

Withdraw from Earn vault

Withdraw assets or redeem shares from an enabled yield vault.

pub async fn earn_set_wrapper_state( &self, organization_id: String, timestamp_ms: u128, params: EarnSetWrapperStateIntent, ) -> Result<ActivityResult<EarnSetWrapperStateResult>, TurnkeyClientError>

Set Earn wrapper state

Enable or disable deposits to a deployed Earn wrapper. Withdrawals are always allowed.

pub async fn claim_earn_fees( &self, organization_id: String, timestamp_ms: u128, params: ClaimEarnFeesIntent, ) -> Result<ActivityResult<ClaimEarnFeesResult>, TurnkeyClientError>

Claim earn fees

Claim earn fees through the activity pipeline.

pub async fn list_earn_vaults( &self, request: ListEarnVaultsRequest, ) -> Result<ListEarnVaultsResponse, TurnkeyClientError>

Get Earn vault catalog

Get the catalog of all wrappable yield vaults across supported chains, enriched with live TVL and APY. Annotates which vaults the organization has already enabled.

pub async fn list_earn_enabled_vaults( &self, request: ListEarnEnabledVaultsRequest, ) -> Result<ListEarnEnabledVaultsResponse, TurnkeyClientError>

Get Earn enabled vaults

Get the organization’s deployed wrappers with on-chain total deposited and live APY. The management view, distinct from per-wallet positions.

pub async fn list_earn_positions( &self, request: ListEarnPositionsRequest, ) -> Result<ListEarnPositionsResponse, TurnkeyClientError>

Get Earn positions

Get the active Earn positions for a specific wallet, including current value, cost basis, yield, and projected fees.

pub async fn get_earn_withdraw_status( &self, request: GetEarnWithdrawStatusRequest, ) -> Result<GetEarnWithdrawStatusResponse, TurnkeyClientError>

Get Earn withdraw status

Poll the status of a withdrawal by its withdraw_request_id.

pub async fn get_earn_deposit_status( &self, request: GetEarnDepositStatusRequest, ) -> Result<GetEarnDepositStatusResponse, TurnkeyClientError>

Get Earn deposit status

Poll the status of a deposit by its deposit_request_id (for the async/sponsored deposit path).

pub async fn get_claim_earn_fees_status( &self, request: GetClaimEarnFeesStatusRequest, ) -> Result<GetClaimEarnFeesStatusResponse, TurnkeyClientError>

Get Earn claim fees status

Poll the status of a fee claim by its claim_request_id.

pub async fn get_earn_deploy_status( &self, request: GetEarnDeployStatusRequest, ) -> Result<GetEarnDeployStatusResponse, TurnkeyClientError>

Get Earn deploy status

Poll the status of a wrapper deployment by its deploy_request_id.

pub async fn get_swap_status( &self, request: GetSwapStatusRequest, ) -> Result<GetSwapStatusResponse, TurnkeyClientError>

Get swap status

Poll the status of a swap by its swap_request_id. Covers same-chain and cross-chain swaps.

pub async fn claim_swap_fees( &self, organization_id: String, timestamp_ms: u128, params: ClaimSwapFeesIntent, ) -> Result<ActivityResult<ClaimSwapFeesResult>, TurnkeyClientError>

Claim swap fees

Claim swap fees through the activity pipeline.

pub async fn upsert_swap_config( &self, organization_id: String, timestamp_ms: u128, params: UpsertSwapConfigIntent, ) -> Result<ActivityResult<UpsertSwapConfigResult>, TurnkeyClientError>

Upsert swap config

Enable or disable swap configuration for an organization.

pub async fn get_gas_usage( &self, request: GetGasUsageRequest, ) -> Result<GetGasUsageResponse, TurnkeyClientError>

Get gas usage

Get gas usage and gas limits for either the parent organization or a sub-organization.

pub async fn get_nonces( &self, request: GetNoncesRequest, ) -> Result<GetNoncesResponse, TurnkeyClientError>

Get nonces

Get nonce values for an address on a given network. Can fetch the standard on-chain nonce and/or the gas station nonce used for sponsored transactions.

pub async fn create_tvc_app( &self, organization_id: String, timestamp_ms: u128, params: CreateTvcAppIntent, ) -> Result<ActivityResult<CreateTvcAppResult>, TurnkeyClientError>

Create a TVC App

Create a new TVC application

pub async fn create_tvc_operator( &self, organization_id: String, timestamp_ms: u128, params: CreateTvcOperatorIntent, ) -> Result<ActivityResult<CreateTvcOperatorResult>, TurnkeyClientError>

Create TVC Operator

Create a TVC Operator backed by uncompressed P-256 Turnkey wallet accounts

pub async fn delete_tvc_app_and_deployments( &self, organization_id: String, timestamp_ms: u128, params: DeleteTvcAppAndDeploymentsIntent, ) -> Result<ActivityResult<DeleteTvcAppAndDeploymentsResult>, TurnkeyClientError>

Delete a TVC App and all of its deployments

Delete a TVC App and all of its deployments

pub async fn get_tvc_apps( &self, request: GetTvcAppsRequest, ) -> Result<GetTvcAppsResponse, TurnkeyClientError>

List TVC Apps

List all TVC Apps within an organization.

pub async fn get_tvc_app( &self, request: GetTvcAppRequest, ) -> Result<GetTvcAppResponse, TurnkeyClientError>

Get TVC App

Get details about a single TVC App

pub async fn create_tvc_deployment( &self, organization_id: String, timestamp_ms: u128, params: CreateTvcDeploymentIntent, ) -> Result<ActivityResult<CreateTvcDeploymentResult>, TurnkeyClientError>

Create a TVC Deployment

Create a new TVC Deployment

pub async fn update_tvc_app_live_deployment( &self, organization_id: String, timestamp_ms: u128, params: UpdateTvcAppLiveDeploymentIntent, ) -> Result<ActivityResult<UpdateTvcAppLiveDeploymentResult>, TurnkeyClientError>

Set TVC App live deployment

Set the live deployment for a TVC App

pub async fn delete_tvc_deployment( &self, organization_id: String, timestamp_ms: u128, params: DeleteTvcDeploymentIntent, ) -> Result<ActivityResult<DeleteTvcDeploymentResult>, TurnkeyClientError>

Delete a TVC Deployment

Delete a TVC Deployment

pub async fn restore_tvc_deployment( &self, organization_id: String, timestamp_ms: u128, params: RestoreTvcDeploymentIntent, ) -> Result<ActivityResult<RestoreTvcDeploymentResult>, TurnkeyClientError>

Restore a TVC Deployment

Restore a deleted TVC Deployment

pub async fn validate_tvc_image( &self, request: ValidateTvcImageRequest, ) -> Result<ValidateTvcImageResponse, TurnkeyClientError>

Validate Container Image for TVC

Validate a container image URL and pull secret for TVC deployment

pub async fn get_tvc_app_deployments( &self, request: GetTvcAppDeploymentsRequest, ) -> Result<GetTvcAppDeploymentsResponse, TurnkeyClientError>

List TVC Deployments

List all deployments for a given TVC App

pub async fn get_tvc_deployment( &self, request: GetTvcDeploymentRequest, ) -> Result<GetTvcDeploymentResponse, TurnkeyClientError>

Get TVC Deployment

Get details about a single TVC Deployment

pub async fn get_tvc_deployment_provisioning_details( &self, request: GetTvcDeploymentProvisioningDetailsRequest, ) -> Result<GetTvcDeploymentProvisioningDetailsResponse, TurnkeyClientError>

Get TVC Deployment’s Provisioning Details

Get the attestation document and manifest envelope of the provisioning enclave for a TVC deployment

pub async fn create_tvc_manifest_approvals( &self, organization_id: String, timestamp_ms: u128, params: CreateTvcManifestApprovalsIntent, ) -> Result<ActivityResult<CreateTvcManifestApprovalsResult>, TurnkeyClientError>

Create TVC Manifest Approvals

Post one or more manifest approvals for a TVC Manifest

pub async fn post_tvc_quorum_key_share( &self, organization_id: String, timestamp_ms: u128, params: PostTvcQuorumKeyShareIntent, ) -> Result<ActivityResult<PostTvcQuorumKeyShareResult>, TurnkeyClientError>

Post TVC Quorum Key Share

Post re-encrypted quorum key share for a TVC deployment.

pub async fn create_tvc_quorum_key( &self, organization_id: String, timestamp_ms: u128, params: CreateTvcQuorumKeyIntent, ) -> Result<ActivityResult<CreateTvcQuorumKeyResult>, TurnkeyClientError>

Create TVC Quorum Key

Create a hosted TVC quorum key and encrypted shares.

pub async fn re_encrypt_tvc_quorum_key_share( &self, organization_id: String, timestamp_ms: u128, params: ReEncryptTvcQuorumKeyShareIntent, ) -> Result<ActivityResult<ReEncryptTvcQuorumKeyShareResult>, TurnkeyClientError>

Re-encrypt TVC Quorum Key Share

Re-encrypt a hosted TVC quorum key share for a deployment.

pub async fn get_app_status( &self, request: GetAppStatusRequest, ) -> Result<GetAppStatusResponse, TurnkeyClientError>

Get TVC App status

Get live runtime status for a TVC App from the cluster.

pub async fn get_tvc_deployment_debug_logs( &self, request: GetTvcDeploymentDebugLogsRequest, ) -> Result<GetTvcDeploymentDebugLogsResponse, TurnkeyClientError>

Get TVC Deployment debug logs

Get a bounded window of application logs from a debug-mode TVC deployment. Returned lines are collected from every running replica and sorted by platform timestamp.

pub async fn get_wallet_address_balances( &self, request: GetWalletAddressBalancesRequest, ) -> Result<GetWalletAddressBalancesResponse, TurnkeyClientError>

Get balances

Get balances of supported assets for an address on the specified network. Only non-zero balances are returned.

pub async fn list_supported_assets( &self, request: ListSupportedAssetsRequest, ) -> Result<ListSupportedAssetsResponse, TurnkeyClientError>

List supported assets

List supported assets for the specified network.

pub async fn set_ip_allowlist( &self, organization_id: String, timestamp_ms: u128, params: SetIpAllowlistIntent, ) -> Result<ActivityResult<SetIpAllowlistResult>, TurnkeyClientError>

Set IP Allowlist

Create or update IP allowlist and rules for organization or API key. The IP allowlist restricts API access to specific CIDR blocks. Organization-level allowlists apply to all API keys unless overridden by a key-specific allowlist.

pub async fn remove_ip_allowlist( &self, organization_id: String, timestamp_ms: u128, params: RemoveIpAllowlistIntent, ) -> Result<ActivityResult<RemoveIpAllowlistResult>, TurnkeyClientError>

Remove IP Allowlist

Delete IP allowlist and all associated rules for organization or API key. After removal, access will be determined by organization-level allowlist (for API keys) or allowed from all IPs (for organizations).

pub async fn import_secrets( &self, organization_id: String, timestamp_ms: u128, params: ImportSecretsIntent, ) -> Result<ActivityResult<ImportSecretsResult>, TurnkeyClientError>

Import secrets

Import secrets encrypted to target keys returned from InitImportSecrets.

pub async fn get_ip_allowlist( &self, request: GetIpAllowlistRequest, ) -> Result<GetIpAllowlistResponse, TurnkeyClientError>

Get IP Allowlist

Get IP allowlist and rules for an organization.

pub async fn spark_sign_frost( &self, organization_id: String, timestamp_ms: u128, params: SparkSignFrostIntent, ) -> Result<ActivityResult<SparkSignFrostResult>, TurnkeyClientError>

Sign Frost Spark

Perform pure FROST partial signing for a Spark wallet. Produces partial signatures without constructing operator packages.

pub async fn spark_prepare_transfer( &self, organization_id: String, timestamp_ms: u128, params: SparkPrepareTransferIntent, ) -> Result<ActivityResult<SparkPrepareTransferResult>, TurnkeyClientError>

Prepare Spark transfer

Construct sender-side encrypted operator packages for a Spark BTC transfer. Does not perform FROST signing.

pub async fn spark_claim_transfer( &self, organization_id: String, timestamp_ms: u128, params: SparkClaimTransferIntent, ) -> Result<ActivityResult<SparkClaimTransferResult>, TurnkeyClientError>

Claim Spark transfer

Construct receiver-side encrypted operator packages to claim a Spark transfer. Does not perform FROST signing.

pub async fn spark_prepare_lightning_receive( &self, organization_id: String, timestamp_ms: u128, params: SparkPrepareLightningReceiveIntent, ) -> Result<ActivityResult<SparkPrepareLightningReceiveResult>, TurnkeyClientError>

Spark prepare Lightning receive

Generate a Lightning preimage and distribute Feldman shares to operators for a Spark Lightning receive. Does not perform FROST signing.

pub async fn create_mfa_policy( &self, organization_id: String, timestamp_ms: u128, params: CreateMfaPolicyIntent, ) -> Result<ActivityResult<CreateMfaPolicyResult>, TurnkeyClientError>

Create MFA policy

Create a new MFA policy for a user.

pub async fn update_mfa_policy( &self, organization_id: String, timestamp_ms: u128, params: UpdateMfaPolicyIntent, ) -> Result<ActivityResult<UpdateMfaPolicyResult>, TurnkeyClientError>

Update MFA policy

Update an MFA policy for a user.

pub async fn delete_mfa_policy( &self, organization_id: String, timestamp_ms: u128, params: DeleteMfaPolicyIntent, ) -> Result<ActivityResult<DeleteMfaPolicyResult>, TurnkeyClientError>

Delete MFA policy

Delete an MFA policy for a user.

pub async fn get_mfa_policy( &self, request: GetMfaPolicyRequest, ) -> Result<GetMfaPolicyResponse, TurnkeyClientError>

Get MFA policy

Get a single MFA policy for a user.

pub async fn get_mfa_policies( &self, request: GetMfaPoliciesRequest, ) -> Result<GetMfaPoliciesResponse, TurnkeyClientError>

Get MFA policies

Get all MFA policies for a user.

pub async fn create_session_profile( &self, organization_id: String, timestamp_ms: u128, params: CreateSessionProfileIntent, ) -> Result<ActivityResult<CreateSessionProfileResult>, TurnkeyClientError>

Create session profile

Create a new session profile for an organization.

pub async fn get_session_profile( &self, request: GetSessionProfileRequest, ) -> Result<GetSessionProfileResponse, TurnkeyClientError>

Get session profile

Get a single session profile for an organization.

pub async fn get_session_profiles( &self, request: GetSessionProfilesRequest, ) -> Result<GetSessionProfilesResponse, TurnkeyClientError>

Get session profiles

Get all session profiles for an organization.

pub async fn get_mfa_status( &self, request: GetMfaStatusRequest, ) -> Result<GetMfaStatusResponse, TurnkeyClientError>

Get MFA status

Get the MFA status of an activity for a specific user or all voting users.

pub async fn list_email_events( &self, request: ListEmailEventsRequest, ) -> Result<ListEmailEventsResponse, TurnkeyClientError>

List email events

List email events for the organization.

pub async fn list_eth_transaction_history( &self, request: ListEthTransactionHistoryRequest, ) -> Result<ListEthTransactionHistoryResponse, TurnkeyClientError>

List Eth transaction history

List Ethereum transaction history for a wallet address on the specified network.

pub async fn list_sol_transaction_history( &self, request: ListSolTransactionHistoryRequest, ) -> Result<ListSolTransactionHistoryResponse, TurnkeyClientError>

List Sol transaction history

List Solana transaction history for a wallet address on the specified network.

pub async fn eth_undelegate7702( &self, organization_id: String, timestamp_ms: u128, params: EthUndelegate7702Intent, ) -> Result<ActivityResult<EthUndelegate7702Result>, TurnkeyClientError>

Undelegate an EVM account

Submit an EIP-7702 undelegation transaction.

impl<S: Stamp> TurnkeyClient<S>

pub fn builder() -> TurnkeyClientBuilder<S>

Creates a new TurnkeyClientBuilder<S>. Configure with .api_key(...) and other options, then call .build().

The type parameter S must implement the Stamp trait.

pub fn with_app_proofs(self) -> Self

Enable app proof generation for all activity requests.

When enabled, the server will return app proofs with each response that can be independently verified.

Example

let client = TurnkeyClient::builder()
    .api_key(api_key)
    .build()?
    .with_app_proofs();

pub fn generate_app_proofs(&self) -> Option<bool>

Returns the current generate_app_proofs setting.

pub async fn process_activity<Request: Serialize>( &self, request: Request, path: String, ) -> Result<Activity, TurnkeyClientError>

POSTs an activity and polls until the status is “COMPLETE”

process_activity accepts a arbitrary Request and path to POST to the Turnkey API. It encapsulates the polling logic and is generally meant to be called by other activity-specific client functions (e.g. create_sub_organization).

Given the Turnkey API is backwards-compatible, this function can be used to submit old versions of activities. For example, if the latest version for create_sub_organization is “ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V7”, you may want to use process_activity to process ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V6. Note that this requires manually setting the correct URL and activity request type. The response is an generic Activity. If you’re invoking this function manually you’ll have to manually look at the correct .activity.result enum.

This function is used by our generated client methods and sets the right request type, URL, and deserializes into the proper result type as well. Unless you have good reasons, prefer the type-safe client methods such as sign_raw_payload.

Returns

This function returns an Activity object which contains the deserialized version of the response.

Errors

If the server errors with a validation error, a server error, a deserialization error, the proper variant of TurnkeyClientError is returned. If the activity is pending and exceeds the maximum amount of retries allowed, TurnkeyClientError::ExceededRetries is returned. If the activity requires consensus or authenticators, TurnkeyClientError::ActivityRequiresApproval is returned.

pub fn current_timestamp(&self) -> u128

Returns the current timestamp as a u128.

pub async fn process_request<Request, Response>( &self, request: &Request, path: String, ) -> Result<Response, TurnkeyClientError>

where Request: Serialize, Response: DeserializeOwned,

Processes a Request (at path) by:

• Serializing the request to JSON
• Signing the request with the client’s API key
• POSTing the POST body and the associated stamp to the Turnkey API

This function is generic and can handle POSTing queries or activities.

Trait Implementations

impl<S: Stamp> Debug for TurnkeyClient<S>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.