Wisc Account Admin Site - Domain Admin API - Getting Started

Obtaining Credentials

To administer your domain(s) using the Domain Admin API, you must create an App and generate API keys. You can do this by visiting the API Credential Manager.

This self-service tool allows you to create Apps, authorize them for specific domains, and manage their associated API keys. When an API key is generated, it will be displayed only once. Store these credentials securely; they allow full access to your email domain(s). API keys can be set with an expiration or disabled if no longer needed.

Accessing the API

The API endpoint is located at https://email.wisc.edu/domainadmin.json. Authentication is required. You should use HTTP Bearer authentication (e.g., Authorization: Bearer [your_api_key]) with the API key generated for your App. Note: HTTP Basic authentication is deprecated, though previously provided credentials are still supported temporarily.

All actions are called using HTTP POST or GET and will return a JSON response. Each request must include action=[method_name] and the required parameters for that method. You can find up-to-date documentation for the methods, parameters, and return values in the Wisc Account Admin Site. After logging in, select your domain, then choose Domain Admin API from the Domain Administration drop-down menu.

Usage and Support

Fundamental support for the Domain Admin API is limited. The expectation is that the requester should be familiar with leveraging REST or REST-like APIs. If you have questions or feedback about the functionality of the API, please open a case with the DoIT Help Desk.