Class

AdminApis

AdminApis()

Access to various administrative APIs.

Constructor

# new AdminApis()

View Source AdminApis.ts, line 7

Classes

AdminApis

Members

# synapse

Gets access to the Synapse administrative APIs object.

View Source AdminApis.ts, line 15

Methods

# synapse() → {SynapseAdminApis}

Gets access to the Synapse administrative APIs object.

View Source AdminApis.ts, line 44

Returns:

Type: SynapseAdminApis

# whoisUser(userId) → {Promise.<WhoisInfo>}

Gets information about a particular user.

Parameters:

Name	Type	Description
`userId`	`string`	the user ID to lookup

View Source AdminApis.ts, line 52

Returns:

resolves to the whois information

Type: Promise.<WhoisInfo>