Memco

Interface ExternalUser

A user of yours that Memco knows by your own id for them.

An external user has no sign-in of its own. It acts through API keys, or through a session opened on its behalf with MemoryOperations.startSession's externalId.

interface ExternalUser {
    id: string;
    externalId: string;
    name: string;
    email: string;
    roles: readonly string[];
    active: boolean;
}
Index
id: string

Memco's own handle for the user: what NetworkOperations.addMember takes.

externalId: string

Your identifier for the user, unique within your organization. It is what every UserOperations method takes.

name: string

The user's name. Empty when none was given.

email: string

The user's email address. Empty when none was given.

roles: readonly string[]

The content roles the user holds, from reader, creator and auditor.

active: boolean

Whether the user is active.

On this page