Invitation Creation (Web User)
- Jonathan Tang
Analytics
Purpose: Create Invitation for a Web User.
Permissions Required: Edit Web Users & Edit Access API's
Authentication: For more information, please review Authenticationarchived.
URL: https://www.commcarehq.org/a/[domain]/api/invitation/[version]/
Method: POST
Input Parameters: * means required
Name | Description | Example
|
|---|---|---|
email* | Email address of user | jdoe@dimagi.com |
role* | Role of user | App Editor |
primary_location_id | The location id of the primary location, it must be one of the assigned locations | 26fc44e2792b4f2fa8ef86178f0a958e |
assigned_location_ids | A list of location_ids that the web user will be assigned to. Location id can be acquired by Location API. | ["26fc44e2792b4f2fa8ef86178f0a958e", "c1b029932ed442a6a846a4ea10e46a78"] |
profile | Profile to assign to the user | Facility User |
user_data | Any additional custom data associated with the user | (see examples) |
tableau_role | Tableau Role of the user Options are: “Explorer”, “ExplorerCanPublish”, “SiteAdministratorExplorer”, “Viewer”, and “Unlicensed” | Viewer |
tableau_groups | List of Tableau Groups the user is assigned to | [“city”, “county”] |
Output Parameters:
Name
| Description | Example |
|---|---|---|
id | Invitation UUID | 844b88b3-8f4a-43f8-ba39-62e3014a6998 |
Sample input:
JSON Format
{
"email":"jdoe@dimagi.com",
"role":"App Editor",
"primary_location_id":"26fc44e2792b4f2fa8ef86178f0a958e",
"assigned_location_ids":["26fc44e2792b4f2fa8ef86178f0a958e", "c1b029932ed442a6a846a4ea10e46a78"],
"profile": "Facility User",
"user_data":{
"Can Edit Client":"yes",
"Can View Data": "yes"
},
"tableau_role":"Viewer",
"tableau_groups":[“city”, “county”]
}Sample output:
JSON Format
{
"email":"jdoe@dimagi.com",
"role":"App Editor",
"primary_location_id":"26fc44e2792b4f2fa8ef86178f0a958e",
"assigned_location_ids":["26fc44e2792b4f2fa8ef86178f0a958e", "c1b029932ed442a6a846a4ea10e46a78"],
"profile": "Facility User",
"user_data":{
"Can Edit Client":"yes",
"Can View Data": "yes"
},
"tableau_role":"Viewer",
"tableau_groups":[“city”, “county”]
}