Generated by API Evangelist
Written by API Evangelist tooling for Canvas's API. It is a proposal applied on top of the contract, not a document Canvas publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Canvas LMS REST Authentications Log API
version: 1.0.0
extends: openapi/canvas-authentications-log-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/v1/audit/authentication/logins/{login_id}'].get
update:
x-apievangelist-phrasing:
intent: Get sign-in history for a login
effect: read
questions:
- When did a specific Canvas login last sign in or out?
- Can I limit a login's authentication events to a date range?
instructions:
- text: List authentication events for login {login_id}.
slots:
login_id: path.login_id
- text: Show sign-ins for login {login_id} between {start_time} and {end_time}.
slots:
login_id: path.login_id
start_time: query.start_time
end_time: query.end_time
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/audit/authentication/accounts/{account_id}'].get
update:
x-apievangelist-phrasing:
intent: Get sign-in history across an account
effect: read
questions:
- Who has been logging in to our Canvas account this week?
- Can I filter account login events by authentication provider?
instructions:
- text: List authentication events in account {account_id} since {start_time}.
slots:
account_id: path.account_id
start_time: query.start_time
- text: Show account {account_id} logins through auth provider {auth_provider_id}.
slots:
account_id: path.account_id
auth_provider_id: query.auth_provider_id
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/audit/authentication/users/{user_id}'].get
update:
x-apievangelist-phrasing:
intent: Get sign-in history for a user
effect: read
questions:
- Has a particular user signed in recently?
- What does the login audit trail look like for one person across all their logins?
instructions:
- text: List authentication events for user {user_id}.
slots:
user_id: path.user_id
- text: Audit user {user_id} sign-ins until {end_time}.
slots:
user_id: path.user_id
end_time: query.end_time
method: generated
generated: '2026-10-01'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.