DAP API and API key vs. client ID + secret: please clarify if any changes apply to the low level AP

I don't have experience yet using the DAP CLI (or client library). I've only used so far the low level DAP API (REST), and I've recently been confused by some of the posts that suggest that API Keys have been deprecated (or will eventually be) for use with the API. In particular, when I look at the official API documentation, I still see that it refers to API keys (and not client ids + secrets). Here's the Identity Services link where I still see this: https://identity.instructure.com/login

Can somebody clarify this?

Find more posts tagged with

cd2

dap

Accepted answers

All comments

ColinMurtaugh

The keys that we can manage via identity.instructure.com consist of a client ID and a secret. You use the client ID and secret to obtain a short-lived access token which is used to access the DAP API. See "How to call a service" in the DAP API docs.

The dap CLI / client library used to accept the access token directly (via environment variable or command-line parameter) but now it accepts the client ID and secret instead. The CLI/library will manage fetching (and refreshing) the access token for you, simplifying the process.

I hope this helps -- let me know if it's not clear!

--Colin

Unanswered Questions

Error initializing large table using dap on python 3.14
Hi — I've been struggling to initialize our "submissions" table using the dap CLI and I've narrowed down the problem to Python 3.14. I'm able to successfully run the same exact initdb command (on the same EC2 instance) under Python 3.13 and 3.12. On Python 3.14.2, the import successfully processes about 34 million records…
EDUCAUSE Insights: Data and Decision-Making
EDUCAUSE is full of inspiration, whether you’re onsite or following from afar. Join the evolution by sharing what sparks your curiosity, the questions you have, and the insights you discover. We'll learn from each other, expand our networks, and strengthen our Community. Your perspective matters, and the more we share,…
Problems with GraphQL in User Pageviews reports
Prompted by the most recent Canvas release notes, we looked into the Page Views feature, and we were happy with the new documented changes. However, we notice that more user actions are done by GraphQL API, which does not provide details in the page view report, either in the GUI or in the CSV file download. We and most…
Metrics Easy Button
I am currently teaching five courses this semester with more than 70 students. To track their progress, I currently have to review each course and section individually, which is very time-consuming. Ideally, I would like to consolidate key information for all students into a single Excel file—showing class attendance…
Analytics API / Metrics calculation logic
Hello, We are currently using the Analytics API provided in the Instructure Developer Documentation Portal to retrieve certain metrics-related data. We would like to know if it’s possible to replicate these datasets using the Canvas Data Platform (CDP), instead of relying on API calls. For example, could you please advise…