Account Admins

List account admins

get

Authorizations

api_key

AuthorizationstringRequired

Query parameters

pageintegerOptional

Page number (defaults to 0)

sortstringOptional

Sort field (only 'name')

searchstringOptional

Search query to filter account admins

per_pageintegerOptional

Results per page

Responses

200

account admins listed

application/json

total_elementsintegerRequired

Total number of admins across all pages

page_numberintegerRequired

Current page number (0-based)

sizeintegerRequired

Page size

permission_keysstring[]Required

All available permission keys

total_pagesintegerRequired

Total number of pages

get/api/v1/account_admins

HTTPcURLJavaScriptPython

GET /api/v1/account_admins HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Accept: */*

200

account admins listed

{
  "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
}

Create an account admin association

post

Creates a new account admin or adds account associations to an existing admin. account_ids may contain multiple account IDs.

Authorizations

api_key

AuthorizationstringRequired

Body

application/json

canvas_user_idstringRequired

Canvas user ID

user_namestringRequired

Full name of the user

email_addressstringRequired

Email address of the user

account_idsinteger[]Required

Account IDs to associate with the user

Responses

201

account admin created

application/json

canvas_user_idintegerRequired

Canvas user ID of the admin

account_idsinteger[]Required

Account IDs the user now administers

post/api/v1/account_admins

HTTPcURLJavaScriptPython

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
  ]
}

201

account admin created

{
  "canvas_user_id": 1,
  "account_ids": [
    1
  ]
}

Remove an admin from a specific account

delete

Removes the association between a user and a specific account.

Authorizations

api_key

AuthorizationstringRequired

Path parameters

idstringRequired

Canvas user ID of the admin

account_idintegerRequired

Account ID to remove

Responses

204

association removed

No content

delete/api/v1/account_admins/{id}/accounts/{account_id}

HTTPcURLJavaScriptPython

DELETE /api/v1/account_admins/{id}/accounts/{account_id} HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Accept: */*

204

association removed

No content

Remove all account associations for an admin

delete

Removes all account associations for the specified user.

Authorizations

api_key

AuthorizationstringRequired

Path parameters

idstringRequired

Canvas user ID of the admin

Responses

204

all associations removed

No content

delete/api/v1/account_admins/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/account_admins/{id} HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Accept: */*

204

all associations removed

No content