Skip to content

Seald: documentation

Main NavigationSDK Desktop App Reference Public website

English

Français

English

Français

Sidebar Navigation

Introduction

Guides

Overview

Adapt your application

First steps

Imports

Identity management

Groups

Encryption Sessions

File encryption

Integrate 2-man-rule on your backend

Egress procedure

Anonymous encryption

JSON Web Tokens

Staging vs. prod servers

React-Native accelerator

Example project

Presentation

Quick-start

Pre-derivation of the password

Persistent database in localStorage

Protection with 2-man-rule

Examples

JavaScript SDK Reference

Seald SDK

Type alias: SDKConstructor

Interface: SealdSDK

Interface: EncryptionSession

Helpers

Type alias: AccountInfo

Type alias: AuthorizeRecipientResult

Type alias: EncryptionSessionCache

Type alias: EncryptionSessionCacheEntry

Type alias: PreGeneratedIdentityKey

Type alias: Recipients

Type alias: RecipientsList

Type alias: RecipientsWithRights

Type alias: RevokeResult

Type alias: SCrypt

Type alias: SSCrypto

Type alias: UserRights

SSKS Password Plugin

Function: default

Interface: SSKSPassword

Helpers

Type alias: KeyStorePassword

SSKS Two-man Rule Plugin

Function: default

Interface: SSKS2MR

Helpers

Type alias: AuthFactor

Type alias: AuthFactorType

Type alias: KeyStore2MR

Anonymous SDK

Type alias: AnonymousSDKConstructor

Interface: AnonymousSDK

Interface: AnonymousEncryptionSession

Helpers

Type alias: SCrypt

React-native-accelerator package

@seald-io/react-native-accelerator

Android SDK Reference (Early Access)

SealdSDK

addConnectorAsync

addConnector

addGroupMembersAsync

addGroupMembers

closeAsync

close

createAccountAsync

createAccount

createEncryptionSessionAsync

createEncryptionSession

createGroupAsync

createGroup

createSubIdentityAsync

createSubIdentity

devicesMissingKeysAsync

devicesMissingKeys

exportIdentityAsync

exportIdentity

getConnectorsFromSealdIdAsync

getConnectorsFromSealdId

getCurrentAccountInfoAsync

getCurrentAccountInfo

getSealdIdsFromConnectorsAsync

getSealdIdsFromConnectors

heartbeatAsync

heartbeat

importIdentityAsync

importIdentity

listConnectorsAsync

listConnectors

massReencryptAsync

massReencrypt

pushJWTAsync

pushJWT

removeConnectorAsync

removeConnector

removeGroupMembersAsync

removeGroupMembers

renewGroupKeyAsync

renewGroupKey

renewKeysAsync

renewKeys

retrieveConnectorAsync

retrieveConnector

retrieveEncryptionSessionAsync

retrieveEncryptionSessionFromBytesAsync

retrieveEncryptionSessionFromBytes

retrieveEncryptionSessionFromFileAsync

retrieveEncryptionSessionFromFile

retrieveEncryptionSessionFromMessageAsync

retrieveEncryptionSessionFromMessage

retrieveEncryptionSession

setGroupAdminsAsync

setGroupAdmins

updateCurrentDeviceAsync

updateCurrentDevice

validateConnectorAsync

validateConnector

EncryptionSession

addRecipientsAsync

addRecipients

decryptFileAsync

decryptFileFromURIAsync

decryptFileFromURI

decryptFile

decryptMessageAsync

decryptMessage

encryptFileAsync

encryptFileFromURIAsync

encryptFileFromURI

encryptFile

encryptMessageAsync

encryptMessage

revokeAllAsync

revokeAll

revokeOthersAsync

revokeOthers

revokeRecipientsAsync

revokeRecipients

sessionId

Helper Classes

AccountInfo

deviceExpires

deviceId

userId

ActionStatus

errorCode

success

AuthFactor

type

value

AuthFactorType

AP

EM

valueOf

value

values

BeardError

code

id

ClearFile

fileContent

filename

sessionId

Connector

id

sealdId

state

type

value

ConnectorState

PENDING

REMOVED

REVOKED

VALIDATED

state

valueOf

values

ConnectorType

AP

EM

type

valueOf

values

ConnectorTypeValue

type

value

CreateSubIdentityResponse

backupKey

deviceId

DeviceMissingKeys

count

deviceId

MassReencryptOptions

forceLocalAccountUpdate

retries

retrieveBatchSize

waitBetweenRetries

waitProvisioningRetries

waitProvisioningTimeMax

waitProvisioningTimeStep

waitProvisioningTime

waitProvisioning

MassReencryptResponse

failed

reencrypted

PreValidationToken

domainValidationKeyId

nonce

token

RetrieveIdentityResponse

authenticatedSessionId

identity

shouldRenewKey

SealdSSKSPasswordPlugin

changeIdentityPasswordAsync

changeIdentityPassword

retrieveIdentityFromPasswordAsync

retrieveIdentityFromPassword

retrieveIdentityFromRawKeysAsync

retrieveIdentityFromRawKeys

saveIdentityFromPasswordAsync

saveIdentityFromPassword

saveIdentityFromRawKeysAsync

saveIdentityFromRawKeys

SealdSSKSTmrPlugin

retrieveIdentityAsync

retrieveIdentity

saveIdentityAsync

saveIdentity

iOS SDK Reference (Early Access)

class SealdSdk

class SealdEncryptionSession

Helper Classes

class SealdAccountInfo

class SealdActionStatus

class SealdAddKeysResponse

class SealdBeardError

class SealdClearFile

class SealdConnector

class SealdConnectorTypeValue

class SealdCreateSubIdentityResponse

class SealdDeviceMissingKeys

class SealdMassReencryptOptions

class SealdMassReencryptResponse

class SealdPreValidationToken

class SealdSsksAuthFactor

class SealdSsksPasswordPlugin

class SealdSsksRetrieveIdentityResponse

class SealdSsksTMRPlugin

Flutter SDK (Early Access)

SSKS Server API Reference

Dashboard API Reference

DashboardAPI Authentication

Seald Dashboard API Reference

On this page

Table of Contents for current page

API

Interfaces

AnonymousEncryptionSession
AnonymousSDK

Type Aliases

AnonymousSDKConstructor
SCrypt

Previous pageType alias: KeyStore2MR

Next pageType alias: AnonymousSDKConstructor

AccountInfo

ActionStatus

AuthFactor

AuthFactorType

BeardError

ClearFile

Connector

ConnectorState

ConnectorType

ConnectorTypeValue

CreateSubIdentityResponse

DeviceMissingKeys

MassReencryptOptions

MassReencryptResponse

PreValidationToken

RetrieveIdentityResponse

SealdSSKSPasswordPlugin

SealdSSKSTmrPlugin

API ​

Interfaces ​

Type Aliases ​

API

Interfaces

Type Aliases