Creating Users with API

[kfavara]

I am trying to create users, using the API with an authentication_provider_id field being populated. Since it is not one of the fields in the schema, I do not think I can send it with the post. I did, however, attempt it anyway and it gets ignored. The field is blank for all new users. 

How can I create a user with the authentication_provider_id field, or immediately populate that field using the API?

[garth]

 @kfavara ‌ it looks like the parameter is listed in the API call:

• Users - Create a user Canvas

Are you using Postman to test?

Can you give an example of the syntax you are using to make the call?

[kfavara]

Thanks for that info! I am new to using the API. I was using the live API for documentation and only using the items listed in the user brackets. I will play with the pseudonym fields and see if I can get it working.

I have not heard of Postman for testing. I have been using a test instance of Canvas to test my code.

If I cannot get it to post correctly, now that I see how to do it, I will post my code again for more help. Thanks for the response!

[garth]

 @kfavara ‌ Postman is really useful for testing the API, take a look at this post:

• API Testing: Postman‌

Please post back and let everyone know if you have success with the API call.

[kfavara]

Postman looks like it is going to be great, once I figure it out.

I am using C# and sending JSON encoded data. 

I pasted my data into the Body, and clicked raw as the selection. I am not sure if this was correct, but the header picked up the content type. And I have copied and pasted my token from the application. When I clicked Send, I had a blank response and the error says 403 Forbidden. I verified that the user I am trying to create was not already in the system. And I have been able to create users with all other fields, except the authentication_provider_id. I have also tried sending the value of "canvas" as the provider_id as that is the value I send when uploading. When running a user report, the values are all 1, so I also tried to submit the 1. I hope this is enough info.

I am sending:

{"user":{"sis_user_id":"xxxxxxxxx","login_id":"emailAddress","name":"Bob Jester","password":"xxxxxx","email":"emailAddress"},"pseudonym":{"unique_id":"xxxxxxxxx","sis_user_id":"xxxxxxxxx","authentication_provider_id":"1"}}

[James · Accepted solution]

 @kfavara ,

Have you verified the IDs for the authentication providers through the API?

GET /api/v1/accounts/:account_id/authentication_providers ‍‍

When I do that for my site, I get this.

The 632 is what I would use for our CAS system and the 1830 is what I would use for Canvas.

I can't say that will fix the issue (that is, I haven't actually created a user this way), but those are the numbers that you would need to use. Usually things that are in the documentation work and occasionally there are some things that aren't in the documentation that work. Since you say it works for everything but the authentication_provider_id, that's where I would start.

[kfavara]

This worked! Thanks so much for your help!!

[garth]

 @kfavara ‌ I also use C# and have shared some API coding examples here:

• .NET - Canvas API Implementation‌

If you're planning to develop tools for Canvas, these might also be of interest:

• Basic intro to LTI: .NET LTI Project - Part 1 - Connect to Canvas‌
• Taking the next step, implementing the OAuth2 workflow: .NET - OAuth2 Workflow: Part 1 - Authrorize Redirect‌