Stay organized with collections
Save and categorize content based on your preferences.
Bulk User Management API lets you use the contents of a json file
to create or modify several users in one operation.
There is no limit to the number of records that can be uploaded, but it
is recommended that requests are performed in smaller batches.
This process can also be performed in the CCAI Platform portal by following the
instructions in the Bulk user management.
Roles and permissions
Use the Apps API by creating an api_user.
The api_user does not have roles and permissions, so all api_users
can perform bulk_user management.
You cannot set granular permissions when utilizing api_user, so the
api_user will have access to all user fields.
Add an API credential
In the CCAI Platform portal, go to Settings > Developer Settings > API
Credential management.
Click + Add API Credential. An Add API Credential
message will open.
Enter a Name for the credential.
Click Create.
Use the bulk user management API
Using the bulk user Mmanagement API requires two API calls. One uploads the JSON
file and creates the job, and the other processes it. You can also use optional
API calls to help ensure that your job is processed correctly.
Optional: Retrieve the json template. This retrieves the latest template,
which includes any additional roles or teams that were created since you retrieved the
previous template. Google recommends this step.
Optional: Get user configuration data. This retrieves
a list of all users (or a single user, if you specify an email address) to mirror.
Upload the json file. You can add or update one or multiple users in
the file. Make sure to note the job ID.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-20 UTC."],[[["\u003cp\u003eThe Bulk User Management API allows for the creation or modification of multiple users simultaneously using a JSON file, though smaller batches are recommended.\u003c/p\u003e\n"],["\u003cp\u003eAPI users created via the Apps API can utilize the Bulk User Management feature without specific roles or permissions, granting them access to all user fields.\u003c/p\u003e\n"],["\u003cp\u003eThe Bulk User Management API process is a two-step process: first, upload a JSON file using either POST or PUT method, and second, request the processing of that file via POST.\u003c/p\u003e\n"],["\u003cp\u003eYou can retrieve a JSON template, check the status of a job, and get a list of updated jobs, in addition to retrieving scheme error logs or update error logs.\u003c/p\u003e\n"],["\u003cp\u003eThe API endpoints and methods are provided to upload files (POST/PUT), request processing (POST), get status (GET), retrieve updated job list (GET), get scheme error logs (GET), and get update error logs (GET).\u003c/p\u003e\n"]]],[],null,[]]