Session
Destroy the current session, effectively logging out.
curl -H "X-Session-ID: 0123456789" "https://lor.instructure.com/api/sessions/logout"
Session authentication. The session ID can be provided in any of the following ways: [Cookie: 'session'] [Header: 'x-session-id'] [Query parameter: 'session-id'] [Query parameter: first value of 'state'] [Body property: 'sessionId']
No Content
Bad Request
No content
Get the contents of the specified session. Session contents will only be returned for the current session. Sessions are always created for a specific user. Thus user specific information in the session will always belong to the user who created the session.
Example:
curl -H "X-Session-ID: 0123456789" "https://lor.instructure.com/api/sessions/0123456789"
Session authentication. The session ID can be provided in any of the following ways: [Cookie: 'session'] [Header: 'x-session-id'] [Query parameter: 'session-id'] [Query parameter: first value of 'state'] [Body property: 'sessionId']
The id of the session
Session information returned successfully
The unique id for the session
The session expiration timestamp (as string)
The id given by Commons for the user
Whether the user prefers high contrast
The locale code for the user
The full name of the user
The Commons account name for the user
The Commons account id for the user
The Canvas user id
The domain for the Canvas account the session was created to work with
The Canvas roles the user possesses
Whether the user is an admin of the Canvas account
Whether the account can share resources to Public scope
Whether the account can view resources in the Public scope
Whether the account shows curated content first for search results
Whether the account uses the federal outcome tagging
Whether the account uses the state outcome tagging
State postal code for outcome features
Whether the user is a content curator for the account
A url where an avatar for the user can be retrieved
Bad Request
Create a session in Commons.
In order to generate a Commons session using this API, you must have already launched into Commons through Canvas at least once before.
If not, you will get an error informing you that you have never launched into Commons before.
Additionally, you will need to have accepted the terms of service.
This endpoint also requires that you first acquire a JWT (JSON Web Token) that contains certain information needed by Commons to set up the session.
You can acquire this JWT by sending a HTTP GET request to:
https://[your-canvas-domain]/api/lti/accounts/self/jwt_token?tool_launch_url=https://lor.instructure.com/api/lti
This endpoint requires the typical Canvas Authorization header. This means you will need to generate an Access Token as described here.
Example:
curl -X POST -H "Content-Type: application/json" --data '{"jwt_token": "<contents of JWT token>"}' "https://lor.instructure.com/api/sessions"
The JWT that is given to you by Canvas. It should be exactly as Canvas gives it to you. Do not decode it and give us the decoded version. We will handle that for you.
Session created successfully
Bad Request
Last updated
Was this helpful?