Skip to content

Seald: documentation

Main NavigationSDK Desktop App Reference Public website

English

English

Sidebar Navigation

Introduction

Guides

Overview

Adapt your application

First steps

Imports

Identity management

Groups

Encryption Sessions

Proxy Sessions

TMR Accesses

File encryption

Integrate 2-man-rule on your backend

Egress procedure

Anonymous encryption

SymEncKeys

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: AddMultipleTmrAccessesResult

Type alias: AuthorizeRecipientResult

Type alias: EncryptionSessionCache

Type alias: EncryptionSessionCacheEntry

Type alias: EncryptionSessionRetrievalDetails

Type alias: PreGeneratedIdentityKey

Type alias: Recipients

Type alias: RecipientsList

Type alias: RecipientsWithRights

Type alias: RevokeResult

Type alias: SCrypt

Type alias: SDKConstructor

Type alias: SSCrypto

Type alias: TmrAuthFactor

Type alias: TmrAuthFactorType

Type alias: TmrRecipientWithRights

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: KeyStore2MR

Anonymous SDK

Type alias: AnonymousSDKConstructor

Interface: AnonymousSDK

Interface: AnonymousEncryptionSession

Helpers

Type alias: AnonymousSDKConstructor

Type alias: SCrypt

React-native-accelerator package

@seald-io/react-native-accelerator

Android SDK Reference (Early Access)

SealdSDK

SealdSDK

addConnectorAsync

addConnector

addGroupMembersAsync

addGroupMembers

checkSigchainHashAsync

checkSigchainHash

closeAsync

close

convertTmrAccessesAsync

convertTmrAccesses

createAccountAsync

createAccount

createEncryptionSessionAsync

createEncryptionSession

createGroupAsync

createGroup

createSubIdentityAsync

createSubIdentity

devicesMissingKeysAsync

devicesMissingKeys

exportIdentityAsync

exportIdentity

getConnectorsFromSealdIdAsync

getConnectorsFromSealdId

getCurrentAccountInfoAsync

getCurrentAccountInfo

getSealdIdsFromConnectorsAsync

getSealdIdsFromConnectors

getSigchainHashAsync

getSigchainHash

heartbeatAsync

heartbeat

importIdentityAsync

importIdentity

listConnectorsAsync

listConnectors

massReencryptAsync

massReencrypt

pushJWTAsync

pushJWT

removeConnectorAsync

removeConnector

removeGroupMembersAsync

removeGroupMembers

renewGroupKeyAsync

renewGroupKey

renewKeysAsync

renewKeys

retrieveConnectorAsync

retrieveConnector

retrieveEncryptionSessionAsync

retrieveEncryptionSessionByTmrAsync

retrieveEncryptionSessionByTmr

retrieveEncryptionSessionFromBytesAsync

retrieveEncryptionSessionFromBytes

retrieveEncryptionSessionFromFileAsync

retrieveEncryptionSessionFromFile

retrieveEncryptionSessionFromMessageAsync

retrieveEncryptionSessionFromMessage

retrieveEncryptionSession

setGroupAdminsAsync

setGroupAdmins

updateCurrentDeviceAsync

updateCurrentDevice

validateConnectorAsync

validateConnector

EncryptionSession

EncryptionSession

addProxySessionAsync

addProxySession

addRecipientsAsync

addRecipients

addTmrAccessAsync

addTmrAccess

decryptFileAsync

decryptFileFromURIAsync

decryptFileFromURI

decryptFile

decryptMessageAsync

decryptMessage

encryptFileAsync

encryptFileFromURIAsync

encryptFileFromURI

encryptFile

encryptMessageAsync

encryptMessage

retrievalDetails

revokeAllAsync

revokeAll

revokeOthersAsync

revokeOthers

revokeRecipientsAsync

revokeRecipients

sessionId

Helper Classes

AccountInfo

AccountInfo

deviceExpires

deviceId

userId

ActionStatus

ActionStatus

errorCode

success

AuthFactor

AuthFactor

type

value

AuthFactorType

AP

EM

valueOf

value

values

BeardError

BeardError

code

id

CheckSigchainResponse

CheckSigchainResponse

found

lastPosition

position

ClearFile

ClearFile

fileContent

filename

sessionId

Connector

Connector

id

sealdId

state

type

value

ConnectorState

PENDING

REMOVED

REVOKED

VALIDATED

state

valueOf

values

ConnectorType

AP

EM

type

valueOf

values

ConnectorTypeValue

ConnectorTypeValue

type

value

ConvertTmrAccessesResponse

ConvertTmrAccessesResponse

converted

errored

status

succeeded

CreateSubIdentityResponse

CreateSubIdentityResponse

backupKey

deviceId

DeviceMissingKeys

DeviceMissingKeys

deviceId

EncryptionSessionRetrievalDetails

EncryptionSessionRetrievalDetails

flow

fromCache

groupId

proxySessionId

EncryptionSessionRetrievalFlow

CREATED

DIRECT

VIA_GROUP

VIA_PROXY

VIA_TMR_ACCESS

valueOf

value

values

GetFactorTokenResponse

GetFactorTokenResponse

authenticatedSessionId

token

GetSigchainResponse

GetSigchainResponse

position

sigchainHash

MassReencryptOptions

MassReencryptOptions

forceLocalAccountUpdate

retries

retrieveBatchSize

waitBetweenRetries

waitProvisioningRetries

waitProvisioningTimeMax

waitProvisioningTimeStep

waitProvisioningTime

waitProvisioning

MassReencryptResponse

MassReencryptResponse

failed

reencrypted

PreValidationToken

PreValidationToken

domainValidationKeyId

nonce

token

RecipientRights

RecipientRights

forward

read

revoke

RecipientWithRights

RecipientWithRights

recipientId

rights

RetrieveIdentityResponse

RetrieveIdentityResponse

authenticatedSessionId

identity

shouldRenewKey

RevokeResult

RevokeResult

proxySessions

recipients

SealdException

SealdException

code

description

details

id

message

nativeStack

raw

status

toString

SealdSSKSPasswordPlugin

SealdSSKSPasswordPlugin

changeIdentityPasswordAsync

changeIdentityPassword

retrieveIdentityFromPasswordAsync

retrieveIdentityFromPassword

retrieveIdentityFromRawKeysAsync

retrieveIdentityFromRawKeys

saveIdentityFromPasswordAsync

saveIdentityFromPassword

saveIdentityFromRawKeysAsync

saveIdentityFromRawKeys

SealdSSKSTmrPlugin

SealdSSKSTmrPlugin

getFactorTokenAsync

getFactorToken

retrieveIdentityAsync

retrieveIdentity

saveIdentityAsync

saveIdentity

TMRAccessesConvertFilters

TMRAccessesConvertFilters

createdById

sessionId

tmrAccessId

TMRAccessesRetrievalFilters

TMRAccessesRetrievalFilters

createdById

tmrAccessId

TmrRecipientWithRights

TmrRecipientWithRights

authFactor

overEncryptionKey

rights

parseSessionIdFromBytes

parseSessionIdFromFile

parseSessionIdFromMessage

iOS SDK Reference (Early Access)

class SealdSdk

class SealdEncryptionSession

Helper Classes

class SealdAccountInfo

class SealdActionStatus

class SealdAddKeysResponse

class SealdBeardError

class SealdCheckSigchainResponse

class SealdClearFile

class SealdConnector

class SealdConnectorTypeValue

class SealdConvertTmrAccessesResult

class SealdCreateSubIdentityResponse

class SealdDeviceMissingKeys

class SealdEncryptionSessionRetrievalDetails

class SealdGetSigchainResponse

class SealdMassReencryptOptions

class SealdMassReencryptResponse

class SealdPreValidationToken

class SealdRecipientRights

class SealdRecipientWithRights

class SealdRevokeResult

class SealdSsksGetFactorTokenResponse

class SealdSsksPasswordPlugin

class SealdSsksRetrieveIdentityResponse

class SealdSsksTMRPlugin

class SealdTmrAccessesConvertFilters

class SealdTmrAccessesRetrievalFilters

class SealdTmrAuthFactor

class SealdTmrRecipientWithRights

class SealdUtils

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

CREATED

The session was created locally.

Properties

Name	Summary
name	val name: String
ordinal	val ordinal: Int
value	val value: Int

Previous pageEncryptionSessionRetrievalFlow

Next pageDIRECT