User
Welcome to Our New API Docs! This is the new home for all things API (previously at Canvas LMS REST API Documentation).
User
user_account_association_created
Definition: The event is emitted anytime a user is created in an account.
Trigger: Triggered when a user is added to an account.
Payload Example:
{
"metadata": {
"event_name": "user_account_association_created",
"event_time": "2019-11-01T19:11:11.717Z",
"job_id": "1020020528469291",
"job_tag": "SIS::CSV::ImportRefactored#run_parallel_importer",
"producer": "canvas",
"root_account_id": "21070000000000001",
"root_account_lti_guid": "VicYj3cu5BIFpoZhDVU4DZumnlBrWi1grgJEzADs.oxana.instructure.com",
"root_account_uuid": "VicYj3cu5BIFpoZhDVU4DZumnlBrWi1grgJEzADs"
},
"body": {
"account_id": "21070000000000079",
"account_uuid": "5CaqE03jAic6wjkvgbjaerkucZtFyIvYnsW1t62H",
"created_at": "2019-11-01T19:11:11.717Z",
"is_admin": false,
"updated_at": "2019-11-01T19:11:11.717Z",
"user_id": "21070000000000712"
}
}Event Body Schema
account_id
The Canvas id of the account for this association.
account_uuid
The unique id of the account for this association.
created_at
The time at which this association was created.
is_admin
Is user an administrator?
updated_at
The time at which this association was last modified.
user_id
The Canvas id of the user for this association.
user_created
Definition: The event is emitted anytime a user is added to an account.
Trigger: Triggered when a new user is created.
Payload Example:
Event Body Schema
created_at
The time at which this user was created.
name
Name of user.
short_name
Short name of user.
updated_at
The time at which this user was last modified in any way.
user_id
The Canvas id of user.
user_login
The login of the current user.
user_sis_id
The SIS id of the user.
uuid
Unique user id.
workflow_state
State of the user.
user_updated
Definition: The event is emitted anytime a user details are updated. Only changes to the fields included in the body of the event payload will emit the updated event. The metadata of the event payload will list a user or process that updated the user profile details and the body of the event will list a user details that were updated.
Trigger: Triggered when a user record is updated.
Payload Example:
Event Body Schema
created_at
The time at which this user was created.
name
Name of user.
short_name
Short name of user.
updated_at
The time at which this user was last modified in any way.
user_id
The Canvas id of user.
user_login
The login of the current user.
user_sis_id
The SIS id of the user.
uuid
Unique user id.
workflow_state
State of the user. (deleted, pre_registered, registered)
Note: Timestamps will be in ISO8601 format, including an offset. Be sure to take that into account when parsing, since it’s unspecified which offset timestamps will use, and the offset may even change between different timestamps within a single event.
This documentation is generated directly from the Canvas LMS source code, available on Github.
Last updated
Was this helpful?