User Observees API

API for accessing information about the users a user is observing.

List observees UserObserveesController#index

GET /api/v1/users/:user_id/observees

List the users that the given user is observing.

Note: all users are allowed to list their own observees. Administrators can list other users' observees.

Request Parameters:

Parameter Type Description
include[] string

  • “avatar_url”: Optionally include avatar_url.

Allowed values: avatar_url

Example Request:

curl https://<canvas>/api/v1/users/<user_id>/observees \
     -X GET \
     -H 'Authorization: Bearer <token>'
Returns a list of Users

Add an observee with credentials UserObserveesController#create

POST /api/v1/users/:user_id/observees

Register the given user to observe another user, given the observee's credentials.

Note: all users are allowed to add their own observees, given the observee's credentials or access token are provided. Administrators can add observees given credentials, access token or the observee's id.

Request Parameters:

Parameter Type Description
observee[unique_id] string

The login id for the user to observe. Required if access_token is omitted.
observee[password] string

The password for the user to observe. Required if access_token is omitted.
access_token string

The access token for the user to observe. Required if observee[unique_id] or observee[password] are omitted.

Example Request:

curl https://<canvas>/api/v1/users/<user_id>/observees \
     -X POST \
     -H 'Authorization: Bearer <token>' \
     -F 'observee[unique_id]=UNIQUE_ID' \
     -F 'observee[password]=PASSWORD'
Returns a User

Show an observee UserObserveesController#show

GET /api/v1/users/:user_id/observees/:observee_id

Gets information about an observed user.

Note: all users are allowed to view their own observees.

Example Request:

curl https://<canvas>/api/v1/users/<user_id>/observees/<observee_id> \
     -X GET \
     -H 'Authorization: Bearer <token>'
Returns a User

Add an observee UserObserveesController#update

PUT /api/v1/users/:user_id/observees/:observee_id

Registers a user as being observed by the given user.

Example Request:

curl https://<canvas>/api/v1/users/<user_id>/observees/<observee_id> \
     -X PUT \
     -H 'Authorization: Bearer <token>'
Returns a User

Remove an observee UserObserveesController#destroy

DELETE /api/v1/users/:user_id/observees/:observee_id

Unregisters a user as being observed by the given user.

Example Request:

curl https://<canvas>/api/v1/users/<user_id>/observees/<observee_id> \
     -X DELETE \
     -H 'Authorization: Bearer <token>'
Returns a User