Skip to main content

@dialstack/sdk-dev / server/src / AdminUser

Interface: AdminUser

Defined in: sdk/server/src/index.ts:708

A person who can administer an account in the admin portal.

Admin portal users are a different population from voice Users: they are identified by email and need not have phone service. An account owner usually has none, and so never appears in users.list(). Most voice users, conversely, are not administrators. The two overlap only by email address, which AdminUser.user resolves for you.

Properties​

created_at​

TypeScript
created_at: string;

Defined in: sdk/server/src/index.ts:726

When the role was granted on this account.

email​

TypeScript
email: string;

Defined in: sdk/server/src/index.ts:713

Portal login address, and the only link to a voice user.

id​

TypeScript
id: string;

Defined in: sdk/server/src/index.ts:709

name​

TypeScript
name: string | null;

Defined in: sdk/server/src/index.ts:711

Display name, shared across every account this person administers.

role​

TypeScript
role: "account_admin" | "owner";

Defined in: sdk/server/src/index.ts:718

Role granted on this account. owner is the account's mandatory signer and a superset of account_admin; there is exactly one per account.

user​

TypeScript
user: string | User | null;

Defined in: sdk/server/src/index.ts:724

This person's voice user in this account, or null when they have no phone service. The user's id by default; the full object when expand: ['user'] is requested.

On this page