# Interface: SSKS2MR
# Table of contents
# Properties
# Methods
# Properties
# keyStorageURL
• keyStorageURL: string
keyStorageURL with which this plugin instance was created. URL of the SSKS Identity Key Storage to which it should connect.
# keyStore
• keyStore: KeyStore2MR
Manual SSKS Identity Key Storage interface. For advanced use.
# Methods
# retrieveIdentity
▸ retrieveIdentity(args): Promise<void>
Retrieve the Seald account previously created with initiateIdentity.
If the identity has been stored without no challenge, the first time the identity is retrieved afterwards, the
keys of the identity in question are automatically renewed and stored again onto SSKS. If the same identity is also
stored elsewhere (for example with @seald-io/sdk-plugin-localstorage), you will have to save it again.
# Parameters
| Name | Type | Description |
|---|---|---|
args | Object | |
args.authFactor? | AuthFactor | Authentication method of this user, to which SSKS has sent a challenge at the request of your app's server. |
args.challenge | string | Challenge sent by SSKS to the user's authentication method. |
args.email? | string | Deprecated: Email of this user, to which SSKS has sent a challenge email at the request of your app's server. |
args.sessionId | string | Session ID given by SSKS to your app's server. |
args.twoManRuleKey | string | Secret stored by your app's server for securing this user's identity. |
args.userId | string | The unique ID of the current user inside your app. It will be used to identify this user. |
# Returns
Promise<void>
# saveIdentity
▸ saveIdentity(args): Promise<void>
Save the Seald account to SSKS.
# Parameters
| Name | Type | Description |
|---|---|---|
args | Object | |
args.authFactor? | AuthFactor | Authentication method of this user, to which SSKS has sent a challenge at the request of your app's server. |
args.challenge? | string | Optional. If the server responded with must_authenticate to true, this is the challenge sent by SSKS to the user's authentication method. |
args.email? | string | Deprecated: Email of this user, to which SSKS has sent a challenge email at the request of your app's server. |
args.identity? | Buffer | Optional, the identity to save. If no identity is given, current one is saved. |
args.sessionId | string | Session ID given by SSKS to your app's server. |
args.twoManRuleKey | string | Secret stored by your app's server for securing this user's identity. |
args.userId | string | The unique ID of the current user inside your app. It will be used to identify this user. |
# Returns
Promise<void>