@webitel/api-services
    Preparing search index...

    Interface ApiUser

    User profile.

    interface ApiUser {
        chatName?: string;
        contact?: ApiObjectId;
        createdAt?: string;
        createdBy?: ApiUserId;
        deletedAt?: string;
        deletedBy?: ApiUserId;
        device?: ApiObjectId;
        devices?: ApiObjectId[];
        email?: string;
        extension?: string;
        forcePasswordChange?: boolean;
        hotdesks?: ApiObjectId[];
        id?: string;
        license?: ApiLicenseUser[];
        name?: string;
        password?: string;
        permissions?: ApiPermission[];
        presence?: ApiUserPresence;
        profile?: ApiUserProfile;
        roles?: ApiObjectId[];
        totpUrl?: string;
        updatedAt?: string;
        updatedBy?: ApiUserId;
        username?: string;
    }
    Index

    Properties

    chatName? contact? createdAt? createdBy? deletedAt? deletedBy? device? devices? email? extension? forcePasswordChange? hotdesks? id? license? name? password? permissions? presence? profile? roles? totpUrl? updatedAt? updatedBy? username?

    Properties

    chatName?: string

    The "chat_name" field is used to store the name displayed externally on the platform. For example, "chat_name" is shown when an agent connects to chats with clients.

    contact?: ApiObjectId

    [optional] contact connected to this user

    createdAt?: string
    createdBy?: ApiUserId
    deletedAt?: string
    deletedBy?: ApiUserId
    device?: ApiObjectId
    devices?: ApiObjectId[]

    [editable] list of unique regular devices, attached to this user

    email?: string
    extension?: string
    forcePasswordChange?: boolean

    When set to true, the user will be required to change their password on next login.

    hotdesks?: ApiObjectId[]
    id?: string
    license?: ApiLicenseUser[]
    name?: string
    password?: string
    permissions?: ApiPermission[]
    presence?: ApiUserPresence

    string presence = 7; // unique set of presentity status:basic tuples open[ed] string status = 8; // short display status (short description)

    profile?: ApiUserProfile
    roles?: ApiObjectId[]
    totpUrl?: string
    updatedAt?: string
    updatedBy?: ApiUserId
    username?: string

    Settings

    Member Visibility

    On This Page

    Properties