Authentications Log
Query audit log of authentication events (logins and logouts).
For each endpoint, a compound document is returned. The primary collection of event objects is paginated, ordered by date descending. Secondary collections of logins, accounts, page views, and users related to the returned events are also included. Refer to the Logins, Accounts, Page Views, and Users APIs for descriptions of the objects in those collections.
Authentication logs are stored for one year.
An AuthenticationEvent object looks like:
AuthenticationAuditApiController#for_login
GET /api/v1/audit/authentication/logins/:login_id
GET /api/v1/audit/authentication/logins/:login_id
Scope: url:GET|/api/v1/audit/authentication/logins/:login_id
List authentication events for a given login.
Request Parameters:
AuthenticationAuditApiController#for_account
GET /api/v1/audit/authentication/accounts/:account_id
GET /api/v1/audit/authentication/accounts/:account_id
Scope: url:GET|/api/v1/audit/authentication/accounts/:account_id
List authentication events for a given account.
Request Parameters:
AuthenticationAuditApiController#for_user
GET /api/v1/audit/authentication/users/:user_id
GET /api/v1/audit/authentication/users/:user_id
Scope: url:GET|/api/v1/audit/authentication/users/:user_id
List authentication events for a given user.
Request Parameters:
© Instructure, Inc. Generated on Wed Nov 6 14:20:05 2024 This documentation is generated directly from the Canvas LMS source code, available on Github.
Last updated