Include user profile links in API call

0 Likes
(2)

Currently, the API call to retrieve the user profile details has an undocumented API parameter to include the 'links' URL and Title from the user's profile.  By including the query string of 'include[]=links', you will get a 'links' element in the response data structured as such:

"links": [{"url": <some url>,"title": <some title>"}]

 

Since this is an undocumented parameter, it is not supported by Canvas Engineering and stop working in the future. This API parameter should be kept as a permanent feature since it exposes the links data to district administration and allows checking if harmful hyperlinks put there by the user via the UI.

 

From a K-12 perspective, URLs entered by a student can be extremely harmful and currently go unchecked there is a means via the API to do so, much like is available for checking the bio text. 

 

3 Comments
Stef_retired
Instructure Alumni
Instructure Alumni
Status changed to: Open
 
lmsstaff
Community Participant

Let's vote this up the food chain to keep this important API parameter in the product!

KristinL
Community Team
Community Team
Status changed to: Archived

Thank you for sharing this idea with the Instructure Community!

The Product Team reviewed all feature proposals recently, and unfortunately, this thread was identified as one that they would not be able to include in their current or future plans. While we appreciate your proposal, we also want to be transparent about the likelihood of something like this making it to production.

Thank you for collaborating, and we hope that you submit another idea in the future!