Code | Description |
---|---|
403 | You are not authorized to access this page. |
{ 'example_request_params': { 'tool_name':'Some new name', 'nonce': 1527500365, 'timestamp': 1527500365052, 'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff' }, 'example_response': { 'tool_provider': { 'id': 2, 'tool_name': 'some new name', 'tool_url': '', 'oauth_consumer_key': 'key', 'oauth_consumer_secret': 'secret', 'institute_id': 1, 'created_at': '2020-11-26T07:19:53.143+01:00', 'updated_at': '2020-11-26T07:21:53.143+01:00', 'use_as_basic_link': true, 'lti_custom_data': '{}' } } }
Param name | Description |
---|---|
id required |
ID of the tool provider. Validations:
|
tool_name optional |
Name of the tool provider Validations:
|
oauth_consumer_key optional |
Oauth key to authenticate to the tool provider Validations:
|
oauth_consumer_secret optional |
Oauth secret to authenticate to the tool provider Validations:
|
institute_id optional |
ID of the institute where the tool_provider will belong (only for superuser) Validations:
|
use_as_basic_link optional |
If set to true the link will be used directly as a basic link otherwise it will be used for deep linking Validations:
|
lti_custom_data optional |
Json as a string that will add custom data to the LTI request (custom_ will be added in front of each key of the JSON when the LTI request will be made) Validations:
|
tool_url optional |
Url of the tool provider LTI resource Validations:
|
timestamp required |
Timestamp of the request in milliseconds. Validations:
|
nonce required |
Random number unique between the api calls made in the previous 24 hours. Validations:
|
signature required |
HMAC sha256 hex encoded hash, using the user secret_key as key, of the query string build with all the other parameters in the format ‘name=value’ joined by ‘?’ and ordered alphabethically by name. Do not use encoding scheme on the values you use to calculate the string Validations:
|