ppeclient -- a Python client for the Proofpoint Essentials Interface API v1

Proofpoint Essentials Interface API v1 describes a REST interface to manage Proofpoint Essentials email endpoints. Proofpoint also provides an OpenAPI 3.0.0 description of the interface.

ppeclient is Python client that is generated from the OpenAPI description by a prebuilt swagger-codegen-cli v3. Which is part of the Swagger Open Source project.

Note:

At this time, 9 May 2023, the OpenAPI_ description of the interface from Proofpoint is buggy. It has some incorrect data types, and some incorrect return value descriptions. Use at your own risk.

Building

To build ppeclient, a UNIX-style build enviroment is needed along with a Java application runner (called java). Then run:

make client

That will create the client subdirectory with all of Python source code. Next, switch to the client subdirectory and run:

python setup.py install

To install the ppeclient package.

Example Use

from ppeclient import Configuration, ApiClient, UsersApi

USERNAME = 'user@example.com'
PASSWORD = 'password'
DOMAIN = 'example.com'

config = Configuration()
# Choose appropriate endpoint for your domain
config.host = "https://us1.proofpointessentials.com/api/v1"
client = ApiClient(config)
api = UsersApi(client)

print(api.get_user(USERNAME, PASSWORD, DOMAIN, 'user2@example.com'))