Account
Gets settings on an account. Only Canvas Administrators are allowed to perform this action.
Example: curl -X GET -H "X-Session-ID: 0123456789" -H "Content-Type: application/json" "https://lor.instructure.com/api/account/settings"
GET /api/account/settings HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Accept: */*
{
"canShowPublic": true,
"canSharePublic": true,
"canShowFeatured": true,
"showCuratedResourcesFirst": true,
"showFederalStandards": true,
"showStateStandards": true,
"stateStandard": "text",
"allowApprovedContent": true,
"defaultSearchFilters": {
"enabled": true
},
"accountCuratedBannerColor": "text",
"accountCuratedBannerImage": "text",
"curators": [
{
"uuid": "text",
"email": "text",
"firstName": "text",
"lastName": "text"
}
]
}
Update settings on an account. Only Canvas Administrators are allowed to perform this action.
Example:
curl -X POST -H "X-Session-ID: 0123456789" -H "Content-Type: application/json" --data '{"canShowPublic":true, "canSharePublic":"false"}' "https://lor.instructure.com/api/account/settings"
If true, show publicly shared resources in search results.
If true, allow users to share resources publicly.
If true, it will show featured resources if there are any.
If true, resources marked as CURATED will be shown firsts on search results
If true, allow users to use federal outcomes tagging
If true, allow users to use state outcomes tagging
Which state the standards should reflect. Must be a valid postal abbreviation or "NONE" if you wish to not include a state
If true, allow curators to allow approved content
POST /api/account/settings HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 205
{
"canShowPublic": true,
"canSharePublic": true,
"canShowFeatured": true,
"showCuratedResourcesFirst": true,
"showFederalStandards": true,
"showStateStandards": true,
"stateStandard": "text",
"allowApprovedContent": true
}
{
"defaultSearchFilters": {
"enabled": true
},
"accountCuratedBannerColor": "text"
}
Post a custom branding image to be displayed on account curated content. The image needs to be a PNG, GIF, or JPEG. Branding must be uploaded as multipart/form-data.
Example:
curl -X POST -H "X-Session-ID: 0123456789" -F "[email protected]" "https://lor.instructure.com/api/account/settings/branding"
The branding image file (PNG, GIF, or JPEG)
POST /api/account/settings/branding HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 22
{
"thumbnail": "binary"
}
{
"canShowPublic": true,
"canSharePublic": true,
"showCuratedResourcesFirst": true,
"showFederalStandards": true,
"showStateStandards": true,
"stateStandard": "text",
"allowApprovedContent": true,
"defaultSearchFilters": {
"enabled": true
},
"curators": [
{}
],
"accountCuratedBannerImage": "text"
}
Reset custom branding image to default whiteCheckmark icon.
Example:
curl -X DELETE -H "X-Session-ID: 0123456789" "https://lor.instructure.com/api/account/settings/branding"
DELETE /api/account/settings/branding HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Accept: */*
{
"canShowPublic": true,
"canSharePublic": true,
"showCuratedResourcesFirst": true,
"showFederalStandards": true,
"showStateStandards": true,
"stateStandard": "text",
"allowApprovedContent": true,
"defaultSearchFilters": {
"enabled": true
},
"curators": [
{}
],
"accountCuratedBannerImage": "text",
"accountCuratedBannerColor": "text"
}
Add a new curator to the account settings.
Example:
curl -X POST -H "X-Session-ID: 0123456789" -H "Content-Type: application/json" --data '{"userId":"UUID_HERE"}' "https://lor.instructure.com/api/account/settings/curators"
The uuid for the user to add
POST /api/account/settings/curators HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 17
{
"userId": "text"
}
{
"curators": [
{
"uuid": "text",
"email": "text",
"firstName": "text",
"lastName": "text"
}
]
}
Deletes an existing curator from the account. Only Canvas Administrators are allowed to perform this action.
Example: * curl -X DELETE -H "X-Session-ID: 0123456789" -H "Content-Type: application/json" "https://lor.instructure.com/api/account/settings/curators/userId"
The UUID of the user to find and delete from the curators array
DELETE /api/account/settings/curators/{userId} HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Accept: */*
No content
Search through a list of all of the accounts in commons.
Example:
curl -H "X-Session-ID: 0123456789" "https://lor.instructure.com/api/account?q=arizona&includePublicOnly=true"
The text to search for in the name of the accounts. The results will be empty until the minimum length of 3 characters is satisfied.
An identifier from a prior query to continue retrieving results for.
Whether or not to include publicOnly accounts in the search.
GET /api/account HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Accept: */*
{
"items": [
{
"id": "text",
"name": "text",
"publicOnly": true
}
],
"meta": {
"count": 1,
"cursor": "text"
}
}
Last updated
Was this helpful?