Edge API - Course Reserves LTI Tool API documentation

/lti-courses

/lti-courses/oidc-login-init/{apiKeyPath} get

https://openid.net/specs/openid-connect-core-1_0.html#ThirdPartyInitiatedLogin

get

Begin a third-party OIDC login initiation flow

Request
Response

URI Parameters

apiKeyPath: required(string)

Query Parameters

iss: required(string)
The Issuer string of the Platform. This corresponds to a JWT's iss.
Example:
```
https://my-lms.edu/
```
login_hint: required(string)
Unused by this tool but required by the LTI Advantage spec.
target_link_uri: required(string)
The actual end-point that should be executed at the end of the OpenID Connect authentication flow.
Example:
```
https://folio-edge-apis.edu/lti-courses/launches/myApiKey
```

HTTP status code 302

Success, redirecting to the LTI Platform's OAuth Authorization URL

HTTP status code 400

Bad request, missing some of the required parameters

Body

Media type: text/plain

Type: any

Example:

Missing required parameter: target_link_uri

/lti-courses/launches/{apiKeyPath} post

This endpoint uses the LTI context claim's "title" property to lookup the course against the "Course code" in the Folio Courses app

post

Request
Response

URI Parameters

apiKeyPath: required(string)

Body

Media type: application/x-www-form-urlencoded

Type: object

Properties

id_token: required(string)
A JWT containing the LTI Resource Link Launch Request message, https://www.imsglobal.org/spec/lti/v1p3/#resource-link-launch-request-message
Example:
```
eyJr[...]sjFs.G9iY[...]0aS1.HVyb[...]cmdld
```
state: required(string)
The state that was passed to the OAuth2 authorization URL by the Tool in response to the OIDC Login Initiation
Example:
```
vmeekvqcbvvxmbjvarhe
```

HTTP status code 200

Success, will render the course reserves or a 'none found' message

Body

Media type: text/html

Type: any

HTTP status code 400

Bad request, some data is missing or invalid

Body

Media type: text/plain

Type: any

Example:

Issuer not provided

HTTP status code 500

Some internal server error, including ones thrown by Folio

Body

Media type: text/plain

Type: any

Example:

Folio had an internal server error

/lti-courses/externalIdLaunches/{apiKeyPath} post

This endpoint uses the LTI context claim's "title" property to lookup the course against the "External ID" in the Folio Courses app

post

Request
Response

URI Parameters

apiKeyPath: required(string)

Body

Media type: application/x-www-form-urlencoded

Type: object

Properties

id_token: required(string)
A JWT containing the LTI Resource Link Launch Request message, https://www.imsglobal.org/spec/lti/v1p3/#resource-link-launch-request-message
Example:
```
eyJr[...]sjFs.G9iY[...]0aS1.HVyb[...]cmdld
```
state: required(string)
The state that was passed to the OAuth2 authorization URL by the Tool in response to the OIDC Login Initiation
Example:
```
vmeekvqcbvvxmbjvarhe
```

HTTP status code 200

Success, will render the course reserves or a 'none found' message

Body

Media type: text/html

Type: any

HTTP status code 400

Bad request, some data is missing or invalid

Body

Media type: text/plain

Type: any

Example:

Issuer not provided

HTTP status code 500

Some internal server error, including ones thrown by Folio

Body

Media type: text/plain

Type: any

Example:

Folio had an internal server error

/lti-courses/registrarIdLaunches/{apiKeyPath} post

This endpoint uses the LTI context claim's "title" property to lookup the course against the "Registrar ID" in the Folio Courses app

post

Request
Response

URI Parameters

apiKeyPath: required(string)

Body

Media type: application/x-www-form-urlencoded

Type: object

Properties

id_token: required(string)
A JWT containing the LTI Resource Link Launch Request message, https://www.imsglobal.org/spec/lti/v1p3/#resource-link-launch-request-message
Example:
```
eyJr[...]sjFs.G9iY[...]0aS1.HVyb[...]cmdld
```
state: required(string)
The state that was passed to the OAuth2 authorization URL by the Tool in response to the OIDC Login Initiation
Example:
```
vmeekvqcbvvxmbjvarhe
```

HTTP status code 200

Success, will render the course reserves or a 'none found' message

Body

Media type: text/html

Type: any

HTTP status code 400

Bad request, some data is missing or invalid

Body

Media type: text/plain

Type: any

Example:

Issuer not provided

HTTP status code 500

Some internal server error, including ones thrown by Folio

Body

Media type: text/plain

Type: any

Example:

Folio had an internal server error

Edge API - Course Reserves LTI Tool API documentation version v1