Class UserService

Create and update Meeco Users.

Hierarchy

Service<UserApi>
- UserService

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new UserService(environment: Environment, log?: Logger): UserService

Inherited from Service<UserApi>.constructor
- Defined in packages/sdk/src/services/service.ts:48
Parameters
- environment: Environment
- log: Logger = ...
Returns UserService

Properties

Protected environment

environment: Environment

Protected keystoreAPIFactory

keystoreAPIFactory: KeystoreAPIFactory

Protected logger

logger: IFullLogger

Protected vaultAPIFactory

vaultAPIFactory: VaultAPIFactory

Readonly vaultKeypairExternalId

vaultKeypairExternalId: string = ...

Static VAULT_PAIR_EXTERNAL_IDENTIFIER

VAULT_PAIR_EXTERNAL_IDENTIFIER: string = 'auth'

Methods

create

create(userPassword: string, secret: string): Promise<AuthData>

- Defined in packages/sdk/src/services/user-service.ts:196
Usernames for secrets can be generated via generateUsername

Parameters
- userPassword: string
- secret: string
Returns Promise<AuthData>

createKeystoreToken

createKeystoreToken(userPassword: string, secret: string): Promise<IKeystoreToken>

- Defined in packages/sdk/src/services/user-service.ts:342
Creates a Keystore token for the user.

Parameters
- userPassword: string
- secret: string
Returns Promise<IKeystoreToken>

deleteSessionTokens

deleteSessionTokens(vault_access_token?: string, keystore_access_token?: string): Promise<void>

- Defined in packages/sdk/src/services/user-service.ts:377
Invalidate all of the provided tokens.

Parameters
- Optional vault_access_token: string
- Optional keystore_access_token: string
Returns Promise<void>

generateUsername

generateUsername(captcha_token?: string): Promise<string>

- Defined in packages/sdk/src/services/user-service.ts:184
Request a new random username from the Keystore API to use for user creation

Parameters
- Optional captcha_token: string
Returns Promise<string>

get

get(userPassword: string, secret: string): Promise<AuthData>

- Defined in packages/sdk/src/services/user-service.ts:303
deprecated

use getAuthData instead.

Parameters
- userPassword: string
- secret: string
Returns Promise<AuthData>

getAPI

getAPI(token: IVaultToken): UserApi

Overrides Service.getAPI
- Defined in packages/sdk/src/services/user-service.ts:20
Parameters
- token: IVaultToken
Returns UserApi

getAuthData

getAuthData(userPassword: string, secret: string): Promise<AuthData>

- Defined in packages/sdk/src/services/user-service.ts:310
Given a user's passphrase and secret - fetch all data required to interact with Meeco's APIs on their behalf such as encryption keys

Parameters
- userPassword: string
- secret: string
Returns Promise<AuthData>

getOrCreateVaultToken

getOrCreateVaultToken(userPassword: string, secret: string): Promise<IVaultToken>

- Defined in packages/sdk/src/services/user-service.ts:353
Create a new Vault session or get the token for an existing session.

Parameters
- userPassword: string
- secret: string
Returns Promise<IVaultToken>

getUser

getUser(credentials: IVaultToken): Promise<MeResponse>

- Defined in packages/sdk/src/services/user-service.ts:370
Parameters
- credentials: IVaultToken
Returns Promise<MeResponse>

setLogger

setLogger(logger: Logger): void

Inherited from Service.setLogger
- Defined in packages/sdk/src/services/service.ts:56
Parameters
- logger: Logger
Returns void

Generated using TypeDoc