Organizations

Required scope: api.orgs

User principal endpoints

Use case

Organizations often need to ensure that only authorized users have access to their systems and data. This API helps IT and security teams streamline that process by providing a comprehensive list of all Zywave user principals associated with their organization’s verified domains.

By comparing this list to their internal corporate user directory, teams can:

• Audit user access across Zywave platforms
• Identify discrepancies or unauthorized accounts
• Maintain compliance with internal security policies and external regulations

This endpoint is especially useful during periodic access reviews, onboarding/offboarding processes, or security audits.

Note: This API only returns user principals linked to verified domains. To retrieve a full list of users with access to your organization’s agencies—including those not tied to a verified domain—please refer to the Agencies API; https://www.zywave.dev/apis/v2-endpoints/agencies/.

Specification