ServerSignerClient

params

ServerSignerClientParams

The parameters for the client, including the access key and connection configuration

completeAuthWithBundle

() => never

‐

eventEmitter

EventEmitter<AlchemySignerClientEvents>

‐

exportWallet

() => never

‐

getOauthConfig

() => never

‐

getWebAuthnAttestation

() => never

‐

initEmailAuth

() => never

‐

initSessionStamper

() => never

Initializes the session stamper and returns its public key.

initSmsAuth

() => never

Unimplemented functions for server signer. Required to extend the BaseSignerClient class.

initWebauthnStamper

() => never

‐

oauthConfig

undefined | OauthConfig

‐

oauthWithPopup

() => never

‐

oauthWithRedirect

() => never

‐

rootOrg

string

‐

submitJwt

() => never

‐

submitOtpCode

() => never

‐

targetPublicKey

() => never

‐

turnkeyClient

TurnkeyClient

‐

user

undefined | User

params

AddMfaParams

The parameters required to enable a new MFA factor

params

AddOauthProviderParams

The parameters for adding an OAuth provider, including providerName and oidcToken.

options

CredentialCreationOptions

The options used to create the WebAuthn attestation

params

any

The parameters for the authentication

params

CreateAccountParams

The parameters for creating the account

orgId

string

orgId of the multi-sig to add members to

members

`0x${string}`[]

the addresses of the members to add

params

experimental_CreateApiKeyParams

Parameters for creating the API key.

additionalMembers

`0x${string}`[]

members to add, aside from the currently authenticated user

orgId

string

orgId of the multi-sig to remove members from

members

`0x${string}`[]

the addresses of the members to remove

msg

`0x${string}`

the hex representation of the bytes to sign

orgId

string

orgId of the multi-owner org to sign on behalf of

orgAddress

string

address of the multi-owner org to sign on behalf of

turnkeyPublicKey

string

key from a Turnkey iframe

args

GetOauthProviderUrlArgs

Required. The Oauth provider’s auth parameters

type

"email" | "sms"

The type of OTP to send, either “email” or “sms”

contact

string

The email address or phone number to send the OTP to

params

LookupUserByAccessKeyParams

The access key parameters

email

string

the email address to look up

phone

string

the phone number to look up

user?

User

undefined

An optional user object to authenticate

E extends keyof AlchemySignerClientEvents

event

E

the event you want to listen to

listener

AlchemySignerClientEvents[E]

the callback function to execute when an event is fired

T extends | "createOrganizationResult" | "createAuthenticatorsResult" | "createUsersResult" | "createPrivateKeysResult" | "createInvitationsResult" | "acceptInvitationResult" | "signRawPayloadResult" | "createPolicyResult" | "disablePrivateKeyResult" | "deleteUsersResult" | "deleteAuthenticatorsResult" | "deleteInvitationResult" | "deleteOrganizationResult" | "deletePolicyResult" | "createUserTagResult" | "deleteUserTagsResult" | "signTransactionResult" | "deleteApiKeysResult" | "createApiKeysResult" | "createPrivateKeyTagResult" | "deletePrivateKeyTagsResult" | "setPaymentMethodResult" | "activateBillingTierResult" | "deletePaymentMethodResult" | "createApiOnlyUsersResult" | "updateRootQuorumResult" | "updateUserTagResult" | "updatePrivateKeyTagResult" | "createSubOrganizationResult" | "updateAllowedOriginsResult" | "createPrivateKeysResultV2" | "updateUserResult" | "updatePolicyResult" | "createSubOrganizationResultV3" | "createWalletResult" | "createWalletAccountsResult" | "initUserEmailRecoveryResult" | "recoverUserResult" | "setOrganizationFeatureResult" | "removeOrganizationFeatureResult" | "exportPrivateKeyResult" | "exportWalletResult" | "createSubOrganizationResultV4" | "emailAuthResult" | "exportWalletAccountResult" | "initImportWalletResult" | "importWalletResult" | "initImportPrivateKeyResult" | "importPrivateKeyResult" | "createPoliciesResult" | "signRawPayloadsResult" | "createReadOnlySessionResult" | "createOauthProvidersResult" | "deleteOauthProvidersResult" | "createSubOrganizationResultV5" | "oauthResult" | "createReadWriteSessionResult" | "createSubOrganizationResultV6" | "deletePrivateKeysResult" | "deleteWalletsResult" | "createReadWriteSessionResultV2" | "deleteSubOrganizationResult" | "initOtpAuthResult" | "otpAuthResult" | "createSubOrganizationResultV7" | "updateWalletResult" | "updatePolicyResultV2" | "initOtpAuthResultV2" | "initOtpResult" | "verifyOtpResult" | "otpLoginResult" | "stampLoginResult" | "oauthLoginResult" | "updateUserNameResult" | "updateUserEmailResult" | "updateUserPhoneNumberResult" | "initFiatOnRampResult" | "createSmartContractInterfaceResult" | "deleteSmartContractInterfaceResult" | "enableAuthProxyResult" | "disableAuthProxyResult" | "updateAuthProxyConfigResult" | "createOauth2CredentialResult" | "updateOauth2CredentialResult" | "deleteOauth2CredentialResult" | "oauth2AuthenticateResult"

activity

{ canApprove: boolean; canReject: boolean; createdAt: { nanos: string; seconds: string; }; failure?: { code?: number; details?: object & object[]; message?: string; }; fingerprint: string; id: string; intent: { acceptInvitationIntent?: { authenticator: { attestation: { authenticatorAttachment?: null | "cross-platform" | "platform"; clientExtensionResults: { appid?: boolean; appidExclude?: boolean; credProps?: { rk: boolean; }; }; id: string; rawId: string; response: { attestationObject: string; authenticatorAttachment?: null | "cross-platform" | "platform"; clientDataJson: string; transports?: ( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]; }; type: "public-key"; }; authenticatorName: string; challenge: string; userId: string; }; invitationId: string; userId: string; }; acceptInvitationIntentV2?: { authenticator: { attestation: { attestationObject: string; clientDataJson: string; credentialId: string; transports: ( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]; }; authenticatorName: string; challenge: string; }; invitationId: string; userId: string; }; activateBillingTierIntent?: { productId: string; }; approveActivityIntent?: { fingerprint: string; }; createApiKeysIntent?: { apiKeys: object[]; userId: string; }; createApiKeysIntentV2?: { apiKeys: object[]; userId: string; }; createApiOnlyUsersIntent?: { apiOnlyUsers: object[]; }; createAuthenticatorsIntent?: { authenticators: object[]; userId: string; }; createAuthenticatorsIntentV2?: { authenticators: object[]; userId: string; }; createInvitationsIntent?: { invitations: object[]; }; createOauth2CredentialIntent?: { clientId: string; encryptedClientSecret: string; provider: "OAUTH2_PROVIDER_X" | "OAUTH2_PROVIDER_DISCORD"; }; createOauthProvidersIntent?: { oauthProviders: object[]; userId: string; }; createOrganizationIntent?: { organizationName: string; rootAuthenticator: { attestation: { authenticatorAttachment?: null | "cross-platform" | "platform"; clientExtensionResults: { appid?: boolean; appidExclude?: boolean; credProps?: { rk: boolean; }; }; id: string; rawId: string; response: { attestationObject: string; authenticatorAttachment?: null | "cross-platform" | "platform"; clientDataJson: string; transports?: ( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]; }; type: "public-key"; }; authenticatorName: string; challenge: string; userId: string; }; rootEmail: string; rootUserId?: string; }; createOrganizationIntentV2?: { organizationName: string; rootAuthenticator: { attestation: { attestationObject: string; clientDataJson: string; credentialId: string; transports: ( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]; }; authenticatorName: string; challenge: string; }; rootEmail: string; rootUserId?: string; }; createPoliciesIntent?: { policies: object[]; }; createPolicyIntent?: { effect: "EFFECT_ALLOW" | "EFFECT_DENY"; notes?: string; policyName: string; selectors: object[]; }; createPolicyIntentV2?: { effect: "EFFECT_ALLOW" | "EFFECT_DENY"; notes?: string; policyName: string; selectors: object[]; }; createPolicyIntentV3?: { condition?: string; consensus?: string; effect: "EFFECT_ALLOW" | "EFFECT_DENY"; notes?: string; policyName: string; }; createPrivateKeysIntent?: { privateKeys: object[]; }; createPrivateKeysIntentV2?: { privateKeys: object[]; }; createPrivateKeyTagIntent?: { privateKeyIds: string[]; privateKeyTagName: string; }; createReadOnlySessionIntent?: { [key: string]: unknown; }; createReadWriteSessionIntent?: { apiKeyName?: string; email: string; expirationSeconds?: string; targetPublicKey: string; }; createReadWriteSessionIntentV2?: { apiKeyName?: string; expirationSeconds?: string; invalidateExisting?: boolean; targetPublicKey: string; userId?: string; }; createSmartContractInterfaceIntent?: { label: string; notes?: string; smartContractAddress: string; smartContractInterface: string; type: | "SMART_CONTRACT_INTERFACE_TYPE_ETHEREUM" | "SMART_CONTRACT_INTERFACE_TYPE_SOLANA"; }; createSubOrganizationIntent?: { name: string; rootAuthenticator: { attestation: { attestationObject: string; clientDataJson: string; credentialId: string; transports: ( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]; }; authenticatorName: string; challenge: string; }; }; createSubOrganizationIntentV2?: { rootQuorumThreshold: number; rootUsers: object[]; subOrganizationName: string; }; createSubOrganizationIntentV3?: { privateKeys: object[]; rootQuorumThreshold: number; rootUsers: object[]; subOrganizationName: string; }; createSubOrganizationIntentV4?: { disableEmailAuth?: boolean; disableEmailRecovery?: boolean; rootQuorumThreshold: number; rootUsers: object[]; subOrganizationName: string; wallet?: { accounts: object[]; mnemonicLength?: number; walletName: string; }; }; createSubOrganizationIntentV5?: { disableEmailAuth?: boolean; disableEmailRecovery?: boolean; rootQuorumThreshold: number; rootUsers: object[]; subOrganizationName: string; wallet?: { accounts: object[]; mnemonicLength?: number; walletName: string; }; }; createSubOrganizationIntentV6?: { disableEmailAuth?: boolean; disableEmailRecovery?: boolean; rootQuorumThreshold: number; rootUsers: object[]; subOrganizationName: string; wallet?: { accounts: object[]; mnemonicLength?: number; walletName: string; }; }; createSubOrganizationIntentV7?: { disableEmailAuth?: boolean; disableEmailRecovery?: boolean; disableOtpEmailAuth?: boolean; disableSmsAuth?: boolean; rootQuorumThreshold: number; rootUsers: object[]; subOrganizationName: string; verificationToken?: string; wallet?: { accounts: object[]; mnemonicLength?: number; walletName: string; }; }; createUsersIntent?: { users: object[]; }; createUsersIntentV2?: { users: object[]; }; createUsersIntentV3?: { users: object[]; }; createUserTagIntent?: { userIds: string[]; userTagName: string; }; createWalletAccountsIntent?: { accounts: object[]; walletId: string; }; createWalletIntent?: { accounts: object[]; mnemonicLength?: number; walletName: string; }; deleteApiKeysIntent?: { apiKeyIds: string[]; userId: string; }; deleteAuthenticatorsIntent?: { authenticatorIds: string[]; userId: string; }; deleteInvitationIntent?: { invitationId: string; }; deleteOauth2CredentialIntent?: { oauth2CredentialId: string; }; deleteOauthProvidersIntent?: { providerIds: string[]; userId: string; }; deleteOrganizationIntent?: { organizationId: string; }; deletePaymentMethodIntent?: { paymentMethodId: string; }; deletePolicyIntent?: { policyId: string; }; deletePrivateKeysIntent?: { deleteWithoutExport?: boolean; privateKeyIds: string[]; }; deletePrivateKeyTagsIntent?: { privateKeyTagIds: string[]; }; deleteSmartContractInterfaceIntent?: { smartContractInterfaceId: string; }; deleteSubOrganizationIntent?: { deleteWithoutExport?: boolean; }; deleteUsersIntent?: { userIds: string[]; }; deleteUserTagsIntent?: { userTagIds: string[]; }; deleteWalletsIntent?: { deleteWithoutExport?: boolean; walletIds: string[]; }; disableAuthProxyIntent?: { [key: string]: unknown; }; disablePrivateKeyIntent?: { privateKeyId: string; }; emailAuthIntent?: { apiKeyName?: string; email: string; emailCustomization?: { appName?: string; logoUrl?: string; magicLinkTemplate?: string; templateId?: string; templateVariables?: string; }; expirationSeconds?: string; invalidateExisting?: boolean; replyToEmailAddress?: string; sendFromEmailAddress?: string; sendFromEmailSenderName?: string; targetPublicKey: string; }; emailAuthIntentV2?: { apiKeyName?: string; email: string; emailCustomization?: { appName?: string; logoUrl?: string; magicLinkTemplate?: string; templateId?: string; templateVariables?: string; }; expirationSeconds?: string; invalidateExisting?: boolean; replyToEmailAddress?: string; sendFromEmailAddress?: string; sendFromEmailSenderName?: string; targetPublicKey: string; }; enableAuthProxyIntent?: { [key: string]: unknown; }; exportPrivateKeyIntent?: { privateKeyId: string; targetPublicKey: string; }; exportWalletAccountIntent?: { address: string; targetPublicKey: string; }; exportWalletIntent?: { language?: | "MNEMONIC_LANGUAGE_ENGLISH" | "MNEMONIC_LANGUAGE_SIMPLIFIED_CHINESE" | "MNEMONIC_LANGUAGE_TRADITIONAL_CHINESE" | "MNEMONIC_LANGUAGE_CZECH" | "MNEMONIC_LANGUAGE_FRENCH" | "MNEMONIC_LANGUAGE_ITALIAN" | "MNEMONIC_LANGUAGE_JAPANESE" | "MNEMONIC_LANGUAGE_KOREAN" | "MNEMONIC_LANGUAGE_SPANISH"; targetPublicKey: string; walletId: string; }; importPrivateKeyIntent?: { addressFormats: ( | "ADDRESS_FORMAT_UNCOMPRESSED" | "ADDRESS_FORMAT_COMPRESSED" | "ADDRESS_FORMAT_ETHEREUM" | "ADDRESS_FORMAT_SOLANA" | "ADDRESS_FORMAT_COSMOS" | "ADDRESS_FORMAT_TRON" | "ADDRESS_FORMAT_SUI" | "ADDRESS_FORMAT_APTOS" | "ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH" | "ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH" | "ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH" | "ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH" | "ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR" | "ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH" | "ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH" | "ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH" | "ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH" | "ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR" | "ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH" | "ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH" | "ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH" | "ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH" | "ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR" | "ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH" | "ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH" | "ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH" | "ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH" | "ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR" | "ADDRESS_FORMAT_SEI" | "ADDRESS_FORMAT_XLM" | "ADDRESS_FORMAT_DOGE_MAINNET" | "ADDRESS_FORMAT_DOGE_TESTNET" | "ADDRESS_FORMAT_TON_V3R2" | "ADDRESS_FORMAT_TON_V4R2" | "ADDRESS_FORMAT_TON_V5R1" | "ADDRESS_FORMAT_XRP")[]; curve: "CURVE_SECP256K1" | "CURVE_ED25519"; encryptedBundle: string; privateKeyName: string; userId: string; }; importWalletIntent?: { accounts: object[]; encryptedBundle: string; userId: string; walletName: string; }; initFiatOnRampIntent?: { countryCode?: string; countrySubdivisionCode?: string; cryptoCurrencyCode: | "FIAT_ON_RAMP_CRYPTO_CURRENCY_BTC" | "FIAT_ON_RAMP_CRYPTO_CURRENCY_ETH" | "FIAT_ON_RAMP_CRYPTO_CURRENCY_SOL" | "FIAT_ON_RAMP_CRYPTO_CURRENCY_USDC"; fiatCurrencyAmount?: string; fiatCurrencyCode?: | "FIAT_ON_RAMP_CURRENCY_AUD" | "FIAT_ON_RAMP_CURRENCY_BGN" | "FIAT_ON_RAMP_CURRENCY_BRL" | "FIAT_ON_RAMP_CURRENCY_CAD" | "FIAT_ON_RAMP_CURRENCY_CHF" | "FIAT_ON_RAMP_CURRENCY_COP" | "FIAT_ON_RAMP_CURRENCY_CZK" | "FIAT_ON_RAMP_CURRENCY_DKK" | "FIAT_ON_RAMP_CURRENCY_DOP" | "FIAT_ON_RAMP_CURRENCY_EGP" | "FIAT_ON_RAMP_CURRENCY_EUR" | "FIAT_ON_RAMP_CURRENCY_GBP" | "FIAT_ON_RAMP_CURRENCY_HKD" | "FIAT_ON_RAMP_CURRENCY_IDR" | "FIAT_ON_RAMP_CURRENCY_ILS" | "FIAT_ON_RAMP_CURRENCY_JOD" | "FIAT_ON_RAMP_CURRENCY_KES" | "FIAT_ON_RAMP_CURRENCY_KWD" | "FIAT_ON_RAMP_CURRENCY_LKR" | "FIAT_ON_RAMP_CURRENCY_MXN" | "FIAT_ON_RAMP_CURRENCY_NGN" | "FIAT_ON_RAMP_CURRENCY_NOK" | "FIAT_ON_RAMP_CURRENCY_NZD" | "FIAT_ON_RAMP_CURRENCY_OMR" | "FIAT_ON_RAMP_CURRENCY_PEN" | "FIAT_ON_RAMP_CURRENCY_PLN" | "FIAT_ON_RAMP_CURRENCY_RON" | "FIAT_ON_RAMP_CURRENCY_SEK" | "FIAT_ON_RAMP_CURRENCY_THB" | "FIAT_ON_RAMP_CURRENCY_TRY" | "FIAT_ON_RAMP_CURRENCY_TWD" | "FIAT_ON_RAMP_CURRENCY_USD" | "FIAT_ON_RAMP_CURRENCY_VND" | "FIAT_ON_RAMP_CURRENCY_ZAR"; network: | "FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_BITCOIN" | "FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_ETHEREUM" | "FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_SOLANA" | "FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_BASE"; onrampProvider: "FIAT_ON_RAMP_PROVIDER_COINBASE" | "FIAT_ON_RAMP_PROVIDER_MOONPAY"; paymentMethod?: | "FIAT_ON_RAMP_PAYMENT_METHOD_CREDIT_DEBIT_CARD" | "FIAT_ON_RAMP_PAYMENT_METHOD_APPLE_PAY" | "FIAT_ON_RAMP_PAYMENT_METHOD_GBP_BANK_TRANSFER" | "FIAT_ON_RAMP_PAYMENT_METHOD_GBP_OPEN_BANKING_PAYMENT" | "FIAT_ON_RAMP_PAYMENT_METHOD_GOOGLE_PAY" | "FIAT_ON_RAMP_PAYMENT_METHOD_SEPA_BANK_TRANSFER" | "FIAT_ON_RAMP_PAYMENT_METHOD_PIX_INSTANT_PAYMENT" | "FIAT_ON_RAMP_PAYMENT_METHOD_PAYPAL" | "FIAT_ON_RAMP_PAYMENT_METHOD_VENMO" | "FIAT_ON_RAMP_PAYMENT_METHOD_MOONPAY_BALANCE" | "FIAT_ON_RAMP_PAYMENT_METHOD_CRYPTO_ACCOUNT" | "FIAT_ON_RAMP_PAYMENT_METHOD_FIAT_WALLET" | "FIAT_ON_RAMP_PAYMENT_METHOD_ACH_BANK_ACCOUNT"; sandboxMode?: boolean; walletAddress: string; }; initImportPrivateKeyIntent?: { userId: string; }; initImportWalletIntent?: { userId: string; }; initOtpAuthIntent?: { contact: string; emailCustomization?: { appName?: string; logoUrl?: string; magicLinkTemplate?: string; templateId?: string; templateVariables?: string; }; otpType: string; replyToEmailAddress?: string; sendFromEmailAddress?: string; sendFromEmailSenderName?: string; smsCustomization?: { template?: string; }; userIdentifier?: string; }; initOtpAuthIntentV2?: { alphanumeric?: boolean; contact: string; emailCustomization?: { appName?: string; logoUrl?: string; magicLinkTemplate?: string; templateId?: string; templateVariables?: string; }; otpLength?: number; otpType: string; replyToEmailAddress?: string; sendFromEmailAddress?: string; sendFromEmailSenderName?: string; smsCustomization?: { template?: string; }; userIdentifier?: string; }; initOtpIntent?: { alphanumeric?: boolean; contact: string; emailCustomization?: { appName?: string; logoUrl?: string; magicLinkTemplate?: string; templateId?: string; templateVariables?: string; }; expirationSeconds?: string; otpLength?: number; otpType: string; replyToEmailAddress?: string; sendFromEmailAddress?: string; sendFromEmailSenderName?: string; smsCustomization?: { template?: string; }; userIdentifier?: string; }; initUserEmailRecoveryIntent?: { email: string; emailCustomization?: { appName?: string; logoUrl?: string; magicLinkTemplate?: string; templateId?: string; templateVariables?: string; }; expirationSeconds?: string; targetPublicKey: string; }; oauth2AuthenticateIntent?: { authCode: string; codeVerifier: string; nonce?: string; oauth2CredentialId: string; redirectUri: string; }; oauthIntent?: { apiKeyName?: string; expirationSeconds?: string; invalidateExisting?: boolean; oidcToken: string; targetPublicKey: string; }; oauthLoginIntent?: { expirationSeconds?: string; invalidateExisting?: boolean; oidcToken: string; publicKey: string; }; otpAuthIntent?: { apiKeyName?: string; expirationSeconds?: string; invalidateExisting?: boolean; otpCode: string; otpId: string; targetPublicKey: string; }; otpLoginIntent?: { expirationSeconds?: string; invalidateExisting?: boolean; publicKey: string; verificationToken: string; }; recoverUserIntent?: { authenticator: { attestation: { attestationObject: string; clientDataJson: string; credentialId: string; transports: ( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]; }; authenticatorName: string; challenge: string; }; userId: string; }; rejectActivityIntent?: { fingerprint: string; }; removeOrganizationFeatureIntent?: { name: | "FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY" | "FEATURE_NAME_WEBAUTHN_ORIGINS" | "FEATURE_NAME_EMAIL_AUTH" | "FEATURE_NAME_EMAIL_RECOVERY" | "FEATURE_NAME_WEBHOOK" | "FEATURE_NAME_SMS_AUTH" | "FEATURE_NAME_OTP_EMAIL_AUTH" | "FEATURE_NAME_AUTH_PROXY"; }; setOrganizationFeatureIntent?: { name: | "FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY" | "FEATURE_NAME_WEBAUTHN_ORIGINS" | "FEATURE_NAME_EMAIL_AUTH" | "FEATURE_NAME_EMAIL_RECOVERY" | "FEATURE_NAME_WEBHOOK" | "FEATURE_NAME_SMS_AUTH" | "FEATURE_NAME_OTP_EMAIL_AUTH" | "FEATURE_NAME_AUTH_PROXY"; value: string; }; setPaymentMethodIntent?: { cardHolderEmail: string; cardHolderName: string; cvv: string; expiryMonth: string; expiryYear: string; number: string; }; setPaymentMethodIntentV2?: { cardHolderEmail: string; cardHolderName: string; paymentMethodId: string; }; signRawPayloadIntent?: { encoding: | "PAYLOAD_ENCODING_HEXADECIMAL" | "PAYLOAD_ENCODING_TEXT_UTF8" | "PAYLOAD_ENCODING_EIP712" | "PAYLOAD_ENCODING_EIP7702_AUTHORIZATION"; hashFunction: | "HASH_FUNCTION_NO_OP" | "HASH_FUNCTION_SHA256" | "HASH_FUNCTION_KECCAK256" | "HASH_FUNCTION_NOT_APPLICABLE"; payload: string; privateKeyId: string; }; signRawPayloadIntentV2?: { encoding: | "PAYLOAD_ENCODING_HEXADECIMAL" | "PAYLOAD_ENCODING_TEXT_UTF8" | "PAYLOAD_ENCODING_EIP712" | "PAYLOAD_ENCODING_EIP7702_AUTHORIZATION"; hashFunction: | "HASH_FUNCTION_NO_OP" | "HASH_FUNCTION_SHA256" | "HASH_FUNCTION_KECCAK256" | "HASH_FUNCTION_NOT_APPLICABLE"; payload: string; signWith: string; }; signRawPayloadsIntent?: { encoding: | "PAYLOAD_ENCODING_HEXADECIMAL" | "PAYLOAD_ENCODING_TEXT_UTF8" | "PAYLOAD_ENCODING_EIP712" | "PAYLOAD_ENCODING_EIP7702_AUTHORIZATION"; hashFunction: | "HASH_FUNCTION_NO_OP" | "HASH_FUNCTION_SHA256" | "HASH_FUNCTION_KECCAK256" | "HASH_FUNCTION_NOT_APPLICABLE"; payloads: string[]; signWith: string; }; signTransactionIntent?: { privateKeyId: string; type: | "TRANSACTION_TYPE_ETHEREUM" | "TRANSACTION_TYPE_SOLANA" | "TRANSACTION_TYPE_TRON"; unsignedTransaction: string; }; signTransactionIntentV2?: { signWith: string; type: | "TRANSACTION_TYPE_ETHEREUM" | "TRANSACTION_TYPE_SOLANA" | "TRANSACTION_TYPE_TRON"; unsignedTransaction: string; }; stampLoginIntent?: { expirationSeconds?: string; invalidateExisting?: boolean; publicKey: string; }; updateAllowedOriginsIntent?: { allowedOrigins: string[]; }; updateAuthProxyConfigIntent?: { allowedAuthMethods?: string[]; allowedOrigins?: string[]; emailAuthTemplateId?: string; emailCustomizationParams?: { appName?: string; logoUrl?: string; magicLinkTemplate?: string; templateId?: string; templateVariables?: string; }; oauth2ProviderCredentialIds?: { [key: string]: string; }; otpAlphanumeric?: boolean; otpExpirationSeconds?: number; otpLength?: number; otpTemplateId?: string; replyToEmailAddress?: string; sendFromEmailAddress?: string; sessionExpirationSeconds?: number; smsCustomizationParams?: { template?: string; }; verificationTokenExpirationSeconds?: number; walletKitSettings?: { enabledSocialProviders?: string[]; }; }; updateOauth2CredentialIntent?: { clientId: string; encryptedClientSecret: string; oauth2CredentialId: string; provider: "OAUTH2_PROVIDER_X" | "OAUTH2_PROVIDER_DISCORD"; }; updatePolicyIntent?: { policyCondition?: string; policyConsensus?: string; policyEffect?: "EFFECT_ALLOW" | "EFFECT_DENY"; policyId: string; policyName?: string; policyNotes?: string; }; updatePolicyIntentV2?: { policyCondition?: string; policyConsensus?: string; policyEffect?: "EFFECT_ALLOW" | "EFFECT_DENY"; policyId: string; policyName?: string; policyNotes?: string; }; updatePrivateKeyTagIntent?: { addPrivateKeyIds: string[]; newPrivateKeyTagName?: string; privateKeyTagId: string; removePrivateKeyIds: string[]; }; updateRootQuorumIntent?: { threshold: number; userIds: string[]; }; updateUserEmailIntent?: { userEmail: string; userId: string; verificationToken?: string; }; updateUserIntent?: { userEmail?: string; userId: string; userName?: string; userPhoneNumber?: string; userTagIds?: string[]; }; updateUserNameIntent?: { userId: string; userName: string; }; updateUserPhoneNumberIntent?: { userId: string; userPhoneNumber: string; verificationToken?: string; }; updateUserTagIntent?: { addUserIds: string[]; newUserTagName?: string; removeUserIds: string[]; userTagId: string; }; updateWalletIntent?: { walletId: string; walletName?: string; }; verifyOtpIntent?: { expirationSeconds?: string; otpCode: string; otpId: string; }; }; organizationId: string; result: { acceptInvitationResult?: { invitationId: string; userId: string; }; activateBillingTierResult?: { productId: string; }; createApiKeysResult?: { apiKeyIds: string[]; }; createApiOnlyUsersResult?: { userIds: string[]; }; createAuthenticatorsResult?: { authenticatorIds: string[]; }; createInvitationsResult?: { invitationIds: string[]; }; createOauth2CredentialResult?: { oauth2CredentialId: string; }; createOauthProvidersResult?: { providerIds: string[]; }; createOrganizationResult?: { organizationId: string; }; createPoliciesResult?: { policyIds: string[]; }; createPolicyResult?: { policyId: string; }; createPrivateKeysResult?: { privateKeyIds: string[]; }; createPrivateKeysResultV2?: { privateKeys: object[]; }; createPrivateKeyTagResult?: { privateKeyIds: string[]; privateKeyTagId: string; }; createReadOnlySessionResult?: { organizationId: string; organizationName: string; session: string; sessionExpiry: string; userId: string; username: string; }; createReadWriteSessionResult?: { apiKeyId: string; credentialBundle: string; organizationId: string; organizationName: string; userId: string; username: string; }; createReadWriteSessionResultV2?: { apiKeyId: string; credentialBundle: string; organizationId: string; organizationName: string; userId: string; username: string; }; createSmartContractInterfaceResult?: { smartContractInterfaceId: string; }; createSubOrganizationResult?: { rootUserIds?: string[]; subOrganizationId: string; }; createSubOrganizationResultV3?: { privateKeys: object[]; rootUserIds?: string[]; subOrganizationId: string; }; createSubOrganizationResultV4?: { rootUserIds?: string[]; subOrganizationId: string; wallet?: { addresses: string[]; walletId: string; }; }; createSubOrganizationResultV5?: { rootUserIds?: string[]; subOrganizationId: string; wallet?: { addresses: string[]; walletId: string; }; }; createSubOrganizationResultV6?: { rootUserIds?: string[]; subOrganizationId: string; wallet?: { addresses: string[]; walletId: string; }; }; createSubOrganizationResultV7?: { rootUserIds?: string[]; subOrganizationId: string; wallet?: { addresses: string[]; walletId: string; }; }; createUsersResult?: { userIds: string[]; }; createUserTagResult?: { userIds: string[]; userTagId: string; }; createWalletAccountsResult?: { addresses: string[]; }; createWalletResult?: { addresses: string[]; walletId: string; }; deleteApiKeysResult?: { apiKeyIds: string[]; }; deleteAuthenticatorsResult?: { authenticatorIds: string[]; }; deleteInvitationResult?: { invitationId: string; }; deleteOauth2CredentialResult?: { oauth2CredentialId: string; }; deleteOauthProvidersResult?: { providerIds: string[]; }; deleteOrganizationResult?: { organizationId: string; }; deletePaymentMethodResult?: { paymentMethodId: string; }; deletePolicyResult?: { policyId: string; }; deletePrivateKeysResult?: { privateKeyIds: string[]; }; deletePrivateKeyTagsResult?: { privateKeyIds: string[]; privateKeyTagIds: string[]; }; deleteSmartContractInterfaceResult?: { smartContractInterfaceId: string; }; deleteSubOrganizationResult?: { subOrganizationUuid: string; }; deleteUsersResult?: { userIds: string[]; }; deleteUserTagsResult?: { userIds: string[]; userTagIds: string[]; }; deleteWalletsResult?: { walletIds: string[]; }; disableAuthProxyResult?: { [key: string]: unknown; }; disablePrivateKeyResult?: { privateKeyId: string; }; emailAuthResult?: { apiKeyId: string; userId: string; }; enableAuthProxyResult?: { userId: string; }; exportPrivateKeyResult?: { exportBundle: string; privateKeyId: string; }; exportWalletAccountResult?: { address: string; exportBundle: string; }; exportWalletResult?: { exportBundle: string; walletId: string; }; importPrivateKeyResult?: { addresses: object[]; privateKeyId: string; }; importWalletResult?: { addresses: string[]; walletId: string; }; initFiatOnRampResult?: { onRampTransactionId: string; onRampUrl: string; }; initImportPrivateKeyResult?: { importBundle: string; }; initImportWalletResult?: { importBundle: string; }; initOtpAuthResult?: { otpId: string; }; initOtpAuthResultV2?: { otpId: string; }; initOtpResult?: { otpId: string; }; initUserEmailRecoveryResult?: { userId: string; }; oauth2AuthenticateResult?: { oidcToken: string; }; oauthLoginResult?: { session: string; }; oauthResult?: { apiKeyId: string; credentialBundle: string; userId: string; }; otpAuthResult?: { apiKeyId?: string; credentialBundle?: string; userId: string; }; otpLoginResult?: { session: string; }; recoverUserResult?: { authenticatorId: string[]; }; removeOrganizationFeatureResult?: { features: object[]; }; setOrganizationFeatureResult?: { features: object[]; }; setPaymentMethodResult?: { cardHolderEmail: string; cardHolderName: string; lastFour: string; }; signRawPayloadResult?: { r: string; s: string; v: string; }; signRawPayloadsResult?: { signatures?: object[]; }; signTransactionResult?: { signedTransaction: string; }; stampLoginResult?: { session: string; }; updateAllowedOriginsResult?: { [key: string]: unknown; }; updateAuthProxyConfigResult?: { configId?: string; }; updateOauth2CredentialResult?: { oauth2CredentialId: string; }; updatePolicyResult?: { policyId: string; }; updatePolicyResultV2?: { policyId: string; }; updatePrivateKeyTagResult?: { privateKeyTagId: string; }; updateRootQuorumResult?: { [key: string]: unknown; }; updateUserEmailResult?: { userId: string; }; updateUserNameResult?: { userId: string; }; updateUserPhoneNumberResult?: { userId: string; }; updateUserResult?: { userId: string; }; updateUserTagResult?: { userTagId: string; }; updateWalletResult?: { walletId: string; }; verifyOtpResult?: { verificationToken: string; }; }; status: | "ACTIVITY_STATUS_CREATED" | "ACTIVITY_STATUS_PENDING" | "ACTIVITY_STATUS_COMPLETED" | "ACTIVITY_STATUS_FAILED" | "ACTIVITY_STATUS_CONSENSUS_NEEDED" | "ACTIVITY_STATUS_REJECTED"; type: | "ACTIVITY_TYPE_CREATE_API_KEYS" | "ACTIVITY_TYPE_CREATE_USERS" | "ACTIVITY_TYPE_CREATE_PRIVATE_KEYS" | "ACTIVITY_TYPE_SIGN_RAW_PAYLOAD" | "ACTIVITY_TYPE_CREATE_INVITATIONS" | "ACTIVITY_TYPE_ACCEPT_INVITATION" | "ACTIVITY_TYPE_CREATE_POLICY" | "ACTIVITY_TYPE_DISABLE_PRIVATE_KEY" | "ACTIVITY_TYPE_DELETE_USERS" | "ACTIVITY_TYPE_DELETE_API_KEYS" | "ACTIVITY_TYPE_DELETE_INVITATION" | "ACTIVITY_TYPE_DELETE_ORGANIZATION" | "ACTIVITY_TYPE_DELETE_POLICY" | "ACTIVITY_TYPE_CREATE_USER_TAG" | "ACTIVITY_TYPE_DELETE_USER_TAGS" | "ACTIVITY_TYPE_CREATE_ORGANIZATION" | "ACTIVITY_TYPE_SIGN_TRANSACTION" | "ACTIVITY_TYPE_APPROVE_ACTIVITY" | "ACTIVITY_TYPE_REJECT_ACTIVITY" | "ACTIVITY_TYPE_DELETE_AUTHENTICATORS" | "ACTIVITY_TYPE_CREATE_AUTHENTICATORS" | "ACTIVITY_TYPE_CREATE_PRIVATE_KEY_TAG" | "ACTIVITY_TYPE_DELETE_PRIVATE_KEY_TAGS" | "ACTIVITY_TYPE_SET_PAYMENT_METHOD" | "ACTIVITY_TYPE_ACTIVATE_BILLING_TIER" | "ACTIVITY_TYPE_DELETE_PAYMENT_METHOD" | "ACTIVITY_TYPE_CREATE_POLICY_V2" | "ACTIVITY_TYPE_CREATE_POLICY_V3" | "ACTIVITY_TYPE_CREATE_API_ONLY_USERS" | "ACTIVITY_TYPE_UPDATE_ROOT_QUORUM" | "ACTIVITY_TYPE_UPDATE_USER_TAG" | "ACTIVITY_TYPE_UPDATE_PRIVATE_KEY_TAG" | "ACTIVITY_TYPE_CREATE_AUTHENTICATORS_V2" | "ACTIVITY_TYPE_CREATE_ORGANIZATION_V2" | "ACTIVITY_TYPE_CREATE_USERS_V2" | "ACTIVITY_TYPE_ACCEPT_INVITATION_V2" | "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION" | "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V2" | "ACTIVITY_TYPE_UPDATE_ALLOWED_ORIGINS" | "ACTIVITY_TYPE_CREATE_PRIVATE_KEYS_V2" | "ACTIVITY_TYPE_UPDATE_USER" | "ACTIVITY_TYPE_UPDATE_POLICY" | "ACTIVITY_TYPE_SET_PAYMENT_METHOD_V2" | "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V3" | "ACTIVITY_TYPE_CREATE_WALLET" | "ACTIVITY_TYPE_CREATE_WALLET_ACCOUNTS" | "ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY" | "ACTIVITY_TYPE_RECOVER_USER" | "ACTIVITY_TYPE_SET_ORGANIZATION_FEATURE" | "ACTIVITY_TYPE_REMOVE_ORGANIZATION_FEATURE" | "ACTIVITY_TYPE_SIGN_RAW_PAYLOAD_V2" | "ACTIVITY_TYPE_SIGN_TRANSACTION_V2" | "ACTIVITY_TYPE_EXPORT_PRIVATE_KEY" | "ACTIVITY_TYPE_EXPORT_WALLET" | "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V4" | "ACTIVITY_TYPE_EMAIL_AUTH" | "ACTIVITY_TYPE_EXPORT_WALLET_ACCOUNT" | "ACTIVITY_TYPE_INIT_IMPORT_WALLET" | "ACTIVITY_TYPE_IMPORT_WALLET" | "ACTIVITY_TYPE_INIT_IMPORT_PRIVATE_KEY" | "ACTIVITY_TYPE_IMPORT_PRIVATE_KEY" | "ACTIVITY_TYPE_CREATE_POLICIES" | "ACTIVITY_TYPE_SIGN_RAW_PAYLOADS" | "ACTIVITY_TYPE_CREATE_READ_ONLY_SESSION" | "ACTIVITY_TYPE_CREATE_OAUTH_PROVIDERS" | "ACTIVITY_TYPE_DELETE_OAUTH_PROVIDERS" | "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V5" | "ACTIVITY_TYPE_OAUTH" | "ACTIVITY_TYPE_CREATE_API_KEYS_V2" | "ACTIVITY_TYPE_CREATE_READ_WRITE_SESSION" | "ACTIVITY_TYPE_EMAIL_AUTH_V2" | "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V6" | "ACTIVITY_TYPE_DELETE_PRIVATE_KEYS" | "ACTIVITY_TYPE_DELETE_WALLETS" | "ACTIVITY_TYPE_CREATE_READ_WRITE_SESSION_V2" | "ACTIVITY_TYPE_DELETE_SUB_ORGANIZATION" | "ACTIVITY_TYPE_INIT_OTP_AUTH" | "ACTIVITY_TYPE_OTP_AUTH" | "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V7" | "ACTIVITY_TYPE_UPDATE_WALLET" | "ACTIVITY_TYPE_UPDATE_POLICY_V2" | "ACTIVITY_TYPE_CREATE_USERS_V3" | "ACTIVITY_TYPE_INIT_OTP_AUTH_V2" | "ACTIVITY_TYPE_INIT_OTP" | "ACTIVITY_TYPE_VERIFY_OTP" | "ACTIVITY_TYPE_OTP_LOGIN" | "ACTIVITY_TYPE_STAMP_LOGIN" | "ACTIVITY_TYPE_OAUTH_LOGIN" | "ACTIVITY_TYPE_UPDATE_USER_NAME" | "ACTIVITY_TYPE_UPDATE_USER_EMAIL" | "ACTIVITY_TYPE_UPDATE_USER_PHONE_NUMBER" | "ACTIVITY_TYPE_INIT_FIAT_ON_RAMP" | "ACTIVITY_TYPE_CREATE_SMART_CONTRACT_INTERFACE" | "ACTIVITY_TYPE_DELETE_SMART_CONTRACT_INTERFACE" | "ACTIVITY_TYPE_ENABLE_AUTH_PROXY" | "ACTIVITY_TYPE_DISABLE_AUTH_PROXY" | "ACTIVITY_TYPE_UPDATE_AUTH_PROXY_CONFIG" | "ACTIVITY_TYPE_CREATE_OAUTH2_CREDENTIAL" | "ACTIVITY_TYPE_UPDATE_OAUTH2_CREDENTIAL" | "ACTIVITY_TYPE_DELETE_OAUTH2_CREDENTIAL" | "ACTIVITY_TYPE_OAUTH2_AUTHENTICATE"; updatedAt: { nanos: string; seconds: string; }; votes: object[]; }

‐

activity.canApprove

boolean

‐

activity.canReject

boolean

‐

activity.createdAt

{ nanos: string; seconds: string; }

‐

activity.createdAt.nanos

string

‐

activity.createdAt.seconds

string

‐

activity.failure?

{ code?: number; details?: object & object[]; message?: string; }

Description

Failure reason of the intended action.

activity.failure.code?

number

Format: int32

activity.failure.details?

object & object[]

‐

activity.failure.message?

string

‐

activity.fingerprint

string

Description

An artifact verifying a User’s action.

activity.id

string

Description

Unique identifier for a given Activity object.

activity.intent

{ acceptInvitationIntent?: { authenticator: { attestation: { authenticatorAttachment?: null | "cross-platform" | "platform"; clientExtensionResults: { appid?: boolean; appidExclude?: boolean; credProps?: { rk: boolean; }; }; id: string; rawId: string; response: { attestationObject: string; authenticatorAttachment?: null | "cross-platform" | "platform"; clientDataJson: string; transports?: ( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]; }; type: "public-key"; }; authenticatorName: string; challenge: string; userId: string; }; invitationId: string; userId: string; }; acceptInvitationIntentV2?: { authenticator: { attestation: { attestationObject: string; clientDataJson: string; credentialId: string; transports: ( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]; }; authenticatorName: string; challenge: string; }; invitationId: string; userId: string; }; activateBillingTierIntent?: { productId: string; }; approveActivityIntent?: { fingerprint: string; }; createApiKeysIntent?: { apiKeys: object[]; userId: string; }; createApiKeysIntentV2?: { apiKeys: object[]; userId: string; }; createApiOnlyUsersIntent?: { apiOnlyUsers: object[]; }; createAuthenticatorsIntent?: { authenticators: object[]; userId: string; }; createAuthenticatorsIntentV2?: { authenticators: object[]; userId: string; }; createInvitationsIntent?: { invitations: object[]; }; createOauth2CredentialIntent?: { clientId: string; encryptedClientSecret: string; provider: "OAUTH2_PROVIDER_X" | "OAUTH2_PROVIDER_DISCORD"; }; createOauthProvidersIntent?: { oauthProviders: object[]; userId: string; }; createOrganizationIntent?: { organizationName: string; rootAuthenticator: { attestation: { authenticatorAttachment?: null | "cross-platform" | "platform"; clientExtensionResults: { appid?: boolean; appidExclude?: boolean; credProps?: { rk: boolean; }; }; id: string; rawId: string; response: { attestationObject: string; authenticatorAttachment?: null | "cross-platform" | "platform"; clientDataJson: string; transports?: ( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]; }; type: "public-key"; }; authenticatorName: string; challenge: string; userId: string; }; rootEmail: string; rootUserId?: string; }; createOrganizationIntentV2?: { organizationName: string; rootAuthenticator: { attestation: { attestationObject: string; clientDataJson: string; credentialId: string; transports: ( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]; }; authenticatorName: string; challenge: string; }; rootEmail: string; rootUserId?: string; }; createPoliciesIntent?: { policies: object[]; }; createPolicyIntent?: { effect: "EFFECT_ALLOW" | "EFFECT_DENY"; notes?: string; policyName: string; selectors: object[]; }; createPolicyIntentV2?: { effect: "EFFECT_ALLOW" | "EFFECT_DENY"; notes?: string; policyName: string; selectors: object[]; }; createPolicyIntentV3?: { condition?: string; consensus?: string; effect: "EFFECT_ALLOW" | "EFFECT_DENY"; notes?: string; policyName: string; }; createPrivateKeysIntent?: { privateKeys: object[]; }; createPrivateKeysIntentV2?: { privateKeys: object[]; }; createPrivateKeyTagIntent?: { privateKeyIds: string[]; privateKeyTagName: string; }; createReadOnlySessionIntent?: { [key: string]: unknown; }; createReadWriteSessionIntent?: { apiKeyName?: string; email: string; expirationSeconds?: string; targetPublicKey: string; }; createReadWriteSessionIntentV2?: { apiKeyName?: string; expirationSeconds?: string; invalidateExisting?: boolean; targetPublicKey: string; userId?: string; }; createSmartContractInterfaceIntent?: { label: string; notes?: string; smartContractAddress: string; smartContractInterface: string; type: | "SMART_CONTRACT_INTERFACE_TYPE_ETHEREUM" | "SMART_CONTRACT_INTERFACE_TYPE_SOLANA"; }; createSubOrganizationIntent?: { name: string; rootAuthenticator: { attestation: { attestationObject: string; clientDataJson: string; credentialId: string; transports: ( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]; }; authenticatorName: string; challenge: string; }; }; createSubOrganizationIntentV2?: { rootQuorumThreshold: number; rootUsers: object[]; subOrganizationName: string; }; createSubOrganizationIntentV3?: { privateKeys: object[]; rootQuorumThreshold: number; rootUsers: object[]; subOrganizationName: string; }; createSubOrganizationIntentV4?: { disableEmailAuth?: boolean; disableEmailRecovery?: boolean; rootQuorumThreshold: number; rootUsers: object[]; subOrganizationName: string; wallet?: { accounts: object[]; mnemonicLength?: number; walletName: string; }; }; createSubOrganizationIntentV5?: { disableEmailAuth?: boolean; disableEmailRecovery?: boolean; rootQuorumThreshold: number; rootUsers: object[]; subOrganizationName: string; wallet?: { accounts: object[]; mnemonicLength?: number; walletName: string; }; }; createSubOrganizationIntentV6?: { disableEmailAuth?: boolean; disableEmailRecovery?: boolean; rootQuorumThreshold: number; rootUsers: object[]; subOrganizationName: string; wallet?: { accounts: object[]; mnemonicLength?: number; walletName: string; }; }; createSubOrganizationIntentV7?: { disableEmailAuth?: boolean; disableEmailRecovery?: boolean; disableOtpEmailAuth?: boolean; disableSmsAuth?: boolean; rootQuorumThreshold: number; rootUsers: object[]; subOrganizationName: string; verificationToken?: string; wallet?: { accounts: object[]; mnemonicLength?: number; walletName: string; }; }; createUsersIntent?: { users: object[]; }; createUsersIntentV2?: { users: object[]; }; createUsersIntentV3?: { users: object[]; }; createUserTagIntent?: { userIds: string[]; userTagName: string; }; createWalletAccountsIntent?: { accounts: object[]; walletId: string; }; createWalletIntent?: { accounts: object[]; mnemonicLength?: number; walletName: string; }; deleteApiKeysIntent?: { apiKeyIds: string[]; userId: string; }; deleteAuthenticatorsIntent?: { authenticatorIds: string[]; userId: string; }; deleteInvitationIntent?: { invitationId: string; }; deleteOauth2CredentialIntent?: { oauth2CredentialId: string; }; deleteOauthProvidersIntent?: { providerIds: string[]; userId: string; }; deleteOrganizationIntent?: { organizationId: string; }; deletePaymentMethodIntent?: { paymentMethodId: string; }; deletePolicyIntent?: { policyId: string; }; deletePrivateKeysIntent?: { deleteWithoutExport?: boolean; privateKeyIds: string[]; }; deletePrivateKeyTagsIntent?: { privateKeyTagIds: string[]; }; deleteSmartContractInterfaceIntent?: { smartContractInterfaceId: string; }; deleteSubOrganizationIntent?: { deleteWithoutExport?: boolean; }; deleteUsersIntent?: { userIds: string[]; }; deleteUserTagsIntent?: { userTagIds: string[]; }; deleteWalletsIntent?: { deleteWithoutExport?: boolean; walletIds: string[]; }; disableAuthProxyIntent?: { [key: string]: unknown; }; disablePrivateKeyIntent?: { privateKeyId: string; }; emailAuthIntent?: { apiKeyName?: string; email: string; emailCustomization?: { appName?: string; logoUrl?: string; magicLinkTemplate?: string; templateId?: string; templateVariables?: string; }; expirationSeconds?: string; invalidateExisting?: boolean; replyToEmailAddress?: string; sendFromEmailAddress?: string; sendFromEmailSenderName?: string; targetPublicKey: string; }; emailAuthIntentV2?: { apiKeyName?: string; email: string; emailCustomization?: { appName?: string; logoUrl?: string; magicLinkTemplate?: string; templateId?: string; templateVariables?: string; }; expirationSeconds?: string; invalidateExisting?: boolean; replyToEmailAddress?: string; sendFromEmailAddress?: string; sendFromEmailSenderName?: string; targetPublicKey: string; }; enableAuthProxyIntent?: { [key: string]: unknown; }; exportPrivateKeyIntent?: { privateKeyId: string; targetPublicKey: string; }; exportWalletAccountIntent?: { address: string; targetPublicKey: string; }; exportWalletIntent?: { language?: | "MNEMONIC_LANGUAGE_ENGLISH" | "MNEMONIC_LANGUAGE_SIMPLIFIED_CHINESE" | "MNEMONIC_LANGUAGE_TRADITIONAL_CHINESE" | "MNEMONIC_LANGUAGE_CZECH" | "MNEMONIC_LANGUAGE_FRENCH" | "MNEMONIC_LANGUAGE_ITALIAN" | "MNEMONIC_LANGUAGE_JAPANESE" | "MNEMONIC_LANGUAGE_KOREAN" | "MNEMONIC_LANGUAGE_SPANISH"; targetPublicKey: string; walletId: string; }; importPrivateKeyIntent?: { addressFormats: ( | "ADDRESS_FORMAT_UNCOMPRESSED" | "ADDRESS_FORMAT_COMPRESSED" | "ADDRESS_FORMAT_ETHEREUM" | "ADDRESS_FORMAT_SOLANA" | "ADDRESS_FORMAT_COSMOS" | "ADDRESS_FORMAT_TRON" | "ADDRESS_FORMAT_SUI" | "ADDRESS_FORMAT_APTOS" | "ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH" | "ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH" | "ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH" | "ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH" | "ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR" | "ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH" | "ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH" | "ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH" | "ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH" | "ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR" | "ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH" | "ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH" | "ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH" | "ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH" | "ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR" | "ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH" | "ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH" | "ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH" | "ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH" | "ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR" | "ADDRESS_FORMAT_SEI" | "ADDRESS_FORMAT_XLM" | "ADDRESS_FORMAT_DOGE_MAINNET" | "ADDRESS_FORMAT_DOGE_TESTNET" | "ADDRESS_FORMAT_TON_V3R2" | "ADDRESS_FORMAT_TON_V4R2" | "ADDRESS_FORMAT_TON_V5R1" | "ADDRESS_FORMAT_XRP")[]; curve: "CURVE_SECP256K1" | "CURVE_ED25519"; encryptedBundle: string; privateKeyName: string; userId: string; }; importWalletIntent?: { accounts: object[]; encryptedBundle: string; userId: string; walletName: string; }; initFiatOnRampIntent?: { countryCode?: string; countrySubdivisionCode?: string; cryptoCurrencyCode: | "FIAT_ON_RAMP_CRYPTO_CURRENCY_BTC" | "FIAT_ON_RAMP_CRYPTO_CURRENCY_ETH" | "FIAT_ON_RAMP_CRYPTO_CURRENCY_SOL" | "FIAT_ON_RAMP_CRYPTO_CURRENCY_USDC"; fiatCurrencyAmount?: string; fiatCurrencyCode?: | "FIAT_ON_RAMP_CURRENCY_AUD" | "FIAT_ON_RAMP_CURRENCY_BGN" | "FIAT_ON_RAMP_CURRENCY_BRL" | "FIAT_ON_RAMP_CURRENCY_CAD" | "FIAT_ON_RAMP_CURRENCY_CHF" | "FIAT_ON_RAMP_CURRENCY_COP" | "FIAT_ON_RAMP_CURRENCY_CZK" | "FIAT_ON_RAMP_CURRENCY_DKK" | "FIAT_ON_RAMP_CURRENCY_DOP" | "FIAT_ON_RAMP_CURRENCY_EGP" | "FIAT_ON_RAMP_CURRENCY_EUR" | "FIAT_ON_RAMP_CURRENCY_GBP" | "FIAT_ON_RAMP_CURRENCY_HKD" | "FIAT_ON_RAMP_CURRENCY_IDR" | "FIAT_ON_RAMP_CURRENCY_ILS" | "FIAT_ON_RAMP_CURRENCY_JOD" | "FIAT_ON_RAMP_CURRENCY_KES" | "FIAT_ON_RAMP_CURRENCY_KWD" | "FIAT_ON_RAMP_CURRENCY_LKR" | "FIAT_ON_RAMP_CURRENCY_MXN" | "FIAT_ON_RAMP_CURRENCY_NGN" | "FIAT_ON_RAMP_CURRENCY_NOK" | "FIAT_ON_RAMP_CURRENCY_NZD" | "FIAT_ON_RAMP_CURRENCY_OMR" | "FIAT_ON_RAMP_CURRENCY_PEN" | "FIAT_ON_RAMP_CURRENCY_PLN" | "FIAT_ON_RAMP_CURRENCY_RON" | "FIAT_ON_RAMP_CURRENCY_SEK" | "FIAT_ON_RAMP_CURRENCY_THB" | "FIAT_ON_RAMP_CURRENCY_TRY" | "FIAT_ON_RAMP_CURRENCY_TWD" | "FIAT_ON_RAMP_CURRENCY_USD" | "FIAT_ON_RAMP_CURRENCY_VND" | "FIAT_ON_RAMP_CURRENCY_ZAR"; network: | "FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_BITCOIN" | "FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_ETHEREUM" | "FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_SOLANA" | "FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_BASE"; onrampProvider: "FIAT_ON_RAMP_PROVIDER_COINBASE" | "FIAT_ON_RAMP_PROVIDER_MOONPAY"; paymentMethod?: | "FIAT_ON_RAMP_PAYMENT_METHOD_CREDIT_DEBIT_CARD" | "FIAT_ON_RAMP_PAYMENT_METHOD_APPLE_PAY" | "FIAT_ON_RAMP_PAYMENT_METHOD_GBP_BANK_TRANSFER" | "FIAT_ON_RAMP_PAYMENT_METHOD_GBP_OPEN_BANKING_PAYMENT" | "FIAT_ON_RAMP_PAYMENT_METHOD_GOOGLE_PAY" | "FIAT_ON_RAMP_PAYMENT_METHOD_SEPA_BANK_TRANSFER" | "FIAT_ON_RAMP_PAYMENT_METHOD_PIX_INSTANT_PAYMENT" | "FIAT_ON_RAMP_PAYMENT_METHOD_PAYPAL" | "FIAT_ON_RAMP_PAYMENT_METHOD_VENMO" | "FIAT_ON_RAMP_PAYMENT_METHOD_MOONPAY_BALANCE" | "FIAT_ON_RAMP_PAYMENT_METHOD_CRYPTO_ACCOUNT" | "FIAT_ON_RAMP_PAYMENT_METHOD_FIAT_WALLET" | "FIAT_ON_RAMP_PAYMENT_METHOD_ACH_BANK_ACCOUNT"; sandboxMode?: boolean; walletAddress: string; }; initImportPrivateKeyIntent?: { userId: string; }; initImportWalletIntent?: { userId: string; }; initOtpAuthIntent?: { contact: string; emailCustomization?: { appName?: string; logoUrl?: string; magicLinkTemplate?: string; templateId?: string; templateVariables?: string; }; otpType: string; replyToEmailAddress?: string; sendFromEmailAddress?: string; sendFromEmailSenderName?: string; smsCustomization?: { template?: string; }; userIdentifier?: string; }; initOtpAuthIntentV2?: { alphanumeric?: boolean; contact: string; emailCustomization?: { appName?: string; logoUrl?: string; magicLinkTemplate?: string; templateId?: string; templateVariables?: string; }; otpLength?: number; otpType: string; replyToEmailAddress?: string; sendFromEmailAddress?: string; sendFromEmailSenderName?: string; smsCustomization?: { template?: string; }; userIdentifier?: string; }; initOtpIntent?: { alphanumeric?: boolean; contact: string; emailCustomization?: { appName?: string; logoUrl?: string; magicLinkTemplate?: string; templateId?: string; templateVariables?: string; }; expirationSeconds?: string; otpLength?: number; otpType: string; replyToEmailAddress?: string; sendFromEmailAddress?: string; sendFromEmailSenderName?: string; smsCustomization?: { template?: string; }; userIdentifier?: string; }; initUserEmailRecoveryIntent?: { email: string; emailCustomization?: { appName?: string; logoUrl?: string; magicLinkTemplate?: string; templateId?: string; templateVariables?: string; }; expirationSeconds?: string; targetPublicKey: string; }; oauth2AuthenticateIntent?: { authCode: string; codeVerifier: string; nonce?: string; oauth2CredentialId: string; redirectUri: string; }; oauthIntent?: { apiKeyName?: string; expirationSeconds?: string; invalidateExisting?: boolean; oidcToken: string; targetPublicKey: string; }; oauthLoginIntent?: { expirationSeconds?: string; invalidateExisting?: boolean; oidcToken: string; publicKey: string; }; otpAuthIntent?: { apiKeyName?: string; expirationSeconds?: string; invalidateExisting?: boolean; otpCode: string; otpId: string; targetPublicKey: string; }; otpLoginIntent?: { expirationSeconds?: string; invalidateExisting?: boolean; publicKey: string; verificationToken: string; }; recoverUserIntent?: { authenticator: { attestation: { attestationObject: string; clientDataJson: string; credentialId: string; transports: ( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]; }; authenticatorName: string; challenge: string; }; userId: string; }; rejectActivityIntent?: { fingerprint: string; }; removeOrganizationFeatureIntent?: { name: | "FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY" | "FEATURE_NAME_WEBAUTHN_ORIGINS" | "FEATURE_NAME_EMAIL_AUTH" | "FEATURE_NAME_EMAIL_RECOVERY" | "FEATURE_NAME_WEBHOOK" | "FEATURE_NAME_SMS_AUTH" | "FEATURE_NAME_OTP_EMAIL_AUTH" | "FEATURE_NAME_AUTH_PROXY"; }; setOrganizationFeatureIntent?: { name: | "FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY" | "FEATURE_NAME_WEBAUTHN_ORIGINS" | "FEATURE_NAME_EMAIL_AUTH" | "FEATURE_NAME_EMAIL_RECOVERY" | "FEATURE_NAME_WEBHOOK" | "FEATURE_NAME_SMS_AUTH" | "FEATURE_NAME_OTP_EMAIL_AUTH" | "FEATURE_NAME_AUTH_PROXY"; value: string; }; setPaymentMethodIntent?: { cardHolderEmail: string; cardHolderName: string; cvv: string; expiryMonth: string; expiryYear: string; number: string; }; setPaymentMethodIntentV2?: { cardHolderEmail: string; cardHolderName: string; paymentMethodId: string; }; signRawPayloadIntent?: { encoding: | "PAYLOAD_ENCODING_HEXADECIMAL" | "PAYLOAD_ENCODING_TEXT_UTF8" | "PAYLOAD_ENCODING_EIP712" | "PAYLOAD_ENCODING_EIP7702_AUTHORIZATION"; hashFunction: | "HASH_FUNCTION_NO_OP" | "HASH_FUNCTION_SHA256" | "HASH_FUNCTION_KECCAK256" | "HASH_FUNCTION_NOT_APPLICABLE"; payload: string; privateKeyId: string; }; signRawPayloadIntentV2?: { encoding: | "PAYLOAD_ENCODING_HEXADECIMAL" | "PAYLOAD_ENCODING_TEXT_UTF8" | "PAYLOAD_ENCODING_EIP712" | "PAYLOAD_ENCODING_EIP7702_AUTHORIZATION"; hashFunction: | "HASH_FUNCTION_NO_OP" | "HASH_FUNCTION_SHA256" | "HASH_FUNCTION_KECCAK256" | "HASH_FUNCTION_NOT_APPLICABLE"; payload: string; signWith: string; }; signRawPayloadsIntent?: { encoding: | "PAYLOAD_ENCODING_HEXADECIMAL" | "PAYLOAD_ENCODING_TEXT_UTF8" | "PAYLOAD_ENCODING_EIP712" | "PAYLOAD_ENCODING_EIP7702_AUTHORIZATION"; hashFunction: | "HASH_FUNCTION_NO_OP" | "HASH_FUNCTION_SHA256" | "HASH_FUNCTION_KECCAK256" | "HASH_FUNCTION_NOT_APPLICABLE"; payloads: string[]; signWith: string; }; signTransactionIntent?: { privateKeyId: string; type: | "TRANSACTION_TYPE_ETHEREUM" | "TRANSACTION_TYPE_SOLANA" | "TRANSACTION_TYPE_TRON"; unsignedTransaction: string; }; signTransactionIntentV2?: { signWith: string; type: | "TRANSACTION_TYPE_ETHEREUM" | "TRANSACTION_TYPE_SOLANA" | "TRANSACTION_TYPE_TRON"; unsignedTransaction: string; }; stampLoginIntent?: { expirationSeconds?: string; invalidateExisting?: boolean; publicKey: string; }; updateAllowedOriginsIntent?: { allowedOrigins: string[]; }; updateAuthProxyConfigIntent?: { allowedAuthMethods?: string[]; allowedOrigins?: string[]; emailAuthTemplateId?: string; emailCustomizationParams?: { appName?: string; logoUrl?: string; magicLinkTemplate?: string; templateId?: string; templateVariables?: string; }; oauth2ProviderCredentialIds?: { [key: string]: string; }; otpAlphanumeric?: boolean; otpExpirationSeconds?: number; otpLength?: number; otpTemplateId?: string; replyToEmailAddress?: string; sendFromEmailAddress?: string; sessionExpirationSeconds?: number; smsCustomizationParams?: { template?: string; }; verificationTokenExpirationSeconds?: number; walletKitSettings?: { enabledSocialProviders?: string[]; }; }; updateOauth2CredentialIntent?: { clientId: string; encryptedClientSecret: string; oauth2CredentialId: string; provider: "OAUTH2_PROVIDER_X" | "OAUTH2_PROVIDER_DISCORD"; }; updatePolicyIntent?: { policyCondition?: string; policyConsensus?: string; policyEffect?: "EFFECT_ALLOW" | "EFFECT_DENY"; policyId: string; policyName?: string; policyNotes?: string; }; updatePolicyIntentV2?: { policyCondition?: string; policyConsensus?: string; policyEffect?: "EFFECT_ALLOW" | "EFFECT_DENY"; policyId: string; policyName?: string; policyNotes?: string; }; updatePrivateKeyTagIntent?: { addPrivateKeyIds: string[]; newPrivateKeyTagName?: string; privateKeyTagId: string; removePrivateKeyIds: string[]; }; updateRootQuorumIntent?: { threshold: number; userIds: string[]; }; updateUserEmailIntent?: { userEmail: string; userId: string; verificationToken?: string; }; updateUserIntent?: { userEmail?: string; userId: string; userName?: string; userPhoneNumber?: string; userTagIds?: string[]; }; updateUserNameIntent?: { userId: string; userName: string; }; updateUserPhoneNumberIntent?: { userId: string; userPhoneNumber: string; verificationToken?: string; }; updateUserTagIntent?: { addUserIds: string[]; newUserTagName?: string; removeUserIds: string[]; userTagId: string; }; updateWalletIntent?: { walletId: string; walletName?: string; }; verifyOtpIntent?: { expirationSeconds?: string; otpCode: string; otpId: string; }; }

Description

Intent object crafted by Turnkey based on the user request, used to assess the permissibility of an action.

activity.intent.acceptInvitationIntent?

{ authenticator: { attestation: { authenticatorAttachment?: null | "cross-platform" | "platform"; clientExtensionResults: { appid?: boolean; appidExclude?: boolean; credProps?: { rk: boolean; }; }; id: string; rawId: string; response: { attestationObject: string; authenticatorAttachment?: null | "cross-platform" | "platform"; clientDataJson: string; transports?: ( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]; }; type: "public-key"; }; authenticatorName: string; challenge: string; userId: string; }; invitationId: string; userId: string; }

‐

activity.intent.acceptInvitationIntent.authenticator

{ attestation: { authenticatorAttachment?: null | "cross-platform" | "platform"; clientExtensionResults: { appid?: boolean; appidExclude?: boolean; credProps?: { rk: boolean; }; }; id: string; rawId: string; response: { attestationObject: string; authenticatorAttachment?: null | "cross-platform" | "platform"; clientDataJson: string; transports?: ( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]; }; type: "public-key"; }; authenticatorName: string; challenge: string; userId: string; }

Description

WebAuthN hardware devices that can be used to log in to the Turnkey web app.

activity.intent.acceptInvitationIntent.authenticator.attestation

{ authenticatorAttachment?: null | "cross-platform" | "platform"; clientExtensionResults: { appid?: boolean; appidExclude?: boolean; credProps?: { rk: boolean; }; }; id: string; rawId: string; response: { attestationObject: string; authenticatorAttachment?: null | "cross-platform" | "platform"; clientDataJson: string; transports?: ( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]; }; type: "public-key"; }

‐

activity.intent.acceptInvitationIntent.authenticator.attestation.authenticatorAttachment?

null | "cross-platform" | "platform"

activity.intent.acceptInvitationIntent.authenticator.attestation.clientExtensionResults

{ appid?: boolean; appidExclude?: boolean; credProps?: { rk: boolean; }; }

‐

activity.intent.acceptInvitationIntent.authenticator.attestation.clientExtensionResults.appid?

boolean

‐

activity.intent.acceptInvitationIntent.authenticator.attestation.clientExtensionResults.appidExclude?

boolean

‐

activity.intent.acceptInvitationIntent.authenticator.attestation.clientExtensionResults.credProps?

{ rk: boolean; }

‐

activity.intent.acceptInvitationIntent.authenticator.attestation.clientExtensionResults.credProps.rk

boolean

‐

activity.intent.acceptInvitationIntent.authenticator.attestation.id

string

‐

activity.intent.acceptInvitationIntent.authenticator.attestation.rawId

string

‐

activity.intent.acceptInvitationIntent.authenticator.attestation.response

{ attestationObject: string; authenticatorAttachment?: null | "cross-platform" | "platform"; clientDataJson: string; transports?: ( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]; }

‐

activity.intent.acceptInvitationIntent.authenticator.attestation.response.attestationObject

string

‐

activity.intent.acceptInvitationIntent.authenticator.attestation.response.authenticatorAttachment?

null | "cross-platform" | "platform"

activity.intent.acceptInvitationIntent.authenticator.attestation.response.clientDataJson

string

‐

activity.intent.acceptInvitationIntent.authenticator.attestation.response.transports?

( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]

‐

activity.intent.acceptInvitationIntent.authenticator.attestation.type

"public-key"

activity.intent.acceptInvitationIntent.authenticator.authenticatorName

string

Description

Human-readable name for an Authenticator.

activity.intent.acceptInvitationIntent.authenticator.challenge

string

Description

Challenge presented for authentication purposes.

activity.intent.acceptInvitationIntent.authenticator.userId

string

Description

Unique identifier for a given User.

activity.intent.acceptInvitationIntent.invitationId

string

Description

Unique identifier for a given Invitation object.

activity.intent.acceptInvitationIntent.userId

string

Description

Unique identifier for a given User.

activity.intent.acceptInvitationIntentV2?

{ authenticator: { attestation: { attestationObject: string; clientDataJson: string; credentialId: string; transports: ( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]; }; authenticatorName: string; challenge: string; }; invitationId: string; userId: string; }

‐

activity.intent.acceptInvitationIntentV2.authenticator

{ attestation: { attestationObject: string; clientDataJson: string; credentialId: string; transports: ( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]; }; authenticatorName: string; challenge: string; }

Description

WebAuthN hardware devices that can be used to log in to the Turnkey web app.

activity.intent.acceptInvitationIntentV2.authenticator.attestation

{ attestationObject: string; clientDataJson: string; credentialId: string; transports: ( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]; }

Description

The attestation that proves custody of the authenticator and provides metadata about it.

activity.intent.acceptInvitationIntentV2.authenticator.attestation.attestationObject

string

Description

A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses.

activity.intent.acceptInvitationIntentV2.authenticator.attestation.clientDataJson

string

Description

A base64 url encoded payload containing metadata about the signing context and the challenge.

activity.intent.acceptInvitationIntentV2.authenticator.attestation.credentialId

string

Description

The cbor encoded then base64 url encoded id of the credential.

activity.intent.acceptInvitationIntentV2.authenticator.attestation.transports

( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]

Description

The type of authenticator transports.

activity.intent.acceptInvitationIntentV2.authenticator.authenticatorName

string

Description

Human-readable name for an Authenticator.

activity.intent.acceptInvitationIntentV2.authenticator.challenge

string

Description

Challenge presented for authentication purposes.

activity.intent.acceptInvitationIntentV2.invitationId

string

Description

Unique identifier for a given Invitation object.

activity.intent.acceptInvitationIntentV2.userId

string

Description

Unique identifier for a given User.

activity.intent.activateBillingTierIntent?

{ productId: string; }

‐

activity.intent.activateBillingTierIntent.productId

string

Description

The product that the customer wants to subscribe to.

activity.intent.approveActivityIntent?

{ fingerprint: string; }

‐

activity.intent.approveActivityIntent.fingerprint

string

Description

An artifact verifying a User’s action.

activity.intent.createApiKeysIntent?

{ apiKeys: object[]; userId: string; }

‐

activity.intent.createApiKeysIntent.apiKeys

object[]

Description

A list of API Keys.

activity.intent.createApiKeysIntent.userId

string

Description

Unique identifier for a given User.

activity.intent.createApiKeysIntentV2?

{ apiKeys: object[]; userId: string; }

‐

activity.intent.createApiKeysIntentV2.apiKeys

object[]

Description

A list of API Keys.

activity.intent.createApiKeysIntentV2.userId

string

Description

Unique identifier for a given User.

activity.intent.createApiOnlyUsersIntent?

{ apiOnlyUsers: object[]; }

‐

activity.intent.createApiOnlyUsersIntent.apiOnlyUsers

object[]

Description

A list of API-only Users to create.

activity.intent.createAuthenticatorsIntent?

{ authenticators: object[]; userId: string; }

‐

activity.intent.createAuthenticatorsIntent.authenticators

object[]

Description

A list of Authenticators.

activity.intent.createAuthenticatorsIntent.userId

string

Description

Unique identifier for a given User.

activity.intent.createAuthenticatorsIntentV2?

{ authenticators: object[]; userId: string; }

‐

activity.intent.createAuthenticatorsIntentV2.authenticators

object[]

Description

A list of Authenticators.

activity.intent.createAuthenticatorsIntentV2.userId

string

Description

Unique identifier for a given User.

activity.intent.createInvitationsIntent?

{ invitations: object[]; }

‐

activity.intent.createInvitationsIntent.invitations

object[]

Description

A list of Invitations.

activity.intent.createOauth2CredentialIntent?

{ clientId: string; encryptedClientSecret: string; provider: "OAUTH2_PROVIDER_X" | "OAUTH2_PROVIDER_DISCORD"; }

‐

activity.intent.createOauth2CredentialIntent.clientId

string

Description

The Client ID issued by the OAuth 2.0 provider

activity.intent.createOauth2CredentialIntent.encryptedClientSecret

string

Description

The client secret issued by the OAuth 2.0 provider encrypted to the TLS Fetcher quorum key

activity.intent.createOauth2CredentialIntent.provider

"OAUTH2_PROVIDER_X" | "OAUTH2_PROVIDER_DISCORD"

Description

The OAuth 2.0 provider

activity.intent.createOauthProvidersIntent?

{ oauthProviders: object[]; userId: string; }

‐

activity.intent.createOauthProvidersIntent.oauthProviders

object[]

Description

A list of Oauth providers.

activity.intent.createOauthProvidersIntent.userId

string

Description

The ID of the User to add an Oauth provider to

activity.intent.createOrganizationIntent?

{ organizationName: string; rootAuthenticator: { attestation: { authenticatorAttachment?: null | "cross-platform" | "platform"; clientExtensionResults: { appid?: boolean; appidExclude?: boolean; credProps?: { rk: boolean; }; }; id: string; rawId: string; response: { attestationObject: string; authenticatorAttachment?: null | "cross-platform" | "platform"; clientDataJson: string; transports?: ( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]; }; type: "public-key"; }; authenticatorName: string; challenge: string; userId: string; }; rootEmail: string; rootUserId?: string; }

‐

activity.intent.createOrganizationIntent.organizationName

string

Description

Human-readable name for an Organization.

activity.intent.createOrganizationIntent.rootAuthenticator

{ attestation: { authenticatorAttachment?: null | "cross-platform" | "platform"; clientExtensionResults: { appid?: boolean; appidExclude?: boolean; credProps?: { rk: boolean; }; }; id: string; rawId: string; response: { attestationObject: string; authenticatorAttachment?: null | "cross-platform" | "platform"; clientDataJson: string; transports?: ( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]; }; type: "public-key"; }; authenticatorName: string; challenge: string; userId: string; }

Description

The root user’s Authenticator.

activity.intent.createOrganizationIntent.rootAuthenticator.attestation

{ authenticatorAttachment?: null | "cross-platform" | "platform"; clientExtensionResults: { appid?: boolean; appidExclude?: boolean; credProps?: { rk: boolean; }; }; id: string; rawId: string; response: { attestationObject: string; authenticatorAttachment?: null | "cross-platform" | "platform"; clientDataJson: string; transports?: ( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]; }; type: "public-key"; }

‐

activity.intent.createOrganizationIntent.rootAuthenticator.attestation.authenticatorAttachment?

null | "cross-platform" | "platform"

activity.intent.createOrganizationIntent.rootAuthenticator.attestation.clientExtensionResults

{ appid?: boolean; appidExclude?: boolean; credProps?: { rk: boolean; }; }

‐

activity.intent.createOrganizationIntent.rootAuthenticator.attestation.clientExtensionResults.appid?

boolean

‐

activity.intent.createOrganizationIntent.rootAuthenticator.attestation.clientExtensionResults.appidExclude?

boolean

‐

activity.intent.createOrganizationIntent.rootAuthenticator.attestation.clientExtensionResults.credProps?

{ rk: boolean; }

‐

activity.intent.createOrganizationIntent.rootAuthenticator.attestation.clientExtensionResults.credProps.rk

boolean

‐

activity.intent.createOrganizationIntent.rootAuthenticator.attestation.id

string

‐

activity.intent.createOrganizationIntent.rootAuthenticator.attestation.rawId

string

‐

activity.intent.createOrganizationIntent.rootAuthenticator.attestation.response

{ attestationObject: string; authenticatorAttachment?: null | "cross-platform" | "platform"; clientDataJson: string; transports?: ( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]; }

‐

activity.intent.createOrganizationIntent.rootAuthenticator.attestation.response.attestationObject

string

‐

activity.intent.createOrganizationIntent.rootAuthenticator.attestation.response.authenticatorAttachment?

null | "cross-platform" | "platform"

activity.intent.createOrganizationIntent.rootAuthenticator.attestation.response.clientDataJson

string

‐

activity.intent.createOrganizationIntent.rootAuthenticator.attestation.response.transports?

( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]

‐

activity.intent.createOrganizationIntent.rootAuthenticator.attestation.type

"public-key"

activity.intent.createOrganizationIntent.rootAuthenticator.authenticatorName

string

Description

Human-readable name for an Authenticator.

activity.intent.createOrganizationIntent.rootAuthenticator.challenge

string

Description

Challenge presented for authentication purposes.

activity.intent.createOrganizationIntent.rootAuthenticator.userId

string

Description

Unique identifier for a given User.

activity.intent.createOrganizationIntent.rootEmail

string

Description

The root user’s email address.

activity.intent.createOrganizationIntent.rootUserId?

string

Description

Unique identifier for the root user object.

activity.intent.createOrganizationIntentV2?

{ organizationName: string; rootAuthenticator: { attestation: { attestationObject: string; clientDataJson: string; credentialId: string; transports: ( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]; }; authenticatorName: string; challenge: string; }; rootEmail: string; rootUserId?: string; }

‐

activity.intent.createOrganizationIntentV2.organizationName

string

Description

Human-readable name for an Organization.

activity.intent.createOrganizationIntentV2.rootAuthenticator

{ attestation: { attestationObject: string; clientDataJson: string; credentialId: string; transports: ( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]; }; authenticatorName: string; challenge: string; }

Description

The root user’s Authenticator.

activity.intent.createOrganizationIntentV2.rootAuthenticator.attestation

{ attestationObject: string; clientDataJson: string; credentialId: string; transports: ( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]; }

Description

The attestation that proves custody of the authenticator and provides metadata about it.

activity.intent.createOrganizationIntentV2.rootAuthenticator.attestation.attestationObject

string

Description

A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses.

activity.intent.createOrganizationIntentV2.rootAuthenticator.attestation.clientDataJson

string

Description

A base64 url encoded payload containing metadata about the signing context and the challenge.

activity.intent.createOrganizationIntentV2.rootAuthenticator.attestation.credentialId

string

Description

The cbor encoded then base64 url encoded id of the credential.

activity.intent.createOrganizationIntentV2.rootAuthenticator.attestation.transports

( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]

Description

The type of authenticator transports.

activity.intent.createOrganizationIntentV2.rootAuthenticator.authenticatorName

string

Description

Human-readable name for an Authenticator.

activity.intent.createOrganizationIntentV2.rootAuthenticator.challenge

string

Description

Challenge presented for authentication purposes.

activity.intent.createOrganizationIntentV2.rootEmail

string

Description

The root user’s email address.

activity.intent.createOrganizationIntentV2.rootUserId?

string

Description

Unique identifier for the root user object.

activity.intent.createPoliciesIntent?

{ policies: object[]; }

‐

activity.intent.createPoliciesIntent.policies

object[]

Description

An array of policy intents to be created.

activity.intent.createPolicyIntent?

{ effect: "EFFECT_ALLOW" | "EFFECT_DENY"; notes?: string; policyName: string; selectors: object[]; }

‐

activity.intent.createPolicyIntent.effect

"EFFECT_ALLOW" | "EFFECT_DENY"

Description

The instruction to DENY or ALLOW a particular activity following policy selector(s).

activity.intent.createPolicyIntent.notes?

string

‐

activity.intent.createPolicyIntent.policyName

string

Description

Human-readable name for a Policy.

activity.intent.createPolicyIntent.selectors

object[]

Description

A list of simple functions each including a subject, target and boolean. See Policy Engine Language section for additional details.

activity.intent.createPolicyIntentV2?

{ effect: "EFFECT_ALLOW" | "EFFECT_DENY"; notes?: string; policyName: string; selectors: object[]; }

‐

activity.intent.createPolicyIntentV2.effect

"EFFECT_ALLOW" | "EFFECT_DENY"

Description

Whether to ALLOW or DENY requests that match the condition and consensus requirements.

activity.intent.createPolicyIntentV2.notes?

string

‐

activity.intent.createPolicyIntentV2.policyName

string

Description

Human-readable name for a Policy.

activity.intent.createPolicyIntentV2.selectors

object[]

Description

A list of simple functions each including a subject, target and boolean. See Policy Engine Language section for additional details.

activity.intent.createPolicyIntentV3?

{ condition?: string; consensus?: string; effect: "EFFECT_ALLOW" | "EFFECT_DENY"; notes?: string; policyName: string; }

‐

activity.intent.createPolicyIntentV3.condition?

string

Description

The condition expression that triggers the Effect

activity.intent.createPolicyIntentV3.consensus?

string

Description

The consensus expression that triggers the Effect

activity.intent.createPolicyIntentV3.effect

"EFFECT_ALLOW" | "EFFECT_DENY"

Description

The instruction to DENY or ALLOW an activity.

activity.intent.createPolicyIntentV3.notes?

string

‐

activity.intent.createPolicyIntentV3.policyName

string

Description

Human-readable name for a Policy.

activity.intent.createPrivateKeysIntent?

{ privateKeys: object[]; }

‐

activity.intent.createPrivateKeysIntent.privateKeys

object[]

Description

A list of Private Keys.

activity.intent.createPrivateKeysIntentV2?

{ privateKeys: object[]; }

‐

activity.intent.createPrivateKeysIntentV2.privateKeys

object[]

Description

A list of Private Keys.

activity.intent.createPrivateKeyTagIntent?

{ privateKeyIds: string[]; privateKeyTagName: string; }

‐

activity.intent.createPrivateKeyTagIntent.privateKeyIds

string[]

Description

A list of Private Key IDs.

activity.intent.createPrivateKeyTagIntent.privateKeyTagName

string

Description

Human-readable name for a Private Key Tag.

activity.intent.createReadOnlySessionIntent?

{ [key: string]: unknown; }

‐

activity.intent.createReadWriteSessionIntent?

{ apiKeyName?: string; email: string; expirationSeconds?: string; targetPublicKey: string; }

‐

activity.intent.createReadWriteSessionIntent.apiKeyName?

string

Description

Optional human-readable name for an API Key. If none provided, default to Read Write Session - <Timestamp>

activity.intent.createReadWriteSessionIntent.email

string

Description

Email of the user to create a read write session for

activity.intent.createReadWriteSessionIntent.expirationSeconds?

string

Description

Expiration window (in seconds) indicating how long the API key is valid for. If not provided, a default of 15 minutes will be used.

activity.intent.createReadWriteSessionIntent.targetPublicKey

string

Description

Client-side public key generated by the user, to which the read write session bundle (credentials) will be encrypted.

activity.intent.createReadWriteSessionIntentV2?

{ apiKeyName?: string; expirationSeconds?: string; invalidateExisting?: boolean; targetPublicKey: string; userId?: string; }

‐

activity.intent.createReadWriteSessionIntentV2.apiKeyName?

string

Description

Optional human-readable name for an API Key. If none provided, default to Read Write Session - <Timestamp>

activity.intent.createReadWriteSessionIntentV2.expirationSeconds?

string

Description

Expiration window (in seconds) indicating how long the API key is valid for. If not provided, a default of 15 minutes will be used.

activity.intent.createReadWriteSessionIntentV2.invalidateExisting?

boolean

Description

Invalidate all other previously generated ReadWriteSession API keys

activity.intent.createReadWriteSessionIntentV2.targetPublicKey

string

Description

Client-side public key generated by the user, to which the read write session bundle (credentials) will be encrypted.

activity.intent.createReadWriteSessionIntentV2.userId?

string

Description

Unique identifier for a given User.

activity.intent.createSmartContractInterfaceIntent?

{ label: string; notes?: string; smartContractAddress: string; smartContractInterface: string; type: | "SMART_CONTRACT_INTERFACE_TYPE_ETHEREUM" | "SMART_CONTRACT_INTERFACE_TYPE_SOLANA"; }

‐

activity.intent.createSmartContractInterfaceIntent.label

string

Description

Human-readable name for a Smart Contract Interface.

activity.intent.createSmartContractInterfaceIntent.notes?

string

Description

Notes for a Smart Contract Interface.

activity.intent.createSmartContractInterfaceIntent.smartContractAddress

string

Description

Corresponding contract address or program ID

activity.intent.createSmartContractInterfaceIntent.smartContractInterface

string

Description

ABI/IDL as a JSON string

activity.intent.createSmartContractInterfaceIntent.type

| "SMART_CONTRACT_INTERFACE_TYPE_ETHEREUM" | "SMART_CONTRACT_INTERFACE_TYPE_SOLANA"

‐

activity.intent.createSubOrganizationIntent?

{ name: string; rootAuthenticator: { attestation: { attestationObject: string; clientDataJson: string; credentialId: string; transports: ( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]; }; authenticatorName: string; challenge: string; }; }

‐

activity.intent.createSubOrganizationIntent.name

string

Description

Name for this sub-organization

activity.intent.createSubOrganizationIntent.rootAuthenticator

{ attestation: { attestationObject: string; clientDataJson: string; credentialId: string; transports: ( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]; }; authenticatorName: string; challenge: string; }

Description

Root User authenticator for this new sub-organization

activity.intent.createSubOrganizationIntent.rootAuthenticator.attestation

{ attestationObject: string; clientDataJson: string; credentialId: string; transports: ( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]; }

Description

The attestation that proves custody of the authenticator and provides metadata about it.

activity.intent.createSubOrganizationIntent.rootAuthenticator.attestation.attestationObject

string

Description

A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses.

activity.intent.createSubOrganizationIntent.rootAuthenticator.attestation.clientDataJson

string

Description

A base64 url encoded payload containing metadata about the signing context and the challenge.

activity.intent.createSubOrganizationIntent.rootAuthenticator.attestation.credentialId

string

Description

The cbor encoded then base64 url encoded id of the credential.

activity.intent.createSubOrganizationIntent.rootAuthenticator.attestation.transports

( | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID")[]

Description

The type of authenticator transports.

activity.intent.createSubOrganizationIntent.rootAuthenticator.authenticatorName

string

Description

Human-readable name for an Authenticator.

activity.intent.createSubOrganizationIntent.rootAuthenticator.challenge

string

Description

Challenge presented for authentication purposes.

activity.intent.createSubOrganizationIntentV2?

{ rootQuorumThreshold: number; rootUsers: object[]; subOrganizationName: string; }

‐

activity.intent.createSubOrganizationIntentV2.rootQuorumThreshold

number

Format: int32

Description

The threshold of unique approvals to reach root quorum. This value must be less than or equal to the number of root users

activity.intent.createSubOrganizationIntentV2.rootUsers

object[]

Description

Root users to create within this sub-organization

activity.intent.createSubOrganizationIntentV2.subOrganizationName

string

Description

Name for this sub-organization

activity.intent.createSubOrganizationIntentV3?

{ privateKeys: object[]; rootQuorumThreshold: number; rootUsers: object[]; subOrganizationName: string; }

‐

activity.intent.createSubOrganizationIntentV3.privateKeys

object[]

Description

A list of Private Keys.

activity.intent.createSubOrganizationIntentV3.rootQuorumThreshold

number

Format: int32

Description

The threshold of unique approvals to reach root quorum. This value must be less than or equal to the number of root users

activity.intent.createSubOrganizationIntentV3.rootUsers

object[]

Description

Root users to create within this sub-organization

activity.intent.createSubOrganizationIntentV3.subOrganizationName

string

Description

Name for this sub-organization

activity.intent.createSubOrganizationIntentV4?

{ disableEmailAuth?: boolean; disableEmailRecovery?: boolean; rootQuorumThreshold: number; rootUsers: object[]; subOrganizationName: string; wallet?: { accounts: object[]; mnemonicLength?: number; walletName: string; }; }

‐

activity.intent.createSubOrganizationIntentV4.disableEmailAuth?

boolean

Description

Disable email auth for the sub-organization

activity.intent.createSubOrganizationIntentV4.disableEmailRecovery?

boolean

Description

Disable email recovery for the sub-organization

activity.intent.createSubOrganizationIntentV4.rootQuorumThreshold

number

Format: int32

Description

The threshold of unique approvals to reach root quorum. This value must be less than or equal to the number of root users

activity.intent.createSubOrganizationIntentV4.rootUsers

object[]

Description

Root users to create within this sub-organization

activity.intent.createSubOrganizationIntentV4.subOrganizationName

string

Description

Name for this sub-organization

activity.intent.createSubOrganizationIntentV4.wallet?

{ accounts: object[]; mnemonicLength?: number; walletName: string; }

Description

The wallet to create for the sub-organization

activity.intent.createSubOrganizationIntentV4.wallet.accounts

object[]

Description

A list of wallet Accounts. This field, if not needed, should be an empty array in your request body.

activity.intent.createSubOrganizationIntentV4.wallet.mnemonicLength?

number

Format: int32

Description

Length of mnemonic to generate the Wallet seed. Defaults to 12. Accepted values: 12, 15, 18, 21, 24.

activity.intent.createSubOrganizationIntentV4.wallet.walletName

string

Description

Human-readable name for a Wallet.

activity.intent.createSubOrganizationIntentV5?

{ disableEmailAuth?: boolean; disableEmailRecovery?: boolean; rootQuorumThreshold: number; rootUsers: object[]; subOrganizationName: string; wallet?: { accounts: object[]; mnemonicLength?: number; walletName: string; }; }

‐

activity.intent.createSubOrganizationIntentV5.disableEmailAuth?

boolean

Description

Disable email auth for the sub-organization

activity.intent.createSubOrganizationIntentV5.disableEmailRecovery?

boolean

Description

Disable email recovery for the sub-organization

activity.intent.createSubOrganizationIntentV5.rootQuorumThreshold

number

Format: int32

Description

The threshold of unique approvals to reach root quorum. This value must be less than or equal to the number of root users

activity.intent.createSubOrganizationIntentV5.rootUsers

object[]

Description

Root users to create within this sub-organization

activity.intent.createSubOrganizationIntentV5.subOrganizationName

string

Description

Name for this sub-organization

activity.intent.createSubOrganizationIntentV5.wallet?

{ accounts: object[]; mnemonicLength?: number; walletName: string; }

Description

The wallet to create for the sub-organization

activity.intent.createSubOrganizationIntentV5.wallet.accounts

object[]

Description

A list of wallet Accounts. This field, if not needed, should be an empty array in your request body.

activity.intent.createSubOrganizationIntentV5.wallet.mnemonicLength?

number

Format: int32

Description

Length of mnemonic to generate the Wallet seed. Defaults to 12. Accepted values: 12, 15, 18, 21, 24.

activity.intent.createSubOrganizationIntentV5.wallet.walletName

string

Description

Human-readable name for a Wallet.

activity.intent.createSubOrganizationIntentV6?

{ disableEmailAuth?: boolean; disableEmailRecovery?: boolean; rootQuorumThreshold: number; rootUsers: object[]; subOrganizationName: string; wallet?: { accounts: object[]; mnemonicLength?: number; walletName: string; }; }

‐

activity.intent.createSubOrganizationIntentV6.disableEmailAuth?

boolean

Description

Disable email auth for the sub-organization

activity.intent.createSubOrganizationIntentV6.disableEmailRecovery?

boolean

Description

Disable email recovery for the sub-organization

activity.intent.createSubOrganizationIntentV6.rootQuorumThreshold

number

Format: int32

Description

The threshold of unique approvals to reach root quorum. This value must be less than or equal to the number of root users

activity.intent.createSubOrganizationIntentV6.rootUsers

object[]

Description

Root users to create within this sub-organization

activity.intent.createSubOrganizationIntentV6.subOrganizationName

string

Description

Name for this sub-organization

activity.intent.createSubOrganizationIntentV6.wallet?

{ accounts: object[]; mnemonicLength?: number; walletName: string; }

Description

The wallet to create for the sub-organization

activity.intent.createSubOrganizationIntentV6.wallet.accounts

object[]

Description

A list of wallet Accounts. This field, if not needed, should be an empty array in your request body.

activity.intent.createSubOrganizationIntentV6.wallet.mnemonicLength?

number

Format: int32

Description

Length of mnemonic to generate the Wallet seed. Defaults to 12. Accepted values: 12, 15, 18, 21, 24.

activity.intent.createSubOrganizationIntentV6.wallet.walletName

string

Description

Human-readable name for a Wallet.

activity.intent.createSubOrganizationIntentV7?

{ disableEmailAuth?: boolean; disableEmailRecovery?: boolean; disableOtpEmailAuth?: boolean; disableSmsAuth?: boolean; rootQuorumThreshold: number; rootUsers: object[]; subOrganizationName: string; verificationToken?: string; wallet?: { accounts: object[]; mnemonicLength?: number; walletName: string; }; }

‐

activity.intent.createSubOrganizationIntentV7.disableEmailAuth?

boolean

Description

Disable email auth for the sub-organization

activity.intent.createSubOrganizationIntentV7.disableEmailRecovery?

boolean

Description

Disable email recovery for the sub-organization

activity.intent.createSubOrganizationIntentV7.disableOtpEmailAuth?

boolean

Description

Disable OTP email auth for the sub-organization

activity.intent.createSubOrganizationIntentV7.disableSmsAuth?

boolean

Description

Disable OTP SMS auth for the sub-organization

activity.intent.createSubOrganizationIntentV7.rootQuorumThreshold

number

Format: int32

Description

The threshold of unique approvals to reach root quorum. This value must be less than or equal to the number of root users

activity.intent.createSubOrganizationIntentV7.rootUsers

object[]

Description

Root users to create within this sub-organization

activity.intent.createSubOrganizationIntentV7.subOrganizationName

string

Description

Name for this sub-organization

activity.intent.createSubOrganizationIntentV7.verificationToken?

string

Description

Signed JWT containing a unique id, expiry, verification type, contact

activity.intent.createSubOrganizationIntentV7.wallet?

{ accounts: object[]; mnemonicLength?: number; walletName: string; }

Description

The wallet to create for the sub-organization

activity.intent.createSubOrganizationIntentV7.wallet.accounts

object[]

Description

A list of wallet Accounts. This field, if not needed, should be an empty array in your request body.

activity.intent.createSubOrganizationIntentV7.wallet.mnemonicLength?

number

Format: int32

Description

Length of mnemonic to generate the Wallet seed. Defaults to 12. Accepted values: 12, 15, 18, 21, 24.

activity.intent.createSubOrganizationIntentV7.wallet.walletName

string

Description

Human-readable name for a Wallet.

activity.intent.createUsersIntent?

{ users: object[]; }

‐

activity.intent.createUsersIntent.users

object[]

Description

A list of Users.

activity.intent.createUsersIntentV2?

{ users: object[]; }

‐

activity.intent.createUsersIntentV2.users

object[]

Description

A list of Users.

activity.intent.createUsersIntentV3?

{ users: object[]; }

‐

activity.intent.createUsersIntentV3.users

object[]

Description

A list of Users.

activity.intent.createUserTagIntent?

{ userIds: string[]; userTagName: string; }

‐

activity.intent.createUserTagIntent.userIds

string[]

Description

A list of User IDs.

activity.intent.createUserTagIntent.userTagName

string

Description

Human-readable name for a User Tag.

activity.intent.createWalletAccountsIntent?

{ accounts: object[]; walletId: string; }

‐

activity.intent.createWalletAccountsIntent.accounts

object[]