Skip to main content

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

Interface: AdminUser

Defined in: sdk/js/src/types/account-onboarding.ts:290

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

This is a different population from OnboardingUsers, not a subset: an administrator need not have phone service (an account owner usually has none, and so never appears in users.list()), and most users are not administrators. The two overlap only by email, which AdminUser.user resolves for you.

Properties​

created_at​

TypeScript
created_at: string;

Defined in: sdk/js/src/types/account-onboarding.ts:308

When the role was granted on this account.

email​

TypeScript
email: string;

Defined in: sdk/js/src/types/account-onboarding.ts:295

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

id​

TypeScript
id: string;

Defined in: sdk/js/src/types/account-onboarding.ts:291

name​

TypeScript
name: string | null;

Defined in: sdk/js/src/types/account-onboarding.ts:293

Display name, shared across every account this person administers.

role​

TypeScript
role: "account_admin" | "owner";

Defined in: sdk/js/src/types/account-onboarding.ts:300

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 | OnboardingUser | null;

Defined in: sdk/js/src/types/account-onboarding.ts:306

This person's 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