How to modify the Login ID for a user?

Question

I've been playing around with the API to get a better understanding of how it works.

We have our users log into Canvas with a user ID comprised of their first initial and last name. We will often have students that change their names due to getting married, which changes the login ID. Looking at the documentation for put /v1/users/{id}, I don't see any way to change the login ID. Is there something I'm missing?

Chris · Accepted Answer

Hi @MikeBrinkman,

I believe there is a different API for that, since a single user can have multiple logins (though in most situations, there is just one).  You'll want to check out https://canvas.instructure.com/doc/api/logins.html#method.pseudonyms.update for details about editing login information.

-Chris

dgrobani · Accepted Answer

I was perplexed for a moment until I saw this under Edit a user: "To modify a user's login, see the documentation for logins." I think you want Edit a user login.

Edit: ah, I see Chris beat me to it.