[API] Update Communication Channels API to show if an email is an institution email address and allow updates to it

Problem statement:

Currently to set/update a user's institution-assigned email address, it requires an SIS Import. However, there is no indicator in the API nor provisioning reports of what a user's institution-assigned email address. Even the SIS Export report for users only shows the users default email address, which may or may not be their institution assigned email address. The only indicator according to Canvas support is to act as the user and view their communication channels and see that it can't be deleted if you have the account setting enabled to prevent students from deleting their institution assigned email address.

Proposed solution:

Since other SIS fields can be edited via APIs and the GUI, it is requested that an additional field be included for the CommunciationChannel object (as listed in the Communication Channels API) to indicate if it is an institution assigned email address or a workflow state value that is unique to institution assigned email addresses. This information already exists, but isn't currently accessible through the Canvas API nor account reports. If you determine a different endpoint would be more appropriate that is fine too. With this available, reports could then be generated to audit users' institution assigned email addresses. Ideally, the Canvas account reports would be updated to show a column on the user's provisioning report for the institution assigned email address if one exists in addition to their default email address. The SIS Export report for users would also be updated to show the user's institution assigned email address if one exists rather than just their default email address. In addition to reporting, the endpoint to Create a communication channel could then be updated to include a parameter to indicate if the communication channel is an institution assigned email address and update it. Ideally, Account Admins (or users with the appropriate permissions) would be able to set/update a user's email address directly in Canvas and indicate that it is an institution assigned email address that is automatically confirmed when creating/updating individual users.

User role(s):

admin

1 Comment
AlexisNast
Instructure
Instructure
Status changed to: Added to Theme

This idea has been added to a theme for consideration.