An Organization is the highest level of hierarchy in Turnkey. It can contain many Users, Private Keys, and Policies managed by a Root Quorum. The Root Quorum consists of a set of Users with a consensus threshold. This consensus threshold must be reached by Quorum members in order for any actions to take place.
See Root Quorum for more information
Get Configs
Get quorum settings and features for an organization
Authorizations:
Request Body schema: application/json
organizationId required | string Unique identifier for a given Organization. |
Responses
Request samples
- Payload
{- "organizationId": "string"
}
Response samples
- 200
{- "configs": {
- "features": [
- {
- "name": "FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY",
- "value": "string"
}
], - "quorum": {
- "threshold": 0,
- "userIds": [
- "string"
]
}
}
}
Get Suborgs
Get all suborg IDs associated given a parent org ID and an optional filter.
Authorizations:
Request Body schema: application/json
organizationId required | string Unique identifier for the parent Organization. This is used to find sub-organizations within it. |
filterType | string Specifies the type of filter to apply, i.e 'CREDENTIAL_ID', 'NAME', 'USERNAME', 'EMAIL', 'OIDC_TOKEN' or 'PUBLIC_KEY' |
filterValue | string The value of the filter to apply for the specified type. For example, a specific email or name string. |
object (Pagination) |
Responses
Request samples
- Payload
{- "organizationId": "string",
- "filterType": "string",
- "filterValue": "string",
- "paginationOptions": {
- "limit": "string",
- "before": "string",
- "after": "string"
}
}
Response samples
- 200
{- "organizationIds": [
- "string"
]
}
Create Sub-Organization
Create a new Sub-Organization
Authorizations:
Request Body schema: application/json
type required | string Value: "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V7" |
timestampMs required | string Timestamp (in milliseconds) of the request, used to verify liveness of user requests. |
organizationId required | string Unique identifier for a given Organization. |
required | object (CreateSubOrganizationIntentV7) |
Responses
Request samples
- Payload
{- "type": "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V7",
- "timestampMs": "string",
- "organizationId": "string",
- "parameters": {
- "subOrganizationName": "string",
- "rootUsers": [
- {
- "userName": "string",
- "userEmail": "string",
- "userPhoneNumber": "string",
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "curveType": "API_KEY_CURVE_P256",
- "expirationSeconds": "string"
}
], - "authenticators": [
- {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
]
}
}
], - "oauthProviders": [
- {
- "providerName": "string",
- "oidcToken": "string"
}
]
}
], - "rootQuorumThreshold": 0,
- "wallet": {
- "walletName": "string",
- "accounts": [
- {
- "curve": "CURVE_SECP256K1",
- "pathFormat": "PATH_FORMAT_BIP32",
- "path": "string",
- "addressFormat": "ADDRESS_FORMAT_UNCOMPRESSED"
}
], - "mnemonicLength": 0
}, - "disableEmailRecovery": true,
- "disableEmailAuth": true,
- "disableSmsAuth": true,
- "disableOtpEmailAuth": true
}
}
Response samples
- 200
{- "activity": {
- "id": "string",
- "organizationId": "string",
- "status": "ACTIVITY_STATUS_CREATED",
- "type": "ACTIVITY_TYPE_CREATE_API_KEYS",
- "intent": {
- "createOrganizationIntent": {
- "organizationName": "string",
- "rootEmail": "string",
- "rootAuthenticator": {
- "authenticatorName": "string",
- "userId": "string",
- "attestation": {
- "id": "string",
- "type": "public-key",
- "rawId": "string",
- "authenticatorAttachment": "cross-platform",
- "response": {
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
], - "authenticatorAttachment": "cross-platform"
}, - "clientExtensionResults": {
- "appid": true,
- "appidExclude": true,
- "credProps": {
- "rk": true
}
}
}, - "challenge": "string"
}, - "rootUserId": "string"
}, - "createAuthenticatorsIntent": {
- "authenticators": [
- {
- "authenticatorName": "string",
- "userId": "string",
- "attestation": {
- "id": "string",
- "type": "public-key",
- "rawId": "string",
- "authenticatorAttachment": "cross-platform",
- "response": {
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
], - "authenticatorAttachment": "cross-platform"
}, - "clientExtensionResults": {
- "appid": true,
- "appidExclude": true,
- "credProps": {
- "rk": true
}
}
}, - "challenge": "string"
}
], - "userId": "string"
}, - "createUsersIntent": {
- "users": [
- {
- "userName": "string",
- "userEmail": "string",
- "accessType": "ACCESS_TYPE_WEB",
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "expirationSeconds": "string"
}
], - "authenticators": [
- {
- "authenticatorName": "string",
- "userId": "string",
- "attestation": {
- "id": "string",
- "type": "public-key",
- "rawId": "string",
- "authenticatorAttachment": "cross-platform",
- "response": {
- "clientDataJson": null,
- "attestationObject": null,
- "transports": [ ],
- "authenticatorAttachment": null
}, - "clientExtensionResults": {
- "appid": null,
- "appidExclude": null,
- "credProps": null
}
}, - "challenge": "string"
}
], - "userTags": [
- "string"
]
}
]
}, - "createPrivateKeysIntent": {
- "privateKeys": [
- {
- "privateKeyName": "string",
- "curve": "CURVE_SECP256K1",
- "privateKeyTags": [
- "string"
], - "addressFormats": [
- "ADDRESS_FORMAT_UNCOMPRESSED"
]
}
]
}, - "signRawPayloadIntent": {
- "privateKeyId": "string",
- "payload": "string",
- "encoding": "PAYLOAD_ENCODING_HEXADECIMAL",
- "hashFunction": "HASH_FUNCTION_NO_OP"
}, - "createInvitationsIntent": {
- "invitations": [
- {
- "receiverUserName": "string",
- "receiverUserEmail": "string",
- "receiverUserTags": [
- "string"
], - "accessType": "ACCESS_TYPE_WEB",
- "senderUserId": "string"
}
]
}, - "acceptInvitationIntent": {
- "invitationId": "string",
- "userId": "string",
- "authenticator": {
- "authenticatorName": "string",
- "userId": "string",
- "attestation": {
- "id": "string",
- "type": "public-key",
- "rawId": "string",
- "authenticatorAttachment": "cross-platform",
- "response": {
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
], - "authenticatorAttachment": "cross-platform"
}, - "clientExtensionResults": {
- "appid": true,
- "appidExclude": true,
- "credProps": {
- "rk": true
}
}
}, - "challenge": "string"
}
}, - "createPolicyIntent": {
- "policyName": "string",
- "selectors": [
- {
- "subject": "string",
- "operator": "OPERATOR_EQUAL",
- "target": "string"
}
], - "effect": "EFFECT_ALLOW",
- "notes": "string"
}, - "disablePrivateKeyIntent": {
- "privateKeyId": "string"
}, - "deleteUsersIntent": {
- "userIds": [
- "string"
]
}, - "deleteAuthenticatorsIntent": {
- "userId": "string",
- "authenticatorIds": [
- "string"
]
}, - "deleteInvitationIntent": {
- "invitationId": "string"
}, - "deleteOrganizationIntent": {
- "organizationId": "string"
}, - "deletePolicyIntent": {
- "policyId": "string"
}, - "createUserTagIntent": {
- "userTagName": "string",
- "userIds": [
- "string"
]
}, - "deleteUserTagsIntent": {
- "userTagIds": [
- "string"
]
}, - "signTransactionIntent": {
- "privateKeyId": "string",
- "unsignedTransaction": "string",
- "type": "TRANSACTION_TYPE_ETHEREUM"
}, - "createApiKeysIntent": {
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "expirationSeconds": "string"
}
], - "userId": "string"
}, - "deleteApiKeysIntent": {
- "userId": "string",
- "apiKeyIds": [
- "string"
]
}, - "approveActivityIntent": {
- "fingerprint": "string"
}, - "rejectActivityIntent": {
- "fingerprint": "string"
}, - "createPrivateKeyTagIntent": {
- "privateKeyTagName": "string",
- "privateKeyIds": [
- "string"
]
}, - "deletePrivateKeyTagsIntent": {
- "privateKeyTagIds": [
- "string"
]
}, - "createPolicyIntentV2": {
- "policyName": "string",
- "selectors": [
- {
- "subject": "string",
- "operator": "OPERATOR_EQUAL",
- "targets": [
- "string"
]
}
], - "effect": "EFFECT_ALLOW",
- "notes": "string"
}, - "setPaymentMethodIntent": {
- "number": "string",
- "cvv": "string",
- "expiryMonth": "string",
- "expiryYear": "string",
- "cardHolderEmail": "string",
- "cardHolderName": "string"
}, - "activateBillingTierIntent": {
- "productId": "string"
}, - "deletePaymentMethodIntent": {
- "paymentMethodId": "string"
}, - "createPolicyIntentV3": {
- "policyName": "string",
- "effect": "EFFECT_ALLOW",
- "condition": "string",
- "consensus": "string",
- "notes": "string"
}, - "createApiOnlyUsersIntent": {
- "apiOnlyUsers": [
- {
- "userName": "string",
- "userEmail": "string",
- "userTags": [
- "string"
], - "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "expirationSeconds": "string"
}
]
}
]
}, - "updateRootQuorumIntent": {
- "threshold": 0,
- "userIds": [
- "string"
]
}, - "updateUserTagIntent": {
- "userTagId": "string",
- "newUserTagName": "string",
- "addUserIds": [
- "string"
], - "removeUserIds": [
- "string"
]
}, - "updatePrivateKeyTagIntent": {
- "privateKeyTagId": "string",
- "newPrivateKeyTagName": "string",
- "addPrivateKeyIds": [
- "string"
], - "removePrivateKeyIds": [
- "string"
]
}, - "createAuthenticatorsIntentV2": {
- "authenticators": [
- {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
]
}
}
], - "userId": "string"
}, - "acceptInvitationIntentV2": {
- "invitationId": "string",
- "userId": "string",
- "authenticator": {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
]
}
}
}, - "createOrganizationIntentV2": {
- "organizationName": "string",
- "rootEmail": "string",
- "rootAuthenticator": {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
]
}
}, - "rootUserId": "string"
}, - "createUsersIntentV2": {
- "users": [
- {
- "userName": "string",
- "userEmail": "string",
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "expirationSeconds": "string"
}
], - "authenticators": [
- {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- null
]
}
}
], - "userTags": [
- "string"
]
}
]
}, - "createSubOrganizationIntent": {
- "name": "string",
- "rootAuthenticator": {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
]
}
}
}, - "createSubOrganizationIntentV2": {
- "subOrganizationName": "string",
- "rootUsers": [
- {
- "userName": "string",
- "userEmail": "string",
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "expirationSeconds": "string"
}
], - "authenticators": [
- {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- null
]
}
}
]
}
], - "rootQuorumThreshold": 0
}, - "updateAllowedOriginsIntent": {
- "allowedOrigins": [
- "string"
]
}, - "createPrivateKeysIntentV2": {
- "privateKeys": [
- {
- "privateKeyName": "string",
- "curve": "CURVE_SECP256K1",
- "privateKeyTags": [
- "string"
], - "addressFormats": [
- "ADDRESS_FORMAT_UNCOMPRESSED"
]
}
]
}, - "updateUserIntent": {
- "userId": "string",
- "userName": "string",
- "userEmail": "string",
- "userTagIds": [
- "string"
], - "userPhoneNumber": "string"
}, - "updatePolicyIntent": {
- "policyId": "string",
- "policyName": "string",
- "policyEffect": "EFFECT_ALLOW",
- "policyCondition": "string",
- "policyConsensus": "string",
- "policyNotes": "string"
}, - "setPaymentMethodIntentV2": {
- "paymentMethodId": "string",
- "cardHolderEmail": "string",
- "cardHolderName": "string"
}, - "createSubOrganizationIntentV3": {
- "subOrganizationName": "string",
- "rootUsers": [
- {
- "userName": "string",
- "userEmail": "string",
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "expirationSeconds": "string"
}
], - "authenticators": [
- {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- null
]
}
}
]
}
], - "rootQuorumThreshold": 0,
- "privateKeys": [
- {
- "privateKeyName": "string",
- "curve": "CURVE_SECP256K1",
- "privateKeyTags": [
- "string"
], - "addressFormats": [
- "ADDRESS_FORMAT_UNCOMPRESSED"
]
}
]
}, - "createWalletIntent": {
- "walletName": "string",
- "accounts": [
- {
- "curve": "CURVE_SECP256K1",
- "pathFormat": "PATH_FORMAT_BIP32",
- "path": "string",
- "addressFormat": "ADDRESS_FORMAT_UNCOMPRESSED"
}
], - "mnemonicLength": 0
}, - "createWalletAccountsIntent": {
- "walletId": "string",
- "accounts": [
- {
- "curve": "CURVE_SECP256K1",
- "pathFormat": "PATH_FORMAT_BIP32",
- "path": "string",
- "addressFormat": "ADDRESS_FORMAT_UNCOMPRESSED"
}
]
}, - "initUserEmailRecoveryIntent": {
- "email": "string",
- "targetPublicKey": "string",
- "expirationSeconds": "string",
- "emailCustomization": {
- "appName": "string",
- "logoUrl": "string",
- "magicLinkTemplate": "string",
- "templateVariables": "string",
- "templateId": "string"
}
}, - "recoverUserIntent": {
- "authenticator": {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
]
}
}, - "userId": "string"
}, - "setOrganizationFeatureIntent": {
- "name": "FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY",
- "value": "string"
}, - "removeOrganizationFeatureIntent": {
- "name": "FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY"
}, - "signRawPayloadIntentV2": {
- "signWith": "string",
- "payload": "string",
- "encoding": "PAYLOAD_ENCODING_HEXADECIMAL",
- "hashFunction": "HASH_FUNCTION_NO_OP"
}, - "signTransactionIntentV2": {
- "signWith": "string",
- "unsignedTransaction": "string",
- "type": "TRANSACTION_TYPE_ETHEREUM"
}, - "exportPrivateKeyIntent": {
- "privateKeyId": "string",
- "targetPublicKey": "string"
}, - "exportWalletIntent": {
- "walletId": "string",
- "targetPublicKey": "string",
- "language": "MNEMONIC_LANGUAGE_ENGLISH"
}, - "createSubOrganizationIntentV4": {
- "subOrganizationName": "string",
- "rootUsers": [
- {
- "userName": "string",
- "userEmail": "string",
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "expirationSeconds": "string"
}
], - "authenticators": [
- {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- null
]
}
}
]
}
], - "rootQuorumThreshold": 0,
- "wallet": {
- "walletName": "string",
- "accounts": [
- {
- "curve": "CURVE_SECP256K1",
- "pathFormat": "PATH_FORMAT_BIP32",
- "path": "string",
- "addressFormat": "ADDRESS_FORMAT_UNCOMPRESSED"
}
], - "mnemonicLength": 0
}, - "disableEmailRecovery": true,
- "disableEmailAuth": true
}, - "emailAuthIntent": {
- "email": "string",
- "targetPublicKey": "string",
- "apiKeyName": "string",
- "expirationSeconds": "string",
- "emailCustomization": {
- "appName": "string",
- "logoUrl": "string",
- "magicLinkTemplate": "string",
- "templateVariables": "string",
- "templateId": "string"
}, - "invalidateExisting": true
}, - "exportWalletAccountIntent": {
- "address": "string",
- "targetPublicKey": "string"
}, - "initImportWalletIntent": {
- "userId": "string"
}, - "importWalletIntent": {
- "userId": "string",
- "walletName": "string",
- "encryptedBundle": "string",
- "accounts": [
- {
- "curve": "CURVE_SECP256K1",
- "pathFormat": "PATH_FORMAT_BIP32",
- "path": "string",
- "addressFormat": "ADDRESS_FORMAT_UNCOMPRESSED"
}
]
}, - "initImportPrivateKeyIntent": {
- "userId": "string"
}, - "importPrivateKeyIntent": {
- "userId": "string",
- "privateKeyName": "string",
- "encryptedBundle": "string",
- "curve": "CURVE_SECP256K1",
- "addressFormats": [
- "ADDRESS_FORMAT_UNCOMPRESSED"
]
}, - "createPoliciesIntent": {
- "policies": [
- {
- "policyName": "string",
- "effect": "EFFECT_ALLOW",
- "condition": "string",
- "consensus": "string",
- "notes": "string"
}
]
}, - "signRawPayloadsIntent": {
- "signWith": "string",
- "payloads": [
- "string"
], - "encoding": "PAYLOAD_ENCODING_HEXADECIMAL",
- "hashFunction": "HASH_FUNCTION_NO_OP"
}, - "createReadOnlySessionIntent": { },
- "createOauthProvidersIntent": {
- "userId": "string",
- "oauthProviders": [
- {
- "providerName": "string",
- "oidcToken": "string"
}
]
}, - "deleteOauthProvidersIntent": {
- "userId": "string",
- "providerIds": [
- "string"
]
}, - "createSubOrganizationIntentV5": {
- "subOrganizationName": "string",
- "rootUsers": [
- {
- "userName": "string",
- "userEmail": "string",
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "expirationSeconds": "string"
}
], - "authenticators": [
- {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- null
]
}
}
], - "oauthProviders": [
- {
- "providerName": "string",
- "oidcToken": "string"
}
]
}
], - "rootQuorumThreshold": 0,
- "wallet": {
- "walletName": "string",
- "accounts": [
- {
- "curve": "CURVE_SECP256K1",
- "pathFormat": "PATH_FORMAT_BIP32",
- "path": "string",
- "addressFormat": "ADDRESS_FORMAT_UNCOMPRESSED"
}
], - "mnemonicLength": 0
}, - "disableEmailRecovery": true,
- "disableEmailAuth": true
}, - "oauthIntent": {
- "oidcToken": "string",
- "targetPublicKey": "string",
- "apiKeyName": "string",
- "expirationSeconds": "string"
}, - "createApiKeysIntentV2": {
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "curveType": "API_KEY_CURVE_P256",
- "expirationSeconds": "string"
}
], - "userId": "string"
}, - "createReadWriteSessionIntent": {
- "targetPublicKey": "string",
- "email": "string",
- "apiKeyName": "string",
- "expirationSeconds": "string"
}, - "emailAuthIntentV2": {
- "email": "string",
- "targetPublicKey": "string",
- "apiKeyName": "string",
- "expirationSeconds": "string",
- "emailCustomization": {
- "appName": "string",
- "logoUrl": "string",
- "magicLinkTemplate": "string",
- "templateVariables": "string",
- "templateId": "string"
}, - "invalidateExisting": true
}, - "createSubOrganizationIntentV6": {
- "subOrganizationName": "string",
- "rootUsers": [
- {
- "userName": "string",
- "userEmail": "string",
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "curveType": "API_KEY_CURVE_P256",
- "expirationSeconds": "string"
}
], - "authenticators": [
- {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- null
]
}
}
], - "oauthProviders": [
- {
- "providerName": "string",
- "oidcToken": "string"
}
]
}
], - "rootQuorumThreshold": 0,
- "wallet": {
- "walletName": "string",
- "accounts": [
- {
- "curve": "CURVE_SECP256K1",
- "pathFormat": "PATH_FORMAT_BIP32",
- "path": "string",
- "addressFormat": "ADDRESS_FORMAT_UNCOMPRESSED"
}
], - "mnemonicLength": 0
}, - "disableEmailRecovery": true,
- "disableEmailAuth": true
}, - "deletePrivateKeysIntent": {
- "privateKeyIds": [
- "string"
], - "deleteWithoutExport": true
}, - "deleteWalletsIntent": {
- "walletIds": [
- "string"
], - "deleteWithoutExport": true
}, - "createReadWriteSessionIntentV2": {
- "targetPublicKey": "string",
- "userId": "string",
- "apiKeyName": "string",
- "expirationSeconds": "string"
}, - "deleteSubOrganizationIntent": {
- "deleteWithoutExport": true
}, - "initOtpAuthIntent": {
- "otpType": "string",
- "contact": "string",
- "emailCustomization": {
- "appName": "string",
- "logoUrl": "string",
- "magicLinkTemplate": "string",
- "templateVariables": "string",
- "templateId": "string"
}
}, - "otpAuthIntent": {
- "otpId": "string",
- "otpCode": "string",
- "targetPublicKey": "string",
- "apiKeyName": "string",
- "expirationSeconds": "string",
- "invalidateExisting": true
}, - "createSubOrganizationIntentV7": {
- "subOrganizationName": "string",
- "rootUsers": [
- {
- "userName": "string",
- "userEmail": "string",
- "userPhoneNumber": "string",
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "curveType": "API_KEY_CURVE_P256",
- "expirationSeconds": "string"
}
], - "authenticators": [
- {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- null
]
}
}
], - "oauthProviders": [
- {
- "providerName": "string",
- "oidcToken": "string"
}
]
}
], - "rootQuorumThreshold": 0,
- "wallet": {
- "walletName": "string",
- "accounts": [
- {
- "curve": "CURVE_SECP256K1",
- "pathFormat": "PATH_FORMAT_BIP32",
- "path": "string",
- "addressFormat": "ADDRESS_FORMAT_UNCOMPRESSED"
}
], - "mnemonicLength": 0
}, - "disableEmailRecovery": true,
- "disableEmailAuth": true,
- "disableSmsAuth": true,
- "disableOtpEmailAuth": true
}
}, - "result": {
- "createOrganizationResult": {
- "organizationId": "string"
}, - "createAuthenticatorsResult": {
- "authenticatorIds": [
- "string"
]
}, - "createUsersResult": {
- "userIds": [
- "string"
]
}, - "createPrivateKeysResult": {
- "privateKeyIds": [
- "string"
]
}, - "createInvitationsResult": {
- "invitationIds": [
- "string"
]
}, - "acceptInvitationResult": {
- "invitationId": "string",
- "userId": "string"
}, - "signRawPayloadResult": {
- "r": "string",
- "s": "string",
- "v": "string"
}, - "createPolicyResult": {
- "policyId": "string"
}, - "disablePrivateKeyResult": {
- "privateKeyId": "string"
}, - "deleteUsersResult": {
- "userIds": [
- "string"
]
}, - "deleteAuthenticatorsResult": {
- "authenticatorIds": [
- "string"
]
}, - "deleteInvitationResult": {
- "invitationId": "string"
}, - "deleteOrganizationResult": {
- "organizationId": "string"
}, - "deletePolicyResult": {
- "policyId": "string"
}, - "createUserTagResult": {
- "userTagId": "string",
- "userIds": [
- "string"
]
}, - "deleteUserTagsResult": {
- "userTagIds": [
- "string"
], - "userIds": [
- "string"
]
}, - "signTransactionResult": {
- "signedTransaction": "string"
}, - "deleteApiKeysResult": {
- "apiKeyIds": [
- "string"
]
}, - "createApiKeysResult": {
- "apiKeyIds": [
- "string"
]
}, - "createPrivateKeyTagResult": {
- "privateKeyTagId": "string",
- "privateKeyIds": [
- "string"
]
}, - "deletePrivateKeyTagsResult": {
- "privateKeyTagIds": [
- "string"
], - "privateKeyIds": [
- "string"
]
}, - "setPaymentMethodResult": {
- "lastFour": "string",
- "cardHolderName": "string",
- "cardHolderEmail": "string"
}, - "activateBillingTierResult": {
- "productId": "string"
}, - "deletePaymentMethodResult": {
- "paymentMethodId": "string"
}, - "createApiOnlyUsersResult": {
- "userIds": [
- "string"
]
}, - "updateRootQuorumResult": { },
- "updateUserTagResult": {
- "userTagId": "string"
}, - "updatePrivateKeyTagResult": {
- "privateKeyTagId": "string"
}, - "createSubOrganizationResult": {
- "subOrganizationId": "string",
- "rootUserIds": [
- "string"
]
}, - "updateAllowedOriginsResult": { },
- "createPrivateKeysResultV2": {
- "privateKeys": [
- {
- "privateKeyId": "string",
- "addresses": [
- {
- "format": "ADDRESS_FORMAT_UNCOMPRESSED",
- "address": "string"
}
]
}
]
}, - "updateUserResult": {
- "userId": "string"
}, - "updatePolicyResult": {
- "policyId": "string"
}, - "createSubOrganizationResultV3": {
- "subOrganizationId": "string",
- "privateKeys": [
- {
- "privateKeyId": "string",
- "addresses": [
- {
- "format": "ADDRESS_FORMAT_UNCOMPRESSED",
- "address": "string"
}
]
}
], - "rootUserIds": [
- "string"
]
}, - "createWalletResult": {
- "walletId": "string",
- "addresses": [
- "string"
]
}, - "createWalletAccountsResult": {
- "addresses": [
- "string"
]
}, - "initUserEmailRecoveryResult": {
- "userId": "string"
}, - "recoverUserResult": {
- "authenticatorId": [
- "string"
]
}, - "setOrganizationFeatureResult": {
- "features": [
- {
- "name": "FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY",
- "value": "string"
}
]
}, - "removeOrganizationFeatureResult": {
- "features": [
- {
- "name": "FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY",
- "value": "string"
}
]
}, - "exportPrivateKeyResult": {
- "privateKeyId": "string",
- "exportBundle": "string"
}, - "exportWalletResult": {
- "walletId": "string",
- "exportBundle": "string"
}, - "createSubOrganizationResultV4": {
- "subOrganizationId": "string",
- "wallet": {
- "walletId": "string",
- "addresses": [
- "string"
]
}, - "rootUserIds": [
- "string"
]
}, - "emailAuthResult": {
- "userId": "string",
- "apiKeyId": "string"
}, - "exportWalletAccountResult": {
- "address": "string",
- "exportBundle": "string"
}, - "initImportWalletResult": {
- "importBundle": "string"
}, - "importWalletResult": {
- "walletId": "string",
- "addresses": [
- "string"
]
}, - "initImportPrivateKeyResult": {
- "importBundle": "string"
}, - "importPrivateKeyResult": {
- "privateKeyId": "string",
- "addresses": [
- {
- "format": "ADDRESS_FORMAT_UNCOMPRESSED",
- "address": "string"
}
]
}, - "createPoliciesResult": {
- "policyIds": [
- "string"
]
}, - "signRawPayloadsResult": {
- "signatures": [
- {
- "r": "string",
- "s": "string",
- "v": "string"
}
]
}, - "createReadOnlySessionResult": {
- "organizationId": "string",
- "organizationName": "string",
- "userId": "string",
- "username": "string",
- "session": "string",
- "sessionExpiry": "string"
}, - "createOauthProvidersResult": {
- "providerIds": [
- "string"
]
}, - "deleteOauthProvidersResult": {
- "providerIds": [
- "string"
]
}, - "createSubOrganizationResultV5": {
- "subOrganizationId": "string",
- "wallet": {
- "walletId": "string",
- "addresses": [
- "string"
]
}, - "rootUserIds": [
- "string"
]
}, - "oauthResult": {
- "userId": "string",
- "apiKeyId": "string",
- "credentialBundle": "string"
}, - "createReadWriteSessionResult": {
- "organizationId": "string",
- "organizationName": "string",
- "userId": "string",
- "username": "string",
- "apiKeyId": "string",
- "credentialBundle": "string"
}, - "createSubOrganizationResultV6": {
- "subOrganizationId": "string",
- "wallet": {
- "walletId": "string",
- "addresses": [
- "string"
]
}, - "rootUserIds": [
- "string"
]
}, - "deletePrivateKeysResult": {
- "privateKeyIds": [
- "string"
]
}, - "deleteWalletsResult": {
- "walletIds": [
- "string"
]
}, - "createReadWriteSessionResultV2": {
- "organizationId": "string",
- "organizationName": "string",
- "userId": "string",
- "username": "string",
- "apiKeyId": "string",
- "credentialBundle": "string"
}, - "deleteSubOrganizationResult": {
- "subOrganizationUuid": "string"
}, - "initOtpAuthResult": {
- "otpId": "string"
}, - "otpAuthResult": {
- "userId": "string",
- "apiKeyId": "string",
- "credentialBundle": "string"
}, - "createSubOrganizationResultV7": {
- "subOrganizationId": "string",
- "wallet": {
- "walletId": "string",
- "addresses": [
- "string"
]
}, - "rootUserIds": [
- "string"
]
}
}, - "votes": [
- {
- "id": "string",
- "userId": "string",
- "user": {
- "userId": "string",
- "userName": "string",
- "userEmail": "string",
- "userPhoneNumber": "string",
- "authenticators": [
- {
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
], - "attestationType": "string",
- "aaguid": "string",
- "credentialId": "string",
- "model": "string",
- "credential": {
- "publicKey": "string",
- "type": "CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR"
}, - "authenticatorId": "string",
- "authenticatorName": "string",
- "createdAt": {
- "seconds": "string",
- "nanos": "string"
}, - "updatedAt": {
- "seconds": "string",
- "nanos": "string"
}
}
], - "apiKeys": [
- {
- "credential": {
- "publicKey": "string",
- "type": "CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR"
}, - "apiKeyId": "string",
- "apiKeyName": "string",
- "createdAt": {
- "seconds": "string",
- "nanos": "string"
}, - "updatedAt": {
- "seconds": "string",
- "nanos": "string"
}, - "expirationSeconds": "string"
}
], - "userTags": [
- "string"
], - "oauthProviders": [
- {
- "providerId": "string",
- "providerName": "string",
- "issuer": "string",
- "audience": "string",
- "subject": "string",
- "createdAt": {
- "seconds": "string",
- "nanos": "string"
}, - "updatedAt": {
- "seconds": "string",
- "nanos": "string"
}
}
], - "createdAt": {
- "seconds": "string",
- "nanos": "string"
}, - "updatedAt": {
- "seconds": "string",
- "nanos": "string"
}
}, - "activityId": "string",
- "selection": "VOTE_SELECTION_APPROVED",
- "message": "string",
- "publicKey": "string",
- "signature": "string",
- "scheme": "string",
- "createdAt": {
- "seconds": "string",
- "nanos": "string"
}
}
], - "fingerprint": "string",
- "canApprove": true,
- "canReject": true,
- "createdAt": {
- "seconds": "string",
- "nanos": "string"
}, - "updatedAt": {
- "seconds": "string",
- "nanos": "string"
}, - "failure": {
- "code": 0,
- "message": "string",
- "details": [
- {
- "@type": "string",
- "property1": null,
- "property2": null
}
]
}
}
}
Delete Sub Organization
Deletes a sub organization
Authorizations:
Request Body schema: application/json
type required | string Value: "ACTIVITY_TYPE_DELETE_SUB_ORGANIZATION" |
timestampMs required | string Timestamp (in milliseconds) of the request, used to verify liveness of user requests. |
organizationId required | string Unique identifier for a given Organization. |
required | object (DeleteSubOrganizationIntent) |
Responses
Request samples
- Payload
{- "type": "ACTIVITY_TYPE_DELETE_SUB_ORGANIZATION",
- "timestampMs": "string",
- "organizationId": "string",
- "parameters": {
- "deleteWithoutExport": true
}
}
Response samples
- 200
{- "activity": {
- "id": "string",
- "organizationId": "string",
- "status": "ACTIVITY_STATUS_CREATED",
- "type": "ACTIVITY_TYPE_CREATE_API_KEYS",
- "intent": {
- "createOrganizationIntent": {
- "organizationName": "string",
- "rootEmail": "string",
- "rootAuthenticator": {
- "authenticatorName": "string",
- "userId": "string",
- "attestation": {
- "id": "string",
- "type": "public-key",
- "rawId": "string",
- "authenticatorAttachment": "cross-platform",
- "response": {
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
], - "authenticatorAttachment": "cross-platform"
}, - "clientExtensionResults": {
- "appid": true,
- "appidExclude": true,
- "credProps": {
- "rk": true
}
}
}, - "challenge": "string"
}, - "rootUserId": "string"
}, - "createAuthenticatorsIntent": {
- "authenticators": [
- {
- "authenticatorName": "string",
- "userId": "string",
- "attestation": {
- "id": "string",
- "type": "public-key",
- "rawId": "string",
- "authenticatorAttachment": "cross-platform",
- "response": {
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
], - "authenticatorAttachment": "cross-platform"
}, - "clientExtensionResults": {
- "appid": true,
- "appidExclude": true,
- "credProps": {
- "rk": true
}
}
}, - "challenge": "string"
}
], - "userId": "string"
}, - "createUsersIntent": {
- "users": [
- {
- "userName": "string",
- "userEmail": "string",
- "accessType": "ACCESS_TYPE_WEB",
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "expirationSeconds": "string"
}
], - "authenticators": [
- {
- "authenticatorName": "string",
- "userId": "string",
- "attestation": {
- "id": "string",
- "type": "public-key",
- "rawId": "string",
- "authenticatorAttachment": "cross-platform",
- "response": {
- "clientDataJson": null,
- "attestationObject": null,
- "transports": [ ],
- "authenticatorAttachment": null
}, - "clientExtensionResults": {
- "appid": null,
- "appidExclude": null,
- "credProps": null
}
}, - "challenge": "string"
}
], - "userTags": [
- "string"
]
}
]
}, - "createPrivateKeysIntent": {
- "privateKeys": [
- {
- "privateKeyName": "string",
- "curve": "CURVE_SECP256K1",
- "privateKeyTags": [
- "string"
], - "addressFormats": [
- "ADDRESS_FORMAT_UNCOMPRESSED"
]
}
]
}, - "signRawPayloadIntent": {
- "privateKeyId": "string",
- "payload": "string",
- "encoding": "PAYLOAD_ENCODING_HEXADECIMAL",
- "hashFunction": "HASH_FUNCTION_NO_OP"
}, - "createInvitationsIntent": {
- "invitations": [
- {
- "receiverUserName": "string",
- "receiverUserEmail": "string",
- "receiverUserTags": [
- "string"
], - "accessType": "ACCESS_TYPE_WEB",
- "senderUserId": "string"
}
]
}, - "acceptInvitationIntent": {
- "invitationId": "string",
- "userId": "string",
- "authenticator": {
- "authenticatorName": "string",
- "userId": "string",
- "attestation": {
- "id": "string",
- "type": "public-key",
- "rawId": "string",
- "authenticatorAttachment": "cross-platform",
- "response": {
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
], - "authenticatorAttachment": "cross-platform"
}, - "clientExtensionResults": {
- "appid": true,
- "appidExclude": true,
- "credProps": {
- "rk": true
}
}
}, - "challenge": "string"
}
}, - "createPolicyIntent": {
- "policyName": "string",
- "selectors": [
- {
- "subject": "string",
- "operator": "OPERATOR_EQUAL",
- "target": "string"
}
], - "effect": "EFFECT_ALLOW",
- "notes": "string"
}, - "disablePrivateKeyIntent": {
- "privateKeyId": "string"
}, - "deleteUsersIntent": {
- "userIds": [
- "string"
]
}, - "deleteAuthenticatorsIntent": {
- "userId": "string",
- "authenticatorIds": [
- "string"
]
}, - "deleteInvitationIntent": {
- "invitationId": "string"
}, - "deleteOrganizationIntent": {
- "organizationId": "string"
}, - "deletePolicyIntent": {
- "policyId": "string"
}, - "createUserTagIntent": {
- "userTagName": "string",
- "userIds": [
- "string"
]
}, - "deleteUserTagsIntent": {
- "userTagIds": [
- "string"
]
}, - "signTransactionIntent": {
- "privateKeyId": "string",
- "unsignedTransaction": "string",
- "type": "TRANSACTION_TYPE_ETHEREUM"
}, - "createApiKeysIntent": {
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "expirationSeconds": "string"
}
], - "userId": "string"
}, - "deleteApiKeysIntent": {
- "userId": "string",
- "apiKeyIds": [
- "string"
]
}, - "approveActivityIntent": {
- "fingerprint": "string"
}, - "rejectActivityIntent": {
- "fingerprint": "string"
}, - "createPrivateKeyTagIntent": {
- "privateKeyTagName": "string",
- "privateKeyIds": [
- "string"
]
}, - "deletePrivateKeyTagsIntent": {
- "privateKeyTagIds": [
- "string"
]
}, - "createPolicyIntentV2": {
- "policyName": "string",
- "selectors": [
- {
- "subject": "string",
- "operator": "OPERATOR_EQUAL",
- "targets": [
- "string"
]
}
], - "effect": "EFFECT_ALLOW",
- "notes": "string"
}, - "setPaymentMethodIntent": {
- "number": "string",
- "cvv": "string",
- "expiryMonth": "string",
- "expiryYear": "string",
- "cardHolderEmail": "string",
- "cardHolderName": "string"
}, - "activateBillingTierIntent": {
- "productId": "string"
}, - "deletePaymentMethodIntent": {
- "paymentMethodId": "string"
}, - "createPolicyIntentV3": {
- "policyName": "string",
- "effect": "EFFECT_ALLOW",
- "condition": "string",
- "consensus": "string",
- "notes": "string"
}, - "createApiOnlyUsersIntent": {
- "apiOnlyUsers": [
- {
- "userName": "string",
- "userEmail": "string",
- "userTags": [
- "string"
], - "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "expirationSeconds": "string"
}
]
}
]
}, - "updateRootQuorumIntent": {
- "threshold": 0,
- "userIds": [
- "string"
]
}, - "updateUserTagIntent": {
- "userTagId": "string",
- "newUserTagName": "string",
- "addUserIds": [
- "string"
], - "removeUserIds": [
- "string"
]
}, - "updatePrivateKeyTagIntent": {
- "privateKeyTagId": "string",
- "newPrivateKeyTagName": "string",
- "addPrivateKeyIds": [
- "string"
], - "removePrivateKeyIds": [
- "string"
]
}, - "createAuthenticatorsIntentV2": {
- "authenticators": [
- {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
]
}
}
], - "userId": "string"
}, - "acceptInvitationIntentV2": {
- "invitationId": "string",
- "userId": "string",
- "authenticator": {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
]
}
}
}, - "createOrganizationIntentV2": {
- "organizationName": "string",
- "rootEmail": "string",
- "rootAuthenticator": {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
]
}
}, - "rootUserId": "string"
}, - "createUsersIntentV2": {
- "users": [
- {
- "userName": "string",
- "userEmail": "string",
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "expirationSeconds": "string"
}
], - "authenticators": [
- {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- null
]
}
}
], - "userTags": [
- "string"
]
}
]
}, - "createSubOrganizationIntent": {
- "name": "string",
- "rootAuthenticator": {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
]
}
}
}, - "createSubOrganizationIntentV2": {
- "subOrganizationName": "string",
- "rootUsers": [
- {
- "userName": "string",
- "userEmail": "string",
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "expirationSeconds": "string"
}
], - "authenticators": [
- {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- null
]
}
}
]
}
], - "rootQuorumThreshold": 0
}, - "updateAllowedOriginsIntent": {
- "allowedOrigins": [
- "string"
]
}, - "createPrivateKeysIntentV2": {
- "privateKeys": [
- {
- "privateKeyName": "string",
- "curve": "CURVE_SECP256K1",
- "privateKeyTags": [
- "string"
], - "addressFormats": [
- "ADDRESS_FORMAT_UNCOMPRESSED"
]
}
]
}, - "updateUserIntent": {
- "userId": "string",
- "userName": "string",
- "userEmail": "string",
- "userTagIds": [
- "string"
], - "userPhoneNumber": "string"
}, - "updatePolicyIntent": {
- "policyId": "string",
- "policyName": "string",
- "policyEffect": "EFFECT_ALLOW",
- "policyCondition": "string",
- "policyConsensus": "string",
- "policyNotes": "string"
}, - "setPaymentMethodIntentV2": {
- "paymentMethodId": "string",
- "cardHolderEmail": "string",
- "cardHolderName": "string"
}, - "createSubOrganizationIntentV3": {
- "subOrganizationName": "string",
- "rootUsers": [
- {
- "userName": "string",
- "userEmail": "string",
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "expirationSeconds": "string"
}
], - "authenticators": [
- {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- null
]
}
}
]
}
], - "rootQuorumThreshold": 0,
- "privateKeys": [
- {
- "privateKeyName": "string",
- "curve": "CURVE_SECP256K1",
- "privateKeyTags": [
- "string"
], - "addressFormats": [
- "ADDRESS_FORMAT_UNCOMPRESSED"
]
}
]
}, - "createWalletIntent": {
- "walletName": "string",
- "accounts": [
- {
- "curve": "CURVE_SECP256K1",
- "pathFormat": "PATH_FORMAT_BIP32",
- "path": "string",
- "addressFormat": "ADDRESS_FORMAT_UNCOMPRESSED"
}
], - "mnemonicLength": 0
}, - "createWalletAccountsIntent": {
- "walletId": "string",
- "accounts": [
- {
- "curve": "CURVE_SECP256K1",
- "pathFormat": "PATH_FORMAT_BIP32",
- "path": "string",
- "addressFormat": "ADDRESS_FORMAT_UNCOMPRESSED"
}
]
}, - "initUserEmailRecoveryIntent": {
- "email": "string",
- "targetPublicKey": "string",
- "expirationSeconds": "string",
- "emailCustomization": {
- "appName": "string",
- "logoUrl": "string",
- "magicLinkTemplate": "string",
- "templateVariables": "string",
- "templateId": "string"
}
}, - "recoverUserIntent": {
- "authenticator": {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
]
}
}, - "userId": "string"
}, - "setOrganizationFeatureIntent": {
- "name": "FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY",
- "value": "string"
}, - "removeOrganizationFeatureIntent": {
- "name": "FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY"
}, - "signRawPayloadIntentV2": {
- "signWith": "string",
- "payload": "string",
- "encoding": "PAYLOAD_ENCODING_HEXADECIMAL",
- "hashFunction": "HASH_FUNCTION_NO_OP"
}, - "signTransactionIntentV2": {
- "signWith": "string",
- "unsignedTransaction": "string",
- "type": "TRANSACTION_TYPE_ETHEREUM"
}, - "exportPrivateKeyIntent": {
- "privateKeyId": "string",
- "targetPublicKey": "string"
}, - "exportWalletIntent": {
- "walletId": "string",
- "targetPublicKey": "string",
- "language": "MNEMONIC_LANGUAGE_ENGLISH"
}, - "createSubOrganizationIntentV4": {
- "subOrganizationName": "string",
- "rootUsers": [
- {
- "userName": "string",
- "userEmail": "string",
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "expirationSeconds": "string"
}
], - "authenticators": [
- {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- null
]
}
}
]
}
], - "rootQuorumThreshold": 0,
- "wallet": {
- "walletName": "string",
- "accounts": [
- {
- "curve": "CURVE_SECP256K1",
- "pathFormat": "PATH_FORMAT_BIP32",
- "path": "string",
- "addressFormat": "ADDRESS_FORMAT_UNCOMPRESSED"
}
], - "mnemonicLength": 0
}, - "disableEmailRecovery": true,
- "disableEmailAuth": true
}, - "emailAuthIntent": {
- "email": "string",
- "targetPublicKey": "string",
- "apiKeyName": "string",
- "expirationSeconds": "string",
- "emailCustomization": {
- "appName": "string",
- "logoUrl": "string",
- "magicLinkTemplate": "string",
- "templateVariables": "string",
- "templateId": "string"
}, - "invalidateExisting": true
}, - "exportWalletAccountIntent": {
- "address": "string",
- "targetPublicKey": "string"
}, - "initImportWalletIntent": {
- "userId": "string"
}, - "importWalletIntent": {
- "userId": "string",
- "walletName": "string",
- "encryptedBundle": "string",
- "accounts": [
- {
- "curve": "CURVE_SECP256K1",
- "pathFormat": "PATH_FORMAT_BIP32",
- "path": "string",
- "addressFormat": "ADDRESS_FORMAT_UNCOMPRESSED"
}
]
}, - "initImportPrivateKeyIntent": {
- "userId": "string"
}, - "importPrivateKeyIntent": {
- "userId": "string",
- "privateKeyName": "string",
- "encryptedBundle": "string",
- "curve": "CURVE_SECP256K1",
- "addressFormats": [
- "ADDRESS_FORMAT_UNCOMPRESSED"
]
}, - "createPoliciesIntent": {
- "policies": [
- {
- "policyName": "string",
- "effect": "EFFECT_ALLOW",
- "condition": "string",
- "consensus": "string",
- "notes": "string"
}
]
}, - "signRawPayloadsIntent": {
- "signWith": "string",
- "payloads": [
- "string"
], - "encoding": "PAYLOAD_ENCODING_HEXADECIMAL",
- "hashFunction": "HASH_FUNCTION_NO_OP"
}, - "createReadOnlySessionIntent": { },
- "createOauthProvidersIntent": {
- "userId": "string",
- "oauthProviders": [
- {
- "providerName": "string",
- "oidcToken": "string"
}
]
}, - "deleteOauthProvidersIntent": {
- "userId": "string",
- "providerIds": [
- "string"
]
}, - "createSubOrganizationIntentV5": {
- "subOrganizationName": "string",
- "rootUsers": [
- {
- "userName": "string",
- "userEmail": "string",
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "expirationSeconds": "string"
}
], - "authenticators": [
- {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- null
]
}
}
], - "oauthProviders": [
- {
- "providerName": "string",
- "oidcToken": "string"
}
]
}
], - "rootQuorumThreshold": 0,
- "wallet": {
- "walletName": "string",
- "accounts": [
- {
- "curve": "CURVE_SECP256K1",
- "pathFormat": "PATH_FORMAT_BIP32",
- "path": "string",
- "addressFormat": "ADDRESS_FORMAT_UNCOMPRESSED"
}
], - "mnemonicLength": 0
}, - "disableEmailRecovery": true,
- "disableEmailAuth": true
}, - "oauthIntent": {
- "oidcToken": "string",
- "targetPublicKey": "string",
- "apiKeyName": "string",
- "expirationSeconds": "string"
}, - "createApiKeysIntentV2": {
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "curveType": "API_KEY_CURVE_P256",
- "expirationSeconds": "string"
}
], - "userId": "string"
}, - "createReadWriteSessionIntent": {
- "targetPublicKey": "string",
- "email": "string",
- "apiKeyName": "string",
- "expirationSeconds": "string"
}, - "emailAuthIntentV2": {
- "email": "string",
- "targetPublicKey": "string",
- "apiKeyName": "string",
- "expirationSeconds": "string",
- "emailCustomization": {
- "appName": "string",
- "logoUrl": "string",
- "magicLinkTemplate": "string",
- "templateVariables": "string",
- "templateId": "string"
}, - "invalidateExisting": true
}, - "createSubOrganizationIntentV6": {
- "subOrganizationName": "string",
- "rootUsers": [
- {
- "userName": "string",
- "userEmail": "string",
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "curveType": "API_KEY_CURVE_P256",
- "expirationSeconds": "string"
}
], - "authenticators": [
- {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- null
]
}
}
], - "oauthProviders": [
- {
- "providerName": "string",
- "oidcToken": "string"
}
]
}
], - "rootQuorumThreshold": 0,
- "wallet": {
- "walletName": "string",
- "accounts": [
- {
- "curve": "CURVE_SECP256K1",
- "pathFormat": "PATH_FORMAT_BIP32",
- "path": "string",
- "addressFormat": "ADDRESS_FORMAT_UNCOMPRESSED"
}
], - "mnemonicLength": 0
}, - "disableEmailRecovery": true,
- "disableEmailAuth": true
}, - "deletePrivateKeysIntent": {
- "privateKeyIds": [
- "string"
], - "deleteWithoutExport": true
}, - "deleteWalletsIntent": {
- "walletIds": [
- "string"
], - "deleteWithoutExport": true
}, - "createReadWriteSessionIntentV2": {
- "targetPublicKey": "string",
- "userId": "string",
- "apiKeyName": "string",
- "expirationSeconds": "string"
}, - "deleteSubOrganizationIntent": {
- "deleteWithoutExport": true
}, - "initOtpAuthIntent": {
- "otpType": "string",
- "contact": "string",
- "emailCustomization": {
- "appName": "string",
- "logoUrl": "string",
- "magicLinkTemplate": "string",
- "templateVariables": "string",
- "templateId": "string"
}
}, - "otpAuthIntent": {
- "otpId": "string",
- "otpCode": "string",
- "targetPublicKey": "string",
- "apiKeyName": "string",
- "expirationSeconds": "string",
- "invalidateExisting": true
}, - "createSubOrganizationIntentV7": {
- "subOrganizationName": "string",
- "rootUsers": [
- {
- "userName": "string",
- "userEmail": "string",
- "userPhoneNumber": "string",
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "curveType": "API_KEY_CURVE_P256",
- "expirationSeconds": "string"
}
], - "authenticators": [
- {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- null
]
}
}
], - "oauthProviders": [
- {
- "providerName": "string",
- "oidcToken": "string"
}
]
}
], - "rootQuorumThreshold": 0,
- "wallet": {
- "walletName": "string",
- "accounts": [
- {
- "curve": "CURVE_SECP256K1",
- "pathFormat": "PATH_FORMAT_BIP32",
- "path": "string",
- "addressFormat": "ADDRESS_FORMAT_UNCOMPRESSED"
}
], - "mnemonicLength": 0
}, - "disableEmailRecovery": true,
- "disableEmailAuth": true,
- "disableSmsAuth": true,
- "disableOtpEmailAuth": true
}
}, - "result": {
- "createOrganizationResult": {
- "organizationId": "string"
}, - "createAuthenticatorsResult": {
- "authenticatorIds": [
- "string"
]
}, - "createUsersResult": {
- "userIds": [
- "string"
]
}, - "createPrivateKeysResult": {
- "privateKeyIds": [
- "string"
]
}, - "createInvitationsResult": {
- "invitationIds": [
- "string"
]
}, - "acceptInvitationResult": {
- "invitationId": "string",
- "userId": "string"
}, - "signRawPayloadResult": {
- "r": "string",
- "s": "string",
- "v": "string"
}, - "createPolicyResult": {
- "policyId": "string"
}, - "disablePrivateKeyResult": {
- "privateKeyId": "string"
}, - "deleteUsersResult": {
- "userIds": [
- "string"
]
}, - "deleteAuthenticatorsResult": {
- "authenticatorIds": [
- "string"
]
}, - "deleteInvitationResult": {
- "invitationId": "string"
}, - "deleteOrganizationResult": {
- "organizationId": "string"
}, - "deletePolicyResult": {
- "policyId": "string"
}, - "createUserTagResult": {
- "userTagId": "string",
- "userIds": [
- "string"
]
}, - "deleteUserTagsResult": {
- "userTagIds": [
- "string"
], - "userIds": [
- "string"
]
}, - "signTransactionResult": {
- "signedTransaction": "string"
}, - "deleteApiKeysResult": {
- "apiKeyIds": [
- "string"
]
}, - "createApiKeysResult": {
- "apiKeyIds": [
- "string"
]
}, - "createPrivateKeyTagResult": {
- "privateKeyTagId": "string",
- "privateKeyIds": [
- "string"
]
}, - "deletePrivateKeyTagsResult": {
- "privateKeyTagIds": [
- "string"
], - "privateKeyIds": [
- "string"
]
}, - "setPaymentMethodResult": {
- "lastFour": "string",
- "cardHolderName": "string",
- "cardHolderEmail": "string"
}, - "activateBillingTierResult": {
- "productId": "string"
}, - "deletePaymentMethodResult": {
- "paymentMethodId": "string"
}, - "createApiOnlyUsersResult": {
- "userIds": [
- "string"
]
}, - "updateRootQuorumResult": { },
- "updateUserTagResult": {
- "userTagId": "string"
}, - "updatePrivateKeyTagResult": {
- "privateKeyTagId": "string"
}, - "createSubOrganizationResult": {
- "subOrganizationId": "string",
- "rootUserIds": [
- "string"
]
}, - "updateAllowedOriginsResult": { },
- "createPrivateKeysResultV2": {
- "privateKeys": [
- {
- "privateKeyId": "string",
- "addresses": [
- {
- "format": "ADDRESS_FORMAT_UNCOMPRESSED",
- "address": "string"
}
]
}
]
}, - "updateUserResult": {
- "userId": "string"
}, - "updatePolicyResult": {
- "policyId": "string"
}, - "createSubOrganizationResultV3": {
- "subOrganizationId": "string",
- "privateKeys": [
- {
- "privateKeyId": "string",
- "addresses": [
- {
- "format": "ADDRESS_FORMAT_UNCOMPRESSED",
- "address": "string"
}
]
}
], - "rootUserIds": [
- "string"
]
}, - "createWalletResult": {
- "walletId": "string",
- "addresses": [
- "string"
]
}, - "createWalletAccountsResult": {
- "addresses": [
- "string"
]
}, - "initUserEmailRecoveryResult": {
- "userId": "string"
}, - "recoverUserResult": {
- "authenticatorId": [
- "string"
]
}, - "setOrganizationFeatureResult": {
- "features": [
- {
- "name": "FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY",
- "value": "string"
}
]
}, - "removeOrganizationFeatureResult": {
- "features": [
- {
- "name": "FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY",
- "value": "string"
}
]
}, - "exportPrivateKeyResult": {
- "privateKeyId": "string",
- "exportBundle": "string"
}, - "exportWalletResult": {
- "walletId": "string",
- "exportBundle": "string"
}, - "createSubOrganizationResultV4": {
- "subOrganizationId": "string",
- "wallet": {
- "walletId": "string",
- "addresses": [
- "string"
]
}, - "rootUserIds": [
- "string"
]
}, - "emailAuthResult": {
- "userId": "string",
- "apiKeyId": "string"
}, - "exportWalletAccountResult": {
- "address": "string",
- "exportBundle": "string"
}, - "initImportWalletResult": {
- "importBundle": "string"
}, - "importWalletResult": {
- "walletId": "string",
- "addresses": [
- "string"
]
}, - "initImportPrivateKeyResult": {
- "importBundle": "string"
}, - "importPrivateKeyResult": {
- "privateKeyId": "string",
- "addresses": [
- {
- "format": "ADDRESS_FORMAT_UNCOMPRESSED",
- "address": "string"
}
]
}, - "createPoliciesResult": {
- "policyIds": [
- "string"
]
}, - "signRawPayloadsResult": {
- "signatures": [
- {
- "r": "string",
- "s": "string",
- "v": "string"
}
]
}, - "createReadOnlySessionResult": {
- "organizationId": "string",
- "organizationName": "string",
- "userId": "string",
- "username": "string",
- "session": "string",
- "sessionExpiry": "string"
}, - "createOauthProvidersResult": {
- "providerIds": [
- "string"
]
}, - "deleteOauthProvidersResult": {
- "providerIds": [
- "string"
]
}, - "createSubOrganizationResultV5": {
- "subOrganizationId": "string",
- "wallet": {
- "walletId": "string",
- "addresses": [
- "string"
]
}, - "rootUserIds": [
- "string"
]
}, - "oauthResult": {
- "userId": "string",
- "apiKeyId": "string",
- "credentialBundle": "string"
}, - "createReadWriteSessionResult": {
- "organizationId": "string",
- "organizationName": "string",
- "userId": "string",
- "username": "string",
- "apiKeyId": "string",
- "credentialBundle": "string"
}, - "createSubOrganizationResultV6": {
- "subOrganizationId": "string",
- "wallet": {
- "walletId": "string",
- "addresses": [
- "string"
]
}, - "rootUserIds": [
- "string"
]
}, - "deletePrivateKeysResult": {
- "privateKeyIds": [
- "string"
]
}, - "deleteWalletsResult": {
- "walletIds": [
- "string"
]
}, - "createReadWriteSessionResultV2": {
- "organizationId": "string",
- "organizationName": "string",
- "userId": "string",
- "username": "string",
- "apiKeyId": "string",
- "credentialBundle": "string"
}, - "deleteSubOrganizationResult": {
- "subOrganizationUuid": "string"
}, - "initOtpAuthResult": {
- "otpId": "string"
}, - "otpAuthResult": {
- "userId": "string",
- "apiKeyId": "string",
- "credentialBundle": "string"
}, - "createSubOrganizationResultV7": {
- "subOrganizationId": "string",
- "wallet": {
- "walletId": "string",
- "addresses": [
- "string"
]
}, - "rootUserIds": [
- "string"
]
}
}, - "votes": [
- {
- "id": "string",
- "userId": "string",
- "user": {
- "userId": "string",
- "userName": "string",
- "userEmail": "string",
- "userPhoneNumber": "string",
- "authenticators": [
- {
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
], - "attestationType": "string",
- "aaguid": "string",
- "credentialId": "string",
- "model": "string",
- "credential": {
- "publicKey": "string",
- "type": "CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR"
}, - "authenticatorId": "string",
- "authenticatorName": "string",
- "createdAt": {
- "seconds": "string",
- "nanos": "string"
}, - "updatedAt": {
- "seconds": "string",
- "nanos": "string"
}
}
], - "apiKeys": [
- {
- "credential": {
- "publicKey": "string",
- "type": "CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR"
}, - "apiKeyId": "string",
- "apiKeyName": "string",
- "createdAt": {
- "seconds": "string",
- "nanos": "string"
}, - "updatedAt": {
- "seconds": "string",
- "nanos": "string"
}, - "expirationSeconds": "string"
}
], - "userTags": [
- "string"
], - "oauthProviders": [
- {
- "providerId": "string",
- "providerName": "string",
- "issuer": "string",
- "audience": "string",
- "subject": "string",
- "createdAt": {
- "seconds": "string",
- "nanos": "string"
}, - "updatedAt": {
- "seconds": "string",
- "nanos": "string"
}
}
], - "createdAt": {
- "seconds": "string",
- "nanos": "string"
}, - "updatedAt": {
- "seconds": "string",
- "nanos": "string"
}
}, - "activityId": "string",
- "selection": "VOTE_SELECTION_APPROVED",
- "message": "string",
- "publicKey": "string",
- "signature": "string",
- "scheme": "string",
- "createdAt": {
- "seconds": "string",
- "nanos": "string"
}
}
], - "fingerprint": "string",
- "canApprove": true,
- "canReject": true,
- "createdAt": {
- "seconds": "string",
- "nanos": "string"
}, - "updatedAt": {
- "seconds": "string",
- "nanos": "string"
}, - "failure": {
- "code": 0,
- "message": "string",
- "details": [
- {
- "@type": "string",
- "property1": null,
- "property2": null
}
]
}
}
}
Update Root Quorum
Set the threshold and members of the root quorum. This activity must be approved by the current root quorum.
Authorizations:
Request Body schema: application/json
type required | string Value: "ACTIVITY_TYPE_UPDATE_ROOT_QUORUM" |
timestampMs required | string Timestamp (in milliseconds) of the request, used to verify liveness of user requests. |
organizationId required | string Unique identifier for a given Organization. |
required | object (UpdateRootQuorumIntent) |
Responses
Request samples
- Payload
{- "type": "ACTIVITY_TYPE_UPDATE_ROOT_QUORUM",
- "timestampMs": "string",
- "organizationId": "string",
- "parameters": {
- "threshold": 0,
- "userIds": [
- "string"
]
}
}
Response samples
- 200
{- "activity": {
- "id": "string",
- "organizationId": "string",
- "status": "ACTIVITY_STATUS_CREATED",
- "type": "ACTIVITY_TYPE_CREATE_API_KEYS",
- "intent": {
- "createOrganizationIntent": {
- "organizationName": "string",
- "rootEmail": "string",
- "rootAuthenticator": {
- "authenticatorName": "string",
- "userId": "string",
- "attestation": {
- "id": "string",
- "type": "public-key",
- "rawId": "string",
- "authenticatorAttachment": "cross-platform",
- "response": {
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
], - "authenticatorAttachment": "cross-platform"
}, - "clientExtensionResults": {
- "appid": true,
- "appidExclude": true,
- "credProps": {
- "rk": true
}
}
}, - "challenge": "string"
}, - "rootUserId": "string"
}, - "createAuthenticatorsIntent": {
- "authenticators": [
- {
- "authenticatorName": "string",
- "userId": "string",
- "attestation": {
- "id": "string",
- "type": "public-key",
- "rawId": "string",
- "authenticatorAttachment": "cross-platform",
- "response": {
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
], - "authenticatorAttachment": "cross-platform"
}, - "clientExtensionResults": {
- "appid": true,
- "appidExclude": true,
- "credProps": {
- "rk": true
}
}
}, - "challenge": "string"
}
], - "userId": "string"
}, - "createUsersIntent": {
- "users": [
- {
- "userName": "string",
- "userEmail": "string",
- "accessType": "ACCESS_TYPE_WEB",
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "expirationSeconds": "string"
}
], - "authenticators": [
- {
- "authenticatorName": "string",
- "userId": "string",
- "attestation": {
- "id": "string",
- "type": "public-key",
- "rawId": "string",
- "authenticatorAttachment": "cross-platform",
- "response": {
- "clientDataJson": null,
- "attestationObject": null,
- "transports": [ ],
- "authenticatorAttachment": null
}, - "clientExtensionResults": {
- "appid": null,
- "appidExclude": null,
- "credProps": null
}
}, - "challenge": "string"
}
], - "userTags": [
- "string"
]
}
]
}, - "createPrivateKeysIntent": {
- "privateKeys": [
- {
- "privateKeyName": "string",
- "curve": "CURVE_SECP256K1",
- "privateKeyTags": [
- "string"
], - "addressFormats": [
- "ADDRESS_FORMAT_UNCOMPRESSED"
]
}
]
}, - "signRawPayloadIntent": {
- "privateKeyId": "string",
- "payload": "string",
- "encoding": "PAYLOAD_ENCODING_HEXADECIMAL",
- "hashFunction": "HASH_FUNCTION_NO_OP"
}, - "createInvitationsIntent": {
- "invitations": [
- {
- "receiverUserName": "string",
- "receiverUserEmail": "string",
- "receiverUserTags": [
- "string"
], - "accessType": "ACCESS_TYPE_WEB",
- "senderUserId": "string"
}
]
}, - "acceptInvitationIntent": {
- "invitationId": "string",
- "userId": "string",
- "authenticator": {
- "authenticatorName": "string",
- "userId": "string",
- "attestation": {
- "id": "string",
- "type": "public-key",
- "rawId": "string",
- "authenticatorAttachment": "cross-platform",
- "response": {
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
], - "authenticatorAttachment": "cross-platform"
}, - "clientExtensionResults": {
- "appid": true,
- "appidExclude": true,
- "credProps": {
- "rk": true
}
}
}, - "challenge": "string"
}
}, - "createPolicyIntent": {
- "policyName": "string",
- "selectors": [
- {
- "subject": "string",
- "operator": "OPERATOR_EQUAL",
- "target": "string"
}
], - "effect": "EFFECT_ALLOW",
- "notes": "string"
}, - "disablePrivateKeyIntent": {
- "privateKeyId": "string"
}, - "deleteUsersIntent": {
- "userIds": [
- "string"
]
}, - "deleteAuthenticatorsIntent": {
- "userId": "string",
- "authenticatorIds": [
- "string"
]
}, - "deleteInvitationIntent": {
- "invitationId": "string"
}, - "deleteOrganizationIntent": {
- "organizationId": "string"
}, - "deletePolicyIntent": {
- "policyId": "string"
}, - "createUserTagIntent": {
- "userTagName": "string",
- "userIds": [
- "string"
]
}, - "deleteUserTagsIntent": {
- "userTagIds": [
- "string"
]
}, - "signTransactionIntent": {
- "privateKeyId": "string",
- "unsignedTransaction": "string",
- "type": "TRANSACTION_TYPE_ETHEREUM"
}, - "createApiKeysIntent": {
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "expirationSeconds": "string"
}
], - "userId": "string"
}, - "deleteApiKeysIntent": {
- "userId": "string",
- "apiKeyIds": [
- "string"
]
}, - "approveActivityIntent": {
- "fingerprint": "string"
}, - "rejectActivityIntent": {
- "fingerprint": "string"
}, - "createPrivateKeyTagIntent": {
- "privateKeyTagName": "string",
- "privateKeyIds": [
- "string"
]
}, - "deletePrivateKeyTagsIntent": {
- "privateKeyTagIds": [
- "string"
]
}, - "createPolicyIntentV2": {
- "policyName": "string",
- "selectors": [
- {
- "subject": "string",
- "operator": "OPERATOR_EQUAL",
- "targets": [
- "string"
]
}
], - "effect": "EFFECT_ALLOW",
- "notes": "string"
}, - "setPaymentMethodIntent": {
- "number": "string",
- "cvv": "string",
- "expiryMonth": "string",
- "expiryYear": "string",
- "cardHolderEmail": "string",
- "cardHolderName": "string"
}, - "activateBillingTierIntent": {
- "productId": "string"
}, - "deletePaymentMethodIntent": {
- "paymentMethodId": "string"
}, - "createPolicyIntentV3": {
- "policyName": "string",
- "effect": "EFFECT_ALLOW",
- "condition": "string",
- "consensus": "string",
- "notes": "string"
}, - "createApiOnlyUsersIntent": {
- "apiOnlyUsers": [
- {
- "userName": "string",
- "userEmail": "string",
- "userTags": [
- "string"
], - "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "expirationSeconds": "string"
}
]
}
]
}, - "updateRootQuorumIntent": {
- "threshold": 0,
- "userIds": [
- "string"
]
}, - "updateUserTagIntent": {
- "userTagId": "string",
- "newUserTagName": "string",
- "addUserIds": [
- "string"
], - "removeUserIds": [
- "string"
]
}, - "updatePrivateKeyTagIntent": {
- "privateKeyTagId": "string",
- "newPrivateKeyTagName": "string",
- "addPrivateKeyIds": [
- "string"
], - "removePrivateKeyIds": [
- "string"
]
}, - "createAuthenticatorsIntentV2": {
- "authenticators": [
- {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
]
}
}
], - "userId": "string"
}, - "acceptInvitationIntentV2": {
- "invitationId": "string",
- "userId": "string",
- "authenticator": {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
]
}
}
}, - "createOrganizationIntentV2": {
- "organizationName": "string",
- "rootEmail": "string",
- "rootAuthenticator": {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
]
}
}, - "rootUserId": "string"
}, - "createUsersIntentV2": {
- "users": [
- {
- "userName": "string",
- "userEmail": "string",
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "expirationSeconds": "string"
}
], - "authenticators": [
- {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- null
]
}
}
], - "userTags": [
- "string"
]
}
]
}, - "createSubOrganizationIntent": {
- "name": "string",
- "rootAuthenticator": {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
]
}
}
}, - "createSubOrganizationIntentV2": {
- "subOrganizationName": "string",
- "rootUsers": [
- {
- "userName": "string",
- "userEmail": "string",
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "expirationSeconds": "string"
}
], - "authenticators": [
- {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- null
]
}
}
]
}
], - "rootQuorumThreshold": 0
}, - "updateAllowedOriginsIntent": {
- "allowedOrigins": [
- "string"
]
}, - "createPrivateKeysIntentV2": {
- "privateKeys": [
- {
- "privateKeyName": "string",
- "curve": "CURVE_SECP256K1",
- "privateKeyTags": [
- "string"
], - "addressFormats": [
- "ADDRESS_FORMAT_UNCOMPRESSED"
]
}
]
}, - "updateUserIntent": {
- "userId": "string",
- "userName": "string",
- "userEmail": "string",
- "userTagIds": [
- "string"
], - "userPhoneNumber": "string"
}, - "updatePolicyIntent": {
- "policyId": "string",
- "policyName": "string",
- "policyEffect": "EFFECT_ALLOW",
- "policyCondition": "string",
- "policyConsensus": "string",
- "policyNotes": "string"
}, - "setPaymentMethodIntentV2": {
- "paymentMethodId": "string",
- "cardHolderEmail": "string",
- "cardHolderName": "string"
}, - "createSubOrganizationIntentV3": {
- "subOrganizationName": "string",
- "rootUsers": [
- {
- "userName": "string",
- "userEmail": "string",
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "expirationSeconds": "string"
}
], - "authenticators": [
- {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- null
]
}
}
]
}
], - "rootQuorumThreshold": 0,
- "privateKeys": [
- {
- "privateKeyName": "string",
- "curve": "CURVE_SECP256K1",
- "privateKeyTags": [
- "string"
], - "addressFormats": [
- "ADDRESS_FORMAT_UNCOMPRESSED"
]
}
]
}, - "createWalletIntent": {
- "walletName": "string",
- "accounts": [
- {
- "curve": "CURVE_SECP256K1",
- "pathFormat": "PATH_FORMAT_BIP32",
- "path": "string",
- "addressFormat": "ADDRESS_FORMAT_UNCOMPRESSED"
}
], - "mnemonicLength": 0
}, - "createWalletAccountsIntent": {
- "walletId": "string",
- "accounts": [
- {
- "curve": "CURVE_SECP256K1",
- "pathFormat": "PATH_FORMAT_BIP32",
- "path": "string",
- "addressFormat": "ADDRESS_FORMAT_UNCOMPRESSED"
}
]
}, - "initUserEmailRecoveryIntent": {
- "email": "string",
- "targetPublicKey": "string",
- "expirationSeconds": "string",
- "emailCustomization": {
- "appName": "string",
- "logoUrl": "string",
- "magicLinkTemplate": "string",
- "templateVariables": "string",
- "templateId": "string"
}
}, - "recoverUserIntent": {
- "authenticator": {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
]
}
}, - "userId": "string"
}, - "setOrganizationFeatureIntent": {
- "name": "FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY",
- "value": "string"
}, - "removeOrganizationFeatureIntent": {
- "name": "FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY"
}, - "signRawPayloadIntentV2": {
- "signWith": "string",
- "payload": "string",
- "encoding": "PAYLOAD_ENCODING_HEXADECIMAL",
- "hashFunction": "HASH_FUNCTION_NO_OP"
}, - "signTransactionIntentV2": {
- "signWith": "string",
- "unsignedTransaction": "string",
- "type": "TRANSACTION_TYPE_ETHEREUM"
}, - "exportPrivateKeyIntent": {
- "privateKeyId": "string",
- "targetPublicKey": "string"
}, - "exportWalletIntent": {
- "walletId": "string",
- "targetPublicKey": "string",
- "language": "MNEMONIC_LANGUAGE_ENGLISH"
}, - "createSubOrganizationIntentV4": {
- "subOrganizationName": "string",
- "rootUsers": [
- {
- "userName": "string",
- "userEmail": "string",
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "expirationSeconds": "string"
}
], - "authenticators": [
- {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- null
]
}
}
]
}
], - "rootQuorumThreshold": 0,
- "wallet": {
- "walletName": "string",
- "accounts": [
- {
- "curve": "CURVE_SECP256K1",
- "pathFormat": "PATH_FORMAT_BIP32",
- "path": "string",
- "addressFormat": "ADDRESS_FORMAT_UNCOMPRESSED"
}
], - "mnemonicLength": 0
}, - "disableEmailRecovery": true,
- "disableEmailAuth": true
}, - "emailAuthIntent": {
- "email": "string",
- "targetPublicKey": "string",
- "apiKeyName": "string",
- "expirationSeconds": "string",
- "emailCustomization": {
- "appName": "string",
- "logoUrl": "string",
- "magicLinkTemplate": "string",
- "templateVariables": "string",
- "templateId": "string"
}, - "invalidateExisting": true
}, - "exportWalletAccountIntent": {
- "address": "string",
- "targetPublicKey": "string"
}, - "initImportWalletIntent": {
- "userId": "string"
}, - "importWalletIntent": {
- "userId": "string",
- "walletName": "string",
- "encryptedBundle": "string",
- "accounts": [
- {
- "curve": "CURVE_SECP256K1",
- "pathFormat": "PATH_FORMAT_BIP32",
- "path": "string",
- "addressFormat": "ADDRESS_FORMAT_UNCOMPRESSED"
}
]
}, - "initImportPrivateKeyIntent": {
- "userId": "string"
}, - "importPrivateKeyIntent": {
- "userId": "string",
- "privateKeyName": "string",
- "encryptedBundle": "string",
- "curve": "CURVE_SECP256K1",
- "addressFormats": [
- "ADDRESS_FORMAT_UNCOMPRESSED"
]
}, - "createPoliciesIntent": {
- "policies": [
- {
- "policyName": "string",
- "effect": "EFFECT_ALLOW",
- "condition": "string",
- "consensus": "string",
- "notes": "string"
}
]
}, - "signRawPayloadsIntent": {
- "signWith": "string",
- "payloads": [
- "string"
], - "encoding": "PAYLOAD_ENCODING_HEXADECIMAL",
- "hashFunction": "HASH_FUNCTION_NO_OP"
}, - "createReadOnlySessionIntent": { },
- "createOauthProvidersIntent": {
- "userId": "string",
- "oauthProviders": [
- {
- "providerName": "string",
- "oidcToken": "string"
}
]
}, - "deleteOauthProvidersIntent": {
- "userId": "string",
- "providerIds": [
- "string"
]
}, - "createSubOrganizationIntentV5": {
- "subOrganizationName": "string",
- "rootUsers": [
- {
- "userName": "string",
- "userEmail": "string",
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "expirationSeconds": "string"
}
], - "authenticators": [
- {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- null
]
}
}
], - "oauthProviders": [
- {
- "providerName": "string",
- "oidcToken": "string"
}
]
}
], - "rootQuorumThreshold": 0,
- "wallet": {
- "walletName": "string",
- "accounts": [
- {
- "curve": "CURVE_SECP256K1",
- "pathFormat": "PATH_FORMAT_BIP32",
- "path": "string",
- "addressFormat": "ADDRESS_FORMAT_UNCOMPRESSED"
}
], - "mnemonicLength": 0
}, - "disableEmailRecovery": true,
- "disableEmailAuth": true
}, - "oauthIntent": {
- "oidcToken": "string",
- "targetPublicKey": "string",
- "apiKeyName": "string",
- "expirationSeconds": "string"
}, - "createApiKeysIntentV2": {
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "curveType": "API_KEY_CURVE_P256",
- "expirationSeconds": "string"
}
], - "userId": "string"
}, - "createReadWriteSessionIntent": {
- "targetPublicKey": "string",
- "email": "string",
- "apiKeyName": "string",
- "expirationSeconds": "string"
}, - "emailAuthIntentV2": {
- "email": "string",
- "targetPublicKey": "string",
- "apiKeyName": "string",
- "expirationSeconds": "string",
- "emailCustomization": {
- "appName": "string",
- "logoUrl": "string",
- "magicLinkTemplate": "string",
- "templateVariables": "string",
- "templateId": "string"
}, - "invalidateExisting": true
}, - "createSubOrganizationIntentV6": {
- "subOrganizationName": "string",
- "rootUsers": [
- {
- "userName": "string",
- "userEmail": "string",
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "curveType": "API_KEY_CURVE_P256",
- "expirationSeconds": "string"
}
], - "authenticators": [
- {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- null
]
}
}
], - "oauthProviders": [
- {
- "providerName": "string",
- "oidcToken": "string"
}
]
}
], - "rootQuorumThreshold": 0,
- "wallet": {
- "walletName": "string",
- "accounts": [
- {
- "curve": "CURVE_SECP256K1",
- "pathFormat": "PATH_FORMAT_BIP32",
- "path": "string",
- "addressFormat": "ADDRESS_FORMAT_UNCOMPRESSED"
}
], - "mnemonicLength": 0
}, - "disableEmailRecovery": true,
- "disableEmailAuth": true
}, - "deletePrivateKeysIntent": {
- "privateKeyIds": [
- "string"
], - "deleteWithoutExport": true
}, - "deleteWalletsIntent": {
- "walletIds": [
- "string"
], - "deleteWithoutExport": true
}, - "createReadWriteSessionIntentV2": {
- "targetPublicKey": "string",
- "userId": "string",
- "apiKeyName": "string",
- "expirationSeconds": "string"
}, - "deleteSubOrganizationIntent": {
- "deleteWithoutExport": true
}, - "initOtpAuthIntent": {
- "otpType": "string",
- "contact": "string",
- "emailCustomization": {
- "appName": "string",
- "logoUrl": "string",
- "magicLinkTemplate": "string",
- "templateVariables": "string",
- "templateId": "string"
}
}, - "otpAuthIntent": {
- "otpId": "string",
- "otpCode": "string",
- "targetPublicKey": "string",
- "apiKeyName": "string",
- "expirationSeconds": "string",
- "invalidateExisting": true
}, - "createSubOrganizationIntentV7": {
- "subOrganizationName": "string",
- "rootUsers": [
- {
- "userName": "string",
- "userEmail": "string",
- "userPhoneNumber": "string",
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "curveType": "API_KEY_CURVE_P256",
- "expirationSeconds": "string"
}
], - "authenticators": [
- {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- null
]
}
}
], - "oauthProviders": [
- {
- "providerName": "string",
- "oidcToken": "string"
}
]
}
], - "rootQuorumThreshold": 0,
- "wallet": {
- "walletName": "string",
- "accounts": [
- {
- "curve": "CURVE_SECP256K1",
- "pathFormat": "PATH_FORMAT_BIP32",
- "path": "string",
- "addressFormat": "ADDRESS_FORMAT_UNCOMPRESSED"
}
], - "mnemonicLength": 0
}, - "disableEmailRecovery": true,
- "disableEmailAuth": true,
- "disableSmsAuth": true,
- "disableOtpEmailAuth": true
}
}, - "result": {
- "createOrganizationResult": {
- "organizationId": "string"
}, - "createAuthenticatorsResult": {
- "authenticatorIds": [
- "string"
]
}, - "createUsersResult": {
- "userIds": [
- "string"
]
}, - "createPrivateKeysResult": {
- "privateKeyIds": [
- "string"
]
}, - "createInvitationsResult": {
- "invitationIds": [
- "string"
]
}, - "acceptInvitationResult": {
- "invitationId": "string",
- "userId": "string"
}, - "signRawPayloadResult": {
- "r": "string",
- "s": "string",
- "v": "string"
}, - "createPolicyResult": {
- "policyId": "string"
}, - "disablePrivateKeyResult": {
- "privateKeyId": "string"
}, - "deleteUsersResult": {
- "userIds": [
- "string"
]
}, - "deleteAuthenticatorsResult": {
- "authenticatorIds": [
- "string"
]
}, - "deleteInvitationResult": {
- "invitationId": "string"
}, - "deleteOrganizationResult": {
- "organizationId": "string"
}, - "deletePolicyResult": {
- "policyId": "string"
}, - "createUserTagResult": {
- "userTagId": "string",
- "userIds": [
- "string"
]
}, - "deleteUserTagsResult": {
- "userTagIds": [
- "string"
], - "userIds": [
- "string"
]
}, - "signTransactionResult": {
- "signedTransaction": "string"
}, - "deleteApiKeysResult": {
- "apiKeyIds": [
- "string"
]
}, - "createApiKeysResult": {
- "apiKeyIds": [
- "string"
]
}, - "createPrivateKeyTagResult": {
- "privateKeyTagId": "string",
- "privateKeyIds": [
- "string"
]
}, - "deletePrivateKeyTagsResult": {
- "privateKeyTagIds": [
- "string"
], - "privateKeyIds": [
- "string"
]
}, - "setPaymentMethodResult": {
- "lastFour": "string",
- "cardHolderName": "string",
- "cardHolderEmail": "string"
}, - "activateBillingTierResult": {
- "productId": "string"
}, - "deletePaymentMethodResult": {
- "paymentMethodId": "string"
}, - "createApiOnlyUsersResult": {
- "userIds": [
- "string"
]
}, - "updateRootQuorumResult": { },
- "updateUserTagResult": {
- "userTagId": "string"
}, - "updatePrivateKeyTagResult": {
- "privateKeyTagId": "string"
}, - "createSubOrganizationResult": {
- "subOrganizationId": "string",
- "rootUserIds": [
- "string"
]
}, - "updateAllowedOriginsResult": { },
- "createPrivateKeysResultV2": {
- "privateKeys": [
- {
- "privateKeyId": "string",
- "addresses": [
- {
- "format": "ADDRESS_FORMAT_UNCOMPRESSED",
- "address": "string"
}
]
}
]
}, - "updateUserResult": {
- "userId": "string"
}, - "updatePolicyResult": {
- "policyId": "string"
}, - "createSubOrganizationResultV3": {
- "subOrganizationId": "string",
- "privateKeys": [
- {
- "privateKeyId": "string",
- "addresses": [
- {
- "format": "ADDRESS_FORMAT_UNCOMPRESSED",
- "address": "string"
}
]
}
], - "rootUserIds": [
- "string"
]
}, - "createWalletResult": {
- "walletId": "string",
- "addresses": [
- "string"
]
}, - "createWalletAccountsResult": {
- "addresses": [
- "string"
]
}, - "initUserEmailRecoveryResult": {
- "userId": "string"
}, - "recoverUserResult": {
- "authenticatorId": [
- "string"
]
}, - "setOrganizationFeatureResult": {
- "features": [
- {
- "name": "FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY",
- "value": "string"
}
]
}, - "removeOrganizationFeatureResult": {
- "features": [
- {
- "name": "FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY",
- "value": "string"
}
]
}, - "exportPrivateKeyResult": {
- "privateKeyId": "string",
- "exportBundle": "string"
}, - "exportWalletResult": {
- "walletId": "string",
- "exportBundle": "string"
}, - "createSubOrganizationResultV4": {
- "subOrganizationId": "string",
- "wallet": {
- "walletId": "string",
- "addresses": [
- "string"
]
}, - "rootUserIds": [
- "string"
]
}, - "emailAuthResult": {
- "userId": "string",
- "apiKeyId": "string"
}, - "exportWalletAccountResult": {
- "address": "string",
- "exportBundle": "string"
}, - "initImportWalletResult": {
- "importBundle": "string"
}, - "importWalletResult": {
- "walletId": "string",
- "addresses": [
- "string"
]
}, - "initImportPrivateKeyResult": {
- "importBundle": "string"
}, - "importPrivateKeyResult": {
- "privateKeyId": "string",
- "addresses": [
- {
- "format": "ADDRESS_FORMAT_UNCOMPRESSED",
- "address": "string"
}
]
}, - "createPoliciesResult": {
- "policyIds": [
- "string"
]
}, - "signRawPayloadsResult": {
- "signatures": [
- {
- "r": "string",
- "s": "string",
- "v": "string"
}
]
}, - "createReadOnlySessionResult": {
- "organizationId": "string",
- "organizationName": "string",
- "userId": "string",
- "username": "string",
- "session": "string",
- "sessionExpiry": "string"
}, - "createOauthProvidersResult": {
- "providerIds": [
- "string"
]
}, - "deleteOauthProvidersResult": {
- "providerIds": [
- "string"
]
}, - "createSubOrganizationResultV5": {
- "subOrganizationId": "string",
- "wallet": {
- "walletId": "string",
- "addresses": [
- "string"
]
}, - "rootUserIds": [
- "string"
]
}, - "oauthResult": {
- "userId": "string",
- "apiKeyId": "string",
- "credentialBundle": "string"
}, - "createReadWriteSessionResult": {
- "organizationId": "string",
- "organizationName": "string",
- "userId": "string",
- "username": "string",
- "apiKeyId": "string",
- "credentialBundle": "string"
}, - "createSubOrganizationResultV6": {
- "subOrganizationId": "string",
- "wallet": {
- "walletId": "string",
- "addresses": [
- "string"
]
}, - "rootUserIds": [
- "string"
]
}, - "deletePrivateKeysResult": {
- "privateKeyIds": [
- "string"
]
}, - "deleteWalletsResult": {
- "walletIds": [
- "string"
]
}, - "createReadWriteSessionResultV2": {
- "organizationId": "string",
- "organizationName": "string",
- "userId": "string",
- "username": "string",
- "apiKeyId": "string",
- "credentialBundle": "string"
}, - "deleteSubOrganizationResult": {
- "subOrganizationUuid": "string"
}, - "initOtpAuthResult": {
- "otpId": "string"
}, - "otpAuthResult": {
- "userId": "string",
- "apiKeyId": "string",
- "credentialBundle": "string"
}, - "createSubOrganizationResultV7": {
- "subOrganizationId": "string",
- "wallet": {
- "walletId": "string",
- "addresses": [
- "string"
]
}, - "rootUserIds": [
- "string"
]
}
}, - "votes": [
- {
- "id": "string",
- "userId": "string",
- "user": {
- "userId": "string",
- "userName": "string",
- "userEmail": "string",
- "userPhoneNumber": "string",
- "authenticators": [
- {
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
], - "attestationType": "string",
- "aaguid": "string",
- "credentialId": "string",
- "model": "string",
- "credential": {
- "publicKey": "string",
- "type": "CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR"
}, - "authenticatorId": "string",
- "authenticatorName": "string",
- "createdAt": {
- "seconds": "string",
- "nanos": "string"
}, - "updatedAt": {
- "seconds": "string",
- "nanos": "string"
}
}
], - "apiKeys": [
- {
- "credential": {
- "publicKey": "string",
- "type": "CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR"
}, - "apiKeyId": "string",
- "apiKeyName": "string",
- "createdAt": {
- "seconds": "string",
- "nanos": "string"
}, - "updatedAt": {
- "seconds": "string",
- "nanos": "string"
}, - "expirationSeconds": "string"
}
], - "userTags": [
- "string"
], - "oauthProviders": [
- {
- "providerId": "string",
- "providerName": "string",
- "issuer": "string",
- "audience": "string",
- "subject": "string",
- "createdAt": {
- "seconds": "string",
- "nanos": "string"
}, - "updatedAt": {
- "seconds": "string",
- "nanos": "string"
}
}
], - "createdAt": {
- "seconds": "string",
- "nanos": "string"
}, - "updatedAt": {
- "seconds": "string",
- "nanos": "string"
}
}, - "activityId": "string",
- "selection": "VOTE_SELECTION_APPROVED",
- "message": "string",
- "publicKey": "string",
- "signature": "string",
- "scheme": "string",
- "createdAt": {
- "seconds": "string",
- "nanos": "string"
}
}
], - "fingerprint": "string",
- "canApprove": true,
- "canReject": true,
- "createdAt": {
- "seconds": "string",
- "nanos": "string"
}, - "updatedAt": {
- "seconds": "string",
- "nanos": "string"
}, - "failure": {
- "code": 0,
- "message": "string",
- "details": [
- {
- "@type": "string",
- "property1": null,
- "property2": null
}
]
}
}
}
Invitations allow you to invite Users into your Organization via email. Alternatively, Users can be added directly without an Invitation if their ApiKey or Authenticator credentials are known ahead of time.
See Users for more information
Create Invitations
Create Invitations to join an existing Organization
Authorizations:
Request Body schema: application/json
type required | string Value: "ACTIVITY_TYPE_CREATE_INVITATIONS" |
timestampMs required | string Timestamp (in milliseconds) of the request, used to verify liveness of user requests. |
organizationId required | string Unique identifier for a given Organization. |
required | object (CreateInvitationsIntent) |
Responses
Request samples
- Payload
{- "type": "ACTIVITY_TYPE_CREATE_INVITATIONS",
- "timestampMs": "string",
- "organizationId": "string",
- "parameters": {
- "invitations": [
- {
- "receiverUserName": "string",
- "receiverUserEmail": "string",
- "receiverUserTags": [
- "string"
], - "accessType": "ACCESS_TYPE_WEB",
- "senderUserId": "string"
}
]
}
}
Response samples
- 200
{- "activity": {
- "id": "string",
- "organizationId": "string",
- "status": "ACTIVITY_STATUS_CREATED",
- "type": "ACTIVITY_TYPE_CREATE_API_KEYS",
- "intent": {
- "createOrganizationIntent": {
- "organizationName": "string",
- "rootEmail": "string",
- "rootAuthenticator": {
- "authenticatorName": "string",
- "userId": "string",
- "attestation": {
- "id": "string",
- "type": "public-key",
- "rawId": "string",
- "authenticatorAttachment": "cross-platform",
- "response": {
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
], - "authenticatorAttachment": "cross-platform"
}, - "clientExtensionResults": {
- "appid": true,
- "appidExclude": true,
- "credProps": {
- "rk": true
}
}
}, - "challenge": "string"
}, - "rootUserId": "string"
}, - "createAuthenticatorsIntent": {
- "authenticators": [
- {
- "authenticatorName": "string",
- "userId": "string",
- "attestation": {
- "id": "string",
- "type": "public-key",
- "rawId": "string",
- "authenticatorAttachment": "cross-platform",
- "response": {
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
], - "authenticatorAttachment": "cross-platform"
}, - "clientExtensionResults": {
- "appid": true,
- "appidExclude": true,
- "credProps": {
- "rk": true
}
}
}, - "challenge": "string"
}
], - "userId": "string"
}, - "createUsersIntent": {
- "users": [
- {
- "userName": "string",
- "userEmail": "string",
- "accessType": "ACCESS_TYPE_WEB",
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "expirationSeconds": "string"
}
], - "authenticators": [
- {
- "authenticatorName": "string",
- "userId": "string",
- "attestation": {
- "id": "string",
- "type": "public-key",
- "rawId": "string",
- "authenticatorAttachment": "cross-platform",
- "response": {
- "clientDataJson": null,
- "attestationObject": null,
- "transports": [ ],
- "authenticatorAttachment": null
}, - "clientExtensionResults": {
- "appid": null,
- "appidExclude": null,
- "credProps": null
}
}, - "challenge": "string"
}
], - "userTags": [
- "string"
]
}
]
}, - "createPrivateKeysIntent": {
- "privateKeys": [
- {
- "privateKeyName": "string",
- "curve": "CURVE_SECP256K1",
- "privateKeyTags": [
- "string"
], - "addressFormats": [
- "ADDRESS_FORMAT_UNCOMPRESSED"
]
}
]
}, - "signRawPayloadIntent": {
- "privateKeyId": "string",
- "payload": "string",
- "encoding": "PAYLOAD_ENCODING_HEXADECIMAL",
- "hashFunction": "HASH_FUNCTION_NO_OP"
}, - "createInvitationsIntent": {
- "invitations": [
- {
- "receiverUserName": "string",
- "receiverUserEmail": "string",
- "receiverUserTags": [
- "string"
], - "accessType": "ACCESS_TYPE_WEB",
- "senderUserId": "string"
}
]
}, - "acceptInvitationIntent": {
- "invitationId": "string",
- "userId": "string",
- "authenticator": {
- "authenticatorName": "string",
- "userId": "string",
- "attestation": {
- "id": "string",
- "type": "public-key",
- "rawId": "string",
- "authenticatorAttachment": "cross-platform",
- "response": {
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
], - "authenticatorAttachment": "cross-platform"
}, - "clientExtensionResults": {
- "appid": true,
- "appidExclude": true,
- "credProps": {
- "rk": true
}
}
}, - "challenge": "string"
}
}, - "createPolicyIntent": {
- "policyName": "string",
- "selectors": [
- {
- "subject": "string",
- "operator": "OPERATOR_EQUAL",
- "target": "string"
}
], - "effect": "EFFECT_ALLOW",
- "notes": "string"
}, - "disablePrivateKeyIntent": {
- "privateKeyId": "string"
}, - "deleteUsersIntent": {
- "userIds": [
- "string"
]
}, - "deleteAuthenticatorsIntent": {
- "userId": "string",
- "authenticatorIds": [
- "string"
]
}, - "deleteInvitationIntent": {
- "invitationId": "string"
}, - "deleteOrganizationIntent": {
- "organizationId": "string"
}, - "deletePolicyIntent": {
- "policyId": "string"
}, - "createUserTagIntent": {
- "userTagName": "string",
- "userIds": [
- "string"
]
}, - "deleteUserTagsIntent": {
- "userTagIds": [
- "string"
]
}, - "signTransactionIntent": {
- "privateKeyId": "string",
- "unsignedTransaction": "string",
- "type": "TRANSACTION_TYPE_ETHEREUM"
}, - "createApiKeysIntent": {
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "expirationSeconds": "string"
}
], - "userId": "string"
}, - "deleteApiKeysIntent": {
- "userId": "string",
- "apiKeyIds": [
- "string"
]
}, - "approveActivityIntent": {
- "fingerprint": "string"
}, - "rejectActivityIntent": {
- "fingerprint": "string"
}, - "createPrivateKeyTagIntent": {
- "privateKeyTagName": "string",
- "privateKeyIds": [
- "string"
]
}, - "deletePrivateKeyTagsIntent": {
- "privateKeyTagIds": [
- "string"
]
}, - "createPolicyIntentV2": {
- "policyName": "string",
- "selectors": [
- {
- "subject": "string",
- "operator": "OPERATOR_EQUAL",
- "targets": [
- "string"
]
}
], - "effect": "EFFECT_ALLOW",
- "notes": "string"
}, - "setPaymentMethodIntent": {
- "number": "string",
- "cvv": "string",
- "expiryMonth": "string",
- "expiryYear": "string",
- "cardHolderEmail": "string",
- "cardHolderName": "string"
}, - "activateBillingTierIntent": {
- "productId": "string"
}, - "deletePaymentMethodIntent": {
- "paymentMethodId": "string"
}, - "createPolicyIntentV3": {
- "policyName": "string",
- "effect": "EFFECT_ALLOW",
- "condition": "string",
- "consensus": "string",
- "notes": "string"
}, - "createApiOnlyUsersIntent": {
- "apiOnlyUsers": [
- {
- "userName": "string",
- "userEmail": "string",
- "userTags": [
- "string"
], - "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "expirationSeconds": "string"
}
]
}
]
}, - "updateRootQuorumIntent": {
- "threshold": 0,
- "userIds": [
- "string"
]
}, - "updateUserTagIntent": {
- "userTagId": "string",
- "newUserTagName": "string",
- "addUserIds": [
- "string"
], - "removeUserIds": [
- "string"
]
}, - "updatePrivateKeyTagIntent": {
- "privateKeyTagId": "string",
- "newPrivateKeyTagName": "string",
- "addPrivateKeyIds": [
- "string"
], - "removePrivateKeyIds": [
- "string"
]
}, - "createAuthenticatorsIntentV2": {
- "authenticators": [
- {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
]
}
}
], - "userId": "string"
}, - "acceptInvitationIntentV2": {
- "invitationId": "string",
- "userId": "string",
- "authenticator": {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
]
}
}
}, - "createOrganizationIntentV2": {
- "organizationName": "string",
- "rootEmail": "string",
- "rootAuthenticator": {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
]
}
}, - "rootUserId": "string"
}, - "createUsersIntentV2": {
- "users": [
- {
- "userName": "string",
- "userEmail": "string",
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "expirationSeconds": "string"
}
], - "authenticators": [
- {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- null
]
}
}
], - "userTags": [
- "string"
]
}
]
}, - "createSubOrganizationIntent": {
- "name": "string",
- "rootAuthenticator": {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
]
}
}
}, - "createSubOrganizationIntentV2": {
- "subOrganizationName": "string",
- "rootUsers": [
- {
- "userName": "string",
- "userEmail": "string",
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "expirationSeconds": "string"
}
], - "authenticators": [
- {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- null
]
}
}
]
}
], - "rootQuorumThreshold": 0
}, - "updateAllowedOriginsIntent": {
- "allowedOrigins": [
- "string"
]
}, - "createPrivateKeysIntentV2": {
- "privateKeys": [
- {
- "privateKeyName": "string",
- "curve": "CURVE_SECP256K1",
- "privateKeyTags": [
- "string"
], - "addressFormats": [
- "ADDRESS_FORMAT_UNCOMPRESSED"
]
}
]
}, - "updateUserIntent": {
- "userId": "string",
- "userName": "string",
- "userEmail": "string",
- "userTagIds": [
- "string"
], - "userPhoneNumber": "string"
}, - "updatePolicyIntent": {
- "policyId": "string",
- "policyName": "string",
- "policyEffect": "EFFECT_ALLOW",
- "policyCondition": "string",
- "policyConsensus": "string",
- "policyNotes": "string"
}, - "setPaymentMethodIntentV2": {
- "paymentMethodId": "string",
- "cardHolderEmail": "string",
- "cardHolderName": "string"
}, - "createSubOrganizationIntentV3": {
- "subOrganizationName": "string",
- "rootUsers": [
- {
- "userName": "string",
- "userEmail": "string",
- "apiKeys": [
- {
- "apiKeyName": "string",
- "publicKey": "string",
- "expirationSeconds": "string"
}
], - "authenticators": [
- {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- null
]
}
}
]
}
], - "rootQuorumThreshold": 0,
- "privateKeys": [
- {
- "privateKeyName": "string",
- "curve": "CURVE_SECP256K1",
- "privateKeyTags": [
- "string"
], - "addressFormats": [
- "ADDRESS_FORMAT_UNCOMPRESSED"
]
}
]
}, - "createWalletIntent": {
- "walletName": "string",
- "accounts": [
- {
- "curve": "CURVE_SECP256K1",
- "pathFormat": "PATH_FORMAT_BIP32",
- "path": "string",
- "addressFormat": "ADDRESS_FORMAT_UNCOMPRESSED"
}
], - "mnemonicLength": 0
}, - "createWalletAccountsIntent": {
- "walletId": "string",
- "accounts": [
- {
- "curve": "CURVE_SECP256K1",
- "pathFormat": "PATH_FORMAT_BIP32",
- "path": "string",
- "addressFormat": "ADDRESS_FORMAT_UNCOMPRESSED"
}
]
}, - "initUserEmailRecoveryIntent": {
- "email": "string",
- "targetPublicKey": "string",
- "expirationSeconds": "string",
- "emailCustomization": {
- "appName": "string",
- "logoUrl": "string",
- "magicLinkTemplate": "string",
- "templateVariables": "string",
- "templateId": "string"
}
}, - "recoverUserIntent": {
- "authenticator": {
- "authenticatorName": "string",
- "challenge": "string",
- "attestation": {
- "credentialId": "string",
- "clientDataJson": "string",
- "attestationObject": "string",
- "transports": [
- "AUTHENTICATOR_TRANSPORT_BLE"
]
}
}, - "userId": "string"
}, - "setOrganizationFeatureIntent": {
- "name": "FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY",
- "value": "string"
}, - "removeOrganizationFeatureIntent": {
- "name": "FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY"
}, - "signRawPayloadIntentV2": {
- "signWith": "string",
- "payload": "string",
- "encoding": "PAYLOAD_ENCODING_HEXADECIMAL",
- "hashFunction": "HASH_FUNCTION_NO_OP"
}, - "signTransactionIntentV2": {
- "signWith": "string",
- "unsignedTransaction": "string",
- "type": "TRANSACTION_TYPE_ETHEREUM"
}, - "exportPrivateKeyIntent": {
- "privateKeyId": "string",
- "targetPublicKey": "string"
}, - "exportWalletIntent": {
- "walletId": "string",
- "targetPublicKey": "string",
- "language": "MNEMONIC_LANGUAGE_ENGLISH"
}, - "createSubOrganizationIntentV4": {
- "subOrganizationName": "string",
- "rootUser