Convergence JavaScript Client API Documentation 1.0.0-rc.12
Dev Guide
Options
Menu

Module Users and Identity

This subsystem provides a suite of utilities for looking up users and groups in the current domain.

See some common use cases in the developer guide.

Index

Type aliases

Enumerations

Classes

Interfaces

Type aliases

DomainUserIdentifier

DomainUserIdentifier: string | DomainUserId

A string representing the username of a "normal" user or DomainUserId.

DomainUserMapping

DomainUserMapping<T>: StringMapLike<T> | Map<DomainUserIdentifier, T> | DomainUserIdMap<T>

The DomainUserMapping type defines the union type for the multiple ways a domain user might be mapped to a value.

Type parameters

  • T

UserField

UserField: "username" | "email" | "firstName" | "lastName" | "displayName"

The fields of a user that are available to be queried on. See search