User management API
Zenya can operate stand-alone and features a fully functional user management, where users and user groups can be created manually. In most cases, organizations choose to connect Zenya to their existing identity management solution, like (Azure) Active Directory.
Users and user groups are provisioned from (Azure) Active Directory to Zenya (one-way sync). Provisioning can be done via the SCIM-protocol, or using a sync tool provided by Infoland.
API’s for user management are available, independent of the Zenya modules which are licensed.
The API allows CRUD (Create Read Update Delete) operations on users and user groups.
When an organization has its Zenya connected to (Azure) Active Directory, there usually is no need to interact with the Zenya user management API. In cases where no (Azure) Active Directory or other identity management solution is present, the user management API can sometimes be used to establish a synchronization of users and groups with another kind of directory.
The REST API for user nanagement can be used to accomplish the scenario’s listed below:
- Retrieving information about existing user accounts and user groups
- Creating users and user groups
- Performing certain operations on existing users and user groups
- Checking the strength of a password (to prevent that creating a user or changing a users password via the API fails because the password does not meet the requirements set in Zenya)
General API usage information
Overview of important information for consumers of the Zenya REST API, with topics like authentication.
Overview of changes and announced deprecations regarding this API.
Our code samples on GitHub show you how to get started with the Zenya REST API.
A detailed reference for this API is provided in Swagger format.
Please note that the Swagger reference is also present in each customer’s Zenya tenant. You can find it by adding /api to the URL of the customer’s Zenya tenant. For example: https://organisation.zenya.work/api
In order to interact with the Swagger reference, you need to access the Swagger in the customer’s Zenya, and you need valid credentials for the customer’s Zenya.