Note: These instructions are for People Admins. If you do not see these options, please reach out to your district's People or Form Admin.
The User Management API feature allows districts to efficiently manage users in bulk, including tasks like provisioning and deactivation. Utilizing the User Management API feature offers several key benefits:
- Automation: Reduces the need for manual user management, saving time and minimizing errors.
- Consistency: Ensures user information is aligned with systems of record.
- Security: Reduces the risk of unauthorized access by automating account deactivations.
- Scalability: Easily manage a large number of users across different departments or applications.
With the User Management API, you can:
- Create new users
- Activate or deactivate user accounts
- Update user roles (e.g., Form Admin, L1, etc.)
- Modify user details such as first name, last name, and email
- Retrieve information about individual users
- Access a complete list of all users
If you're interested in using the User Management API, please contact your Customer Success Manager or Informed K12 Support to obtain the technical documentation and assistance with setting up this feature.
How to Generate your API Key
To obtain your API key, you will need Form Admin access and will follow these steps:
1. Navigate to your user Account Settings
2. Under API Keys on the left-hand side, select Generate new Key
3. Give your new Key a name and select Generate Key
4. On the next page, copy your key. This is called a Token.
Note: You must save this somewhere. You will not see it again.
5. Click Got it. Your API Key has now been generated and can be referenced here.