Account Admins
Requires a root-account API key; a sub-account key gets 403.
Page number (defaults to 0)
Sort field (only 'name')
Search query to filter account admins
Results per page
account admins listed
Total number of admins across all pages
Current page number (0-based)
Page size
All available permission keys
Total number of pages
requires a root-account API key
GET /api/v1/account_admins HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Accept: */*
{
"content": [
{
"user": {
"id": 1,
"canvas_user_id": 1,
"canvas_user_uuid": "text",
"name": "text",
"email": "text",
"profile_link": "text",
"canvas_user_id_string": "text"
},
"accounts": [
{
"id": 1,
"name": "text"
}
],
"permissions": [
{
"key": "text",
"value": "text"
}
]
}
],
"total_elements": 1,
"page_number": 1,
"size": 1,
"permission_keys": [
"text"
],
"total_pages": 1
}Creates a new account admin or adds account associations to an existing admin. account_ids may contain multiple account IDs. Requires a root-account API key; a sub-account key gets 403.
Canvas user ID
Full name of the user
Email address of the user
Account IDs to associate with the user
account admin created
Canvas user ID of the admin
Account IDs the user now administers
requires a root-account API key
POST /api/v1/account_admins HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 85
{
"canvas_user_id": "text",
"user_name": "text",
"email_address": "text",
"account_ids": [
1
]
}{
"canvas_user_id": 1,
"account_ids": [
1
]
}Removes the association between a user and a specific account. Requires a root-account API key; a sub-account key gets 403.
Canvas user ID of the admin
Account ID to remove
association removed
No content
requires a root-account API key
DELETE /api/v1/account_admins/{id}/accounts/{account_id} HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Accept: */*
No content
Removes all account associations for the specified user. Requires a root-account API key; a sub-account key gets 403.
Canvas user ID of the admin
all associations removed
No content
requires a root-account API key
DELETE /api/v1/account_admins/{id} HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Accept: */*
No content
Last updated
Was this helpful?