Users
Catalog user id
GET /api/v1/users/{id} HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Accept: */*
Getting a specific user
{
"user": {
"id": 1,
"root_account_id": 40,
"canvas_user_id": 2,
"registered_account_id": 40,
"canvas_root_account_uuid": "GUxMJJhiZ8ugUdRADskc0nJrcMXuYYIwV15aWiMO",
"canvas_user_uuid": "573SBAKMeMX3pAa6iOcml1a81xzsVaomatXUBhUT",
"user_name": "Firstname Lastname",
"first_name": "Firstname",
"last_name": "Lastname",
"email_address": "[email protected]",
"custom_fields": {
"favorite_color": "#BADA55",
"code_of_conduct": "1",
"age": "19"
},
"created_at": "2024-04-11T15:33:45.503Z",
"updated_at": "2024-04-11T15:33:45.563514Z",
"merged_into_user_id": 4,
"time_zone": "Etc/UTC"
}
}
Catalog user id
It will clear merged_into_user_id field of user if set to true
PUT /api/v1/users/{id} HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 43
"id=1&clear_merged_into_user_id='text'"
Updating a specific user
{
"user": {
"id": 2,
"root_account_id": 41,
"canvas_user_id": 2,
"registered_account_id": 41,
"canvas_root_account_uuid": "GUxMJJhiZ8ugUdRADskc0nJrcMXuYYIwV15aWiMO",
"canvas_user_uuid": "573SBAKMeMX3pAa6iOcml1a81xzsVaomatXUBhUT",
"user_name": "Firstname Lastname",
"first_name": "Firstname",
"last_name": "Lastname",
"email_address": "[email protected]",
"custom_fields": {
"favorite_color": "#BADA55",
"code_of_conduct": "1",
"age": "19"
},
"created_at": "2024-04-11T15:33:45.503Z",
"updated_at": "2024-04-11T15:33:45.563514Z",
"merged_into_user_id": null,
"time_zone": "Etc/UTC"
}
}
Catalog user id
Delete only orders and enrollments (user dependencies) except user and related account admins OR delete user dependencies including user and related account admins
DELETE /api/v1/users/{id} HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 45
"id=1&only_orders_and_enrollments='text'"
Deleting a specific user with dependencies
{}
If true, only queries users registered through Catalog. If false, only queries users registered through Canvas. If not specified, queries all users.
Canvas user id
Created at from. Suggested format YYYY-MM-DDTHH:MM:SSZ, e.g. 2018-01-01T00:00:00Z. System time zone is UTC.
Created at to. Suggested format YYYY-MM-DDTHH:MM:SSZ, e.g. 2018-01-01T00:00:00Z. System time zone is UTC.
Updated at from. Suggested format YYYY-MM-DDTHH:MM:SSZ, e.g. 2018-01-01T00:00:00Z. System time zone is UTC.
Updated at to. Suggested format YYYY-MM-DDTHH:MM:SSZ, e.g. 2018-01-01T00:00:00Z. System time zone is UTC.
GET /api/v1/users HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Accept: */*
List users
{
"users": [
{
"id": 4,
"root_account_id": 43,
"canvas_user_id": 2,
"registered_account_id": 43,
"canvas_root_account_uuid": "GUxMJJhiZ8ugUdRADskc0nJrcMXuYYIwV15aWiMO",
"canvas_user_uuid": "573SBAKMeMX3pAa6iOcml1a81xzsVaomatXUBhUT",
"user_name": "Firstname Lastname",
"first_name": "Firstname",
"last_name": "Lastname",
"email_address": "[email protected]",
"custom_fields": {
"favorite_color": "#BADA55",
"code_of_conduct": "1",
"age": "19"
},
"created_at": "2024-04-11T15:33:45.503Z",
"updated_at": "2024-04-11T15:33:45.563514Z",
"merged_into_user_id": 4,
"time_zone": "Etc/UTC"
}
]
}
Full user name
First name
Last name
E-mail address (will also serve as login)
ID of subcatalog to associate with user (optional). If not specified, the root account ID used to generate the API key will be registered_account_id
Hash of custom field values, e.g. { "phone": "867-5309" } (optional)
POST /api/v1/users HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 136
"user_name='text'&first_name='text'&last_name='text'&email_address='text'®istered_account_id='text'&custom_fields='text'"
Registering a user
{
"user": {
"id": 3,
"root_account_id": 42,
"canvas_user_id": 2,
"registered_account_id": 42,
"canvas_root_account_uuid": "GUxMJJhiZ8ugUdRADskc0nJrcMXuYYIwV15aWiMO",
"canvas_user_uuid": "573SBAKMeMX3pAa6iOcml1a81xzsVaomatXUBhUT",
"user_name": "Firstname Lastname",
"first_name": "Firstname",
"last_name": "Lastname",
"email_address": "[email protected]",
"custom_fields": {
"favorite_color": "#BADA55",
"code_of_conduct": "1",
"age": "19"
},
"created_at": "2024-04-11T15:33:45.503Z",
"updated_at": "2024-04-11T15:33:45.563514Z",
"confirmation_url": "http://service.com/register/OBtRMuSPiFUAyStz47cbAiOHM",
"terms_of_use": true,
"locale": "en"
}
}
Last updated
Was this helpful?