DOCSLIB.ORG

LUXSCI API V2 Account Functions

Total Page：16

File Type：pdf, Size：1020Kb

Download full-text PDF Read full-text
LUXSCI API V2 Account Functions LUXSCI API v2 Account Functions by Erik Kangas, PhD www.luxsci.com Last Updated: , 2021 for LuxSci v2021.2.4 luxsci.com 2 LuxSci API v2: Mechanics TABLE OF CONTENTS OVERVIEW ...................................................... 3 Delete Alias ................................................... 27 Get Aliases Report ......................................... 28 Account API Access Controls ...................... 3 Get Alias Details ............................................ 29 LuxSci Secure Marketing Requests ............ 4 SecureForm Management ........................... 30 User Management Requests......................... 4 Get SecureForm List ...................................... 30 Get User Report ............................................... 5 Get SecureForm ............................................ 33 Delete User ...................................................... 7 Get SecureForm Database Rows.................. 35 Update User Settings..................................... 7 Get SecureForm Database Row ................... 37 Rename User ................................................. 10 Delete SecureForm Database Row ............... 38 Create User .................................................... 11 Get SecureForm Database File ..................... 39 Domain Management Requests ................. 13 Delete SecureForm Database File ................ 40 Create Domain ............................................... 13 SecureSend NameSpace Management ..... 41 Delete Domain ............................................... 14 Create/Update SecureSend User .................. 41 Update Domain .............................................. 15 Change SecureSend User Password ............ 43 Get Domains Report ...................................... 17 Get SecureSend User Single Sign-On Link .. 44 Get Domain Details ........................................ 18 Get SecureSend User List ............................. 45 DKIM Requests ............................................. 19 Reports .......................................................... 46 Create DKIM .................................................. 19 Report Querying and Results: Delete DKIM ................................................... 20 Commonalities ............................................... 47 Get DKIM Report............................................ 20 Report: Email Sent ......................................... 48 Get DKIM Details ........................................... 21 Report: Email Delivery Status ........................ 53 Email Suppression ....................................... 22 Report: Email URL Clicks .............................. 58 Create Suppression ....................................... 22 Report: Email Opens...................................... 62 Delete Suppression ........................................ 23 Report: SMTP Login Failures / Rejections .... 65 Get Suppression ............................................ 23 Report: Email Feed Back Loops .................... 66 Email Alias Management Requests ........... 24 Servers .......................................................... 68 Create Alias .................................................... 24 List of All Servers ........................................... 68 Update Alias ................................................... 26 Servers Status ............................................... 69 luxsci.com LuxSci API v2: Mechanics 3 OVERVIEW The “account” API scope allows your API client to access manage users, domains, email aliases, and other account-level properties. Some user management tasks would be performed using “user” scope (e.g. changing a user’s password); account-scope commands are more administrative and include commands that would not be appropriate for a user to perform him/herself. You can access commands in account scope: • An API Integration whose “scope” is set to “account” (or higher) and where you have enabled access control for the groups of account-level commands that you wish to perform. Note that API credentials with account scope (or higher) do not need additional usernames or passwords to perform commands. You must protect your API keys, as compromised keys will allow others to perform any of the commands permitted to your API Integration. We also recommend that you permit only specific IP addresses to use your API credentials. All account requests have API URLS that start with: /perl/v2/api/account/[ID] where “ID” is the account unique ID number of the account with respect to which the command will apply. Account API Access Controls The account API scope has a number of access controls that govern which commands your API is allowed to perform. None of these commands is enabled by default – so your API can only execute API commands that you have explicitly opted into. This table lists the available account- scope API Access controls. As more commands are added in the future, they will either fall naturally into one of these existing access groups, or new access groups will be added to cover them. Your API Interface should not gain significant additional system access or control when new commands are added to the API in the future; you will need to explicitly opt into use of any new functionality, should you decide that your API client requires it. luxsci.com 4 LuxSci API v2: Mechanics Account-Scope Access Control Notes General “Permit user-level commands without username and password” User Scope This allows your API Integration to perform user-scope commands on allowed users without also supplying their usernames and passwords. “Permit auto-upgrades as needed to fulfill requests” Allows Upgrades the system to automatically upgrade your account, if needed, in order to perform API commands such as “add user”. Permit domain management commands such as get domain Manage Domains details, add domain, delete domain, update domain, manage DKIM. Permit alias management commands such as get alias Manage Aliases reports, add aliases, delete alias. User Add Users Create new users Modify Users Change user settings Enable/Disable/Delete Delete users, disable users, enable users LuxSci Secure Marketing Requests The API calls for LuxSci Secure Marketing are at the account scope. However, there are so many of them, that we have placed their documentation into a separate API Guide. See the document “LuxSci Marketer API Functions” for their definitions. User Management Requests All user-management API requests use URLs of the form: /perl/api/v2/account/[account id]/users/[username]... where “username” is the login email address of the user in question. This “username” can also be just the unique numerical ID of the user. luxsci.com LuxSci API v2: Mechanics 5 Get User Report Return an array of information about all users matching your query request. Request Method GET Access Required User Settings: Read access Request URL /perl/api/v2/account/[account id]/users Request Query String See below Request Body none Success Response See below Request Query String The Request query string can contain any or all of the following keywords parameters to refine the search. If all are omitted, the report will include information about all users in the account. In all cases, any users protected from API access will not be included in the report. Keyword Data Type Description status Enum Value ‘enabled’ – return only active/enabled users. Value ‘disabled’ – return only disabled users. domain String Domain name in your account. If supplied, only users in this domain will be returned. younger_than Integer Return only users created less than this number of days ago. older_than Integer Return only users created more than this number of days ago. JSON Response The successful response will be an array of objects, one for each matching user in your account. Each user object returned will have the following keywords / values: Keyword Value city City company Company / organization contact Full name. E.g. “John Smith” country Country created Date and time this user was created (YYYY-MM-DD HH:MM:SS in GMT) luxsci.com 6 LuxSci API v2: Mechanics Keyword Value custom1 Custom field #1 custom2 Custom field #2 custom3 Custom field #3 disk_quota Floating point limit on the user’s total disk space usage. In gigabytes (1 GB = 1000 MB). A value of “-1” signifies that the user does not have a disk usage limit. disk_usage Floating point value for the user’s current (last measured) total disk space usage. In gigabytes (1 GB = 1000 MB) email1 Primary email address email2 Alternate email address fax FAX number flags Array. Lists which of the following flags, if any, are set on this user: • poor_password – User must change his/her password on the next login to the Web Interface • can_autodelete – User account can be auto-deleted if the user has not logged in in a long time uid Unique user ID (integer). last_access_ Date Time the user last logged into any of WebMail, POP, IMAP, or SMTP (not date updated real time). If the user has never logged in, this should be the same as the “created” date time. (YYYY-MM-DD HH:MM:SS in GMT) modified Date and time this user was last modfiied (YYYY-MM-DD HH:MM:SS in GMT) phone1 Primary contact phone number phone2 Alternate contact phone number services Array. Lists which of the following services the user has permission to use: • pop – POP3 access to email • imap – IMAP4 access to email • smtp – SMTP for sending email • spam – Basic Spam and Virus Filtering • ftp – FTP and/or SFTP access • website – permission to login to the Web Interface state State/Province
Load more

Recommended publications
  • Handling Unwanted Email What Are the Main Sources of Junk Email?
    Handling unwanted email Almost entirely based on a presentation by Brian Candler What are the main sources of junk email? · Spam Unsolicited, bulk email Often fraudulent ± penis enlargement, lottery scams, close relatives of African presidents, etc. Low response rate => high volume sent · Viruses, Trojan horses Infected machine sends out mails without the owner 's knowledge · Malicious bounces These are called ªcollateral spamº or ªJoe-jobsº Junk mail is sent with forged MAIL FROM Accepted by some intermediate MTA, but later it bounces Bounces go to innocent third party 1 What are the costs? · Important messages can be accidentally discarded The more junk, the higher the risk · Wasted time Deleting junk Setting up and maintaining ®lters Checking discarded mail for false positives · Wasted bandwidth and disk space Especially for users on modems Viruses and spam attachments can be large · Annoyance, offence, even fraud There are no easy answers! 2 Where can you ®lter? · At the end-user hosts ✓ Each client has full control and customization ✓ Distributes the processing cost ✗ Client must still download each message · On the ISP's mail server ✓ Easier for users ✓ Sometimes can be rejected before receiving the body ✓ Saves disk space on the server ✗ Hard to make ¯exible for users to customize The Joe-job problem · Don't accept a message and then bounce it later If its sender is forged, we are creating a Joe-job · Much better to reject at RCPT TO or DATA stages A real MTA sender will create a bounce Spamware will ignore the rejection · For
    [Show full text]
  • Set up Mail Server Documentation 1.0
    Set Up Mail Server Documentation 1.0 Nosy 2014 01 23 Contents 1 1 1.1......................................................1 1.2......................................................2 2 11 3 13 3.1...................................................... 13 3.2...................................................... 13 3.3...................................................... 13 4 15 5 17 5.1...................................................... 17 5.2...................................................... 17 5.3...................................................... 17 5.4...................................................... 18 6 19 6.1...................................................... 19 6.2...................................................... 28 6.3...................................................... 32 6.4 Webmail................................................. 36 6.5...................................................... 37 6.6...................................................... 38 7 39 7.1...................................................... 39 7.2 SQL.................................................... 41 8 43 8.1...................................................... 43 8.2 strategy.................................................. 43 8.3...................................................... 44 8.4...................................................... 45 8.5...................................................... 45 8.6 Telnet................................................... 46 8.7 Can postfix receive?..........................................
    [Show full text]
  • Glossary Updated – July 2014
    Glossary Updated – July 2014 Ad Blocker - A software utility which can be either a browser add-on or integrated within a browser which prevents advertisements from being displayed or third party content from being served. Examples include Adblock Plus and Noscript. Leading browsers offer limited controls to block third party content including Microsoft Internet Explorer 9 and Mozilla Firefox. Address Specification (also known as: email address spec or addr-spec) - Addresses occur in several message header fields to indicate senders and recipients of messages. An address may either be an individual mailbox, or a group of mailboxes. [RFC 2822] Ad Exchange - Ad exchanges facilitate auction-based, real-time buying and serving of ads. Ad exchanges operate by serving as intermediaries between ad networks, publishers, and advertisers. Ad exchanges provide a sales channel to publishers and ad networks, as well as aggregated inventory to advertisers. Ad exchanges’ business models and practices may include features that are similar to those offered by ad networks. Ad Impression (or impressions) -Total number of times an ad (or malvertisement) is served on one or more sites. A single malvertising creative may be served to multiple users as a result of a single incident with upwards to 100,000 or more impressions, depending on the site(s) the malvertising is served on and the frequency of rotation of the ad on the site(s) and the life of the campaign. Ad Network - An ad network is a company that works with a group of Web sites and sells advertising space on their behalf. Ad networks provide an outsourced sales capability for publishers and a means to aggregate inventory and audiences from numerous sources in a single buying opportunity for media buyers.
    [Show full text]
  • PERSONAL EMAIL MANAGER USER HELP Websense® Email Security Gateway
    PERSONAL EMAIL MANAGER USER HELP Websense® Email Security Gateway v7.8.x ©2014 Websense Inc. All rights reserved. 10240 Sorrento Valley Rd., San Diego, CA 92121, USA R051478x Published May 2014 Printed in the United States of America and Ireland. The products and/or methods of use described in this document are covered by U.S. Patent Numbers 6,606,659 and 6,947,985 and other patents pending. This document may not, in whole or in part, be copied, photocopied, reproduced, translated, or reduced to any electronic medium or machine-readable form without prior consent in writing from Websense Inc. Every effort has been made to ensure the accuracy of this manual. However, Websense Inc., makes no warranties with respect to this documentation and disclaims any implied warranties of merchantability and fitness for a particular purpose. Websense Inc. shall not be liable for any error or for incidental or consequential damages in connection with the furnishing, performance, or use of this manual or the examples herein. The information in this documentation is subject to change without notice. Trademarks Websense, the Websense Logo, Threatseeker and the YES! Logo are registered trademarks of Websense, Inc. in the United States and/or other countries. Websense has numerous other unregistered trademarks in the United States and internationally. All other trademarks are the property of their respective owners. Contents Topic 1 Overview . 1 What is Personal Email Manager? . 1 Personal Email Manager Help overview . 2 Topic 2 Working with Notification Messages . 5 Notification message format. 5 Notification message actions . 5 Not Spam. 6 Deliver.
    [Show full text]
  • Auditing an Email Server Patrick Mattson May 2019
    Auditing an Email server Patrick Mattson May 2019 [email protected] Page 1 of 34 Table of Contents Proposal notes ........................................................................................................................................ 4 Learning objective 1 ................................................................................................................................ 6 Learning objective 2 ................................................................................................................................ 6 Learning objective 3 ................................................................................................................................ 6 Learning objective 4 ................................................................................................................................ 6 What are the components of an email server. ......................................................................................... 6 Microsoft Exchange Components ........................................................................................................ 7 Edge Transport - Mail Transfer Agent (MTA) ................................................................................... 7 Other components: ............................................................................................................................. 7 DNS Settings .................................................................................................................................... 7
    [Show full text]
  • Enotification – Louisiana Presentation
    eNotification Brad Harris Louisiana Survey results Louisiana lessons learned Louisiana plans Literature What’s next? Survey results Email sent Always Yes (if on file or No subscription exists) Renewal notice 1 7 9 Involuntary cancel 3* 14 1 with paper too Change notice 3* 14 1 address change only Online status 5 12 deliverables 4 3 12 Paper status 3 14 deliverables 3 14 Data subscriptions 3 3 11 Web changed 3 14 Other 1 1 Survey results Email Contents Attachment Hyperlink Text only N/A Renewal notice 1* 6 1 service companies only Involuntary 1 2 cancel Change notice 3 Online status 3 2 deliverables 1 4 1 Paper status 1 2 deliverables 2 1 Data 2 2 1 1 subscriptions Web changed 1 1 Other 1 1 Survey results Email process Automatic Manual Batch N/A Renewal notice 2 5 1 Involuntary 2 1 cancel Change notice 1 2 Online status 4 deliverables 5 1 Paper status 1 2 deliverables 3 Data 1 4 1 subscriptions Web changed 1 1 1 Other 2 Survey results Emailed from monitored box Yes No N/A Renewal notice 2 4 2 Involuntary cancel 3 Change notice 1 2 Online status 2 3 deliverables 3 3 Paper status 1 1 deliverables 2 1 Data subscriptions 3 2 Web changed 3 Other 1 1 Survey Results Yes By law No N/A Protected from 6 5 3 4 public requests Correction Cancel Nothing N/A attempted subscription Ifbounces 4 1 6 5 Yes No N/A Can resend 12 5 Can forward 8 1 8 Survey results Subscriptions Yes No N/A self sign-up 5 2 10 opt out 5 1 11 unsubscribe multiple 1 2 14 verify signup 1 4 12 update themselves 1 4 12 SPAM Sender Policy Framework record in DNS Notify customers to
    [Show full text]
  • Trust in Email Begins with Authentication
    Trust in Email Begins with Authentication Issued by the Messaging Anti-Abuse Working Group (MAAWG) March 2008 Edited by Dave Crocker Brandenburg InternetWorking Abstract The Internet’s growth allows us to interact with people all over the world. Unfortunately, some of those people do not make good neighbors. Along with the effort to detect and filter the problematic traffic they generate, there is a complementary effort to identify trustworthy participants. In security technology parlance, the first seeks to identify Bad Actors whereas the second creates ways of distinguishing Good Actors. At its simplest, identifying Good Actors can be divided into two activities: A safe means of identifying a participant–such as an author or an operator of an email service–and then a useful means of assessing their trustworthiness. The first activity is called authentication and the second is usually called reputation. This white paper considers the first step: authenticating the identity that asserts responsibility for an email. In it, recent developments in standardized authentication mechanisms are reviewed that have been tailored for use in email anti- abuse efforts. This white paper provides background on authentication as a foundation for understanding current efforts to protect Internet mail. It then looks at the most popular mechanisms currently in use. The paper is intended for a general readership that has basic familiarity with Internet mail service. While this single document is unlikely to be the final word on the topic, MAAWG has striven to capture the current best practices and leading theories regarding email authentication. As a complement to enabling identification of Good Actors, authentication is expected to aid efforts in protecting business’ brands from forgery and phishing attacks.
    [Show full text]
  • Online Identifiers in Everyday Life
    © 2010 by Benjamin M. Gross. All rights reserved. ONLINE IDENTIFIERS IN EVERYDAY LIFE BY BENJAMIN M. GROSS DISSERTATION Submied in partial fulfillment of the requirements for the degree of Doctor of Philosophy in Library and Information Science in the Graduate College of the University of Illinois at Urbana-Champaign, 2010 Urbana, Illinois Doctoral Commiee: Associate Professor Michael Twidale, Chair Professor Geof Bowker, University of Pisburgh Professor Chip Bruce Associate Professor Ann Bishop Abstract Identifiers are an essential component of online communication. Email addresses and instant messenger usernames are two of the most common online identi- fiers. is dissertation focuses on the ways that social, technical and policy fac- tors affect individual’s behavior with online identifiers. Research for this dissertation was completed in two parts, an interview-based study drawn from two populations and an examination of the infrastructure for managing identifiers in two large consumer services. e exploratory study ex- amines how individuals use online identifiers to segment and integrate aspects of their lives. e first population is drawn from employees of a financial ser- vice firm with substantial constraints on communication in the workplace. e second population is drawn from a design firm with minimal constraints on com- munication. e two populations provide the opportunity to explore the social, technical, and policy issues that arise from diverse communication needs, uses, strategies, and technologies. e examination of systems focuses on the infras- tructure that Google and Yahoo! provide for individuals to manage their iden- tifiers across multiple services, and the risks and benefits of employing single sign-on systems.
    [Show full text]
  • DMARC Architecture - Identifier Alignment
    DMARC Architecture - Identifier Alignment Contents Introduction Terminology DMARC - Identifier Alignment Identifiers Identifier Alignment DKIM Alignment SPF Alignment Alignment Mode Tags Reference Introduction This document describes general Domain-based Message Authentication, Reporting and Conformance (DMARC) architecture concepts, along with Sender Policy Framework (SPF) and DomainKeys Identified Mail (DKIM) alignment requirements in relation to DMARC. Terminology This section describes and provides definition to some of the key terms used within this document. ● EHLO/HELO - The commands that supply the identity of an SMTP client during the initialization of an SMTP session as defined in RFC 5321. ● From header - The From: field specifies the author(s) of a message. It will typically include the display name (what is shown to an end-user by the mail client), along with an email address that contains a local-part and domain name (For example, "John Doe" <[email protected]>) as defined in RFC 5322. ● MAIL FROM - This is derived from the MAIL command at the start of an SMTP session and provides the sender identification as defined in RFC5321. It is also widely known as the envelope sender, return-path or bounce address. DMARC - Identifier Alignment DMARC ties what DKIM and SPF authenticate to what is listed in the From header. This is done by alignment. Alignment requires that the domain identity authenticated by SPF and DKIM match the domain in the email address visible to the end user. Let's start with what an identifier is and why they are important in reference to DMARC. Identifiers Identifiers identify a domain name to be authenticated.
    [Show full text]
  • Socketlabs Best Practices Guidelines for Authentication Table of Contents
    SocketLabs Best Practices Guidelines for Authentication Table of Contents I. Introduction 1 II. Authentication at SocketLabs: An Overview 2 III. Understanding Settings and Customization 3 IV. Customizing Your Settings 8 V. Summary of Recommended DNS Records 14 VI. Key Authentication Terms 15 I. Introduction Due to a steady global increase in malicious email tactics. like phishing, spoofing, and forgery, mailbox providers must be very careful about which messages they allow to be delivered. That’s why it is incredibly important for every legitimate email sender to follow the best practices to make their messages clearly identifiable as trustworthy in the eyes of mailbox providers. One of the critical foundational steps when using an email service like SocketLabs is establishing aligned and white-labeled message authentication mechanisms. These measures help demonstrate that your messages are authentic and help facilitate strong inbox placement. Over time, your organization will see improved email performance as you build a trusted sender reputation that further increases the consistency with which your messages are accepted and delivered to the recipient’s inbox. The purpose of this document is to help educate SocketLabs customers about the topic of email authentication and to help explain the important configuration options that you should choose to maximize success. The goal is to help you choose the best path to garner trust, build domain reputation, and help optimize message delivery results. This document is based off of established industry best practices from M3AAWG – the Messaging, Mobile, Malware Anti-Abuse Working Group. As a member of M3AAWG, SocketLabs is proud to contribute to these documents.
    [Show full text]
  • Email Authentication Via Domainkeys Identified Mail (DKIM)
    IronPort Email Authentication W H I T E P A P ER Executive Summary The problems of spam, viruses, phishing and most email denial-of-service attacks can all be traced back to a single common cause – lack of authentication in the email protocol SMTP. TABLE OF CONTENTS 1 Executive Summary This lack of authentication means that a receiving mail server cannot reliably 2 Definitions verify that a particular message is in fact from the sender it purports to be from, making it harder to identify friend from foe. 2 History 3 The Authentication Problem The industry has recognized this shortcoming, and a great deal of effort 4 Sender ID and DomainKeys has been put into developing a new standard that will “overlay” SMTP Identified Mail and provide the sender authentication that is so desperately needed. This 9 Adoption Status paper will present a brief history of how this problem evolved, explore the pluses and minuses of the leading standards proposals, and highlight some 10 Why Authenticate? recommendations. 11 The Solution To Bounce Attacks 11 IronPort Systems’ Adoption Recommendations 12 Appendix D O C R E V 0 2 . 0 8 1 IRONPORT EMAIL AUTHENTICATION WHITE PAPER DEFINITIONS Email nomenclature can be a bit confusing, so it is useful to start with some definitions. An email message has an addressing scheme similar to a postal message: HELO/EHLO: The initial contact command between a sending and a receiving mail server, indicating an SMTP conversation. Envelope sender: The address of the sending mail server; not exposed to the end-user, used for managing bounces.
    [Show full text]
  • Sender Authentication
    Barracuda Email Security Gateway Sender Authentication https://campus.barracuda.com/doc/3866643/ This is a key feature of the Barracuda Email Security Gateway for protecting your network and users from spammers who might spoof a domain or otherwise hide the identity of the true sender. The following techniques are used to verify the "from" address of a message. Mail Protocol (SMTP) Checking The Barracuda Email Security Gateway can perform thorough checks on incoming email for RFC 821 compliance, require mail clients to introduce themselves with an SMTP "HELO" or "EHLO" command before stating a sender, and otherwise manage SMTP protocol to block spammers. See the ADVANCED > Email Protocol page for these and other optional SMTP settings. Sender Spoof Protection The Barracuda Email Security Gateway has the option to prevent spoofing of an organization’s own domain by blocking emails with that domain name in the "From" field that are sent from outside the organization. Note that sender spoof protection should not be enabled if the organization sends messages from outside their internal email infrastructure (e.g., in the case of marketing bulk-mail services). The Sender Spoof Protection feature can be configured at the global level from the ADVANCED > Email Protocol page or at the per-domain level on the DOMAINS > Manage Domain > ADVANCED > Email Protocol page. At the domain level, however, this feature is labeled as Reject messages from my domain. Note that if the administrator enables Sender Spoof Protection at the global level, it will supersede any Allow List entry created at the per-user level by a User, Helpdesk or Domain Admin account holder.
    [Show full text]