Account Admins

get

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Query parameters

pageintegerOptional

Page number for pagination (defaults to 0)

sortstringOptional

Sort field (only 'name')

searchstringOptional

Search query to filter account admins

per_pagestringOptional

Number of results per page

sizestringOptional

Alternative to per_page parameter

Responses

200

Listing account admins

application/json

Responseobject

get

/api/v1/account_admins

HTTPcURLJavaScriptPython

GET /api/v1/account_admins HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Accept: */*

200

Listing account admins

{
  "content": [
    {
      "id": 1,
      "name": "Test Admin",
      "canvas_user_id": "12345",
      "email": "[email protected]",
      "accounts": [
        {
          "id": 10,
          "name": "Domain Account 10"
        }
      ]
    }
  ],
  "page": {
    "number": 0,
    "size": 20,
    "totalElements": 1,
    "totalPages": 1
  }
}

post

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Body

application/x-www-form-urlencoded

canvas_user_idstringRequired

Canvas user ID

user_namestringRequired

Full name of the user

email_addressstringRequired

Email address of the user

account_idsstringRequired

Array of account IDs to associate with the user

Responses

201

Creating an account admin association

application/json

post

/api/v1/account_admins

HTTPcURLJavaScriptPython

POST /api/v1/account_admins HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 88

"canvas_user_id='text'&user_name='text'&email_address='text'&account_ids='text'"

201

Creating an account admin association

{
  "id": 1,
  "name": "Test Admin",
  "canvas_user_id": "12345",
  "email": "[email protected]",
  "accounts": [
    {
      "id": 12,
      "name": "Domain Account 12"
    }
  ]
}

delete

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Path parameters

idstringRequired

account_idintegerRequired

Responses

204

Deleting a specific account admin association

*/*

delete

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

HTTPcURLJavaScriptPython

DELETE /api/v1/account_admins/{id}/accounts/{account_id} HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Accept: */*

204

Deleting a specific account admin association

{}

delete

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Path parameters

idstringRequired

Responses

204

Deleting all account admin associations

*/*

delete

/api/v1/account_admins/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/account_admins/{id} HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Accept: */*

204

Deleting all account admin associations

{}