Instructure Developer Documentation Portal
Community
  • Introduction
  • Services
    • Elevate Standards Alignment - AB Connect API
      • Introduction
        • Authentication
        • Addressing Object Properties
        • Requesting Additional Properties in the Response
        • Filtering Using ODATA Like Statements
        • Sorting
        • Facets
        • Paging Data
        • Call Throttling
        • Working with Related Object
        • Error Responses
        • Character Set Support
        • How To Articles, Recommendations and Suggestions
        • Examples
        • Using AB Connect's Embeddable Widgets
      • Reference
        • Standards
        • Standard Collections
        • Events
        • Topics
        • Concepts
        • Assets
        • Asset Definitions
        • Asset Collections
        • Managing and Predicting Relationships
        • Providers
    • Canvas LMS
      • Basics
        • GraphQL
        • API Change Log
        • SIS IDs
        • Pagination
        • Throttling
        • Compound Documents
        • File Uploads
        • API Endpoint Attributes
        • Masquerading
      • OAuth2
        • OAuth2 Overview
        • OAuth2 Endpoints
        • Developer Keys
      • Resources
        • Access Tokens
        • Account Calendars
        • Account Domain Lookups
        • Account Notifications
        • Account Reports
        • Accounts
        • Accounts (LTI)
        • Admins
        • Analytics
        • Announcement External Feeds
        • Announcements
        • API Token Scopes
        • Appointment Groups
        • Assignment Extensions
        • Assignment Groups
        • Assignments
        • Authentication Providers
        • Authentications Log
        • Blackout Dates
        • BlockEditorTemplate
        • Blueprint Courses
        • Bookmarks
        • Brand Configs
        • Calendar Events
        • Collaborations
        • CommMessages
        • Communication Channels
        • Conferences
        • Content Exports
        • Content Migrations
        • Content Security Policy Settings
        • Content Shares
        • Conversations
        • Course Audit log
        • Course Pace
        • Course Quiz Extensions
        • Course Reports
        • Courses
        • Custom Gradebook Columns
        • Developer Key Account Bindings
        • Developer Keys
        • Discussion Topics
        • Enrollment Terms
        • Enrollments
        • ePortfolios
        • ePub Exports
        • Error Reports
        • External Tools
        • Favorites
        • Feature Flags
        • Files
        • Grade Change Log
        • Gradebook History
        • Grading Period Sets
        • Grading Periods
        • Grading Standards
        • Group Categories
        • Groups
        • History
        • InstAccess tokens
        • JWTs
        • Late Policy
        • Learning Object Dates
        • Line Items
        • LiveAssessments
        • Logins
        • LTI Launch Definitions
        • LTI Registrations
        • LTI Resource Links
        • Media Objects
        • Moderated Grading
        • Modules
        • Names and Role
        • New Quiz Items
        • New Quizzes
        • New Quizzes Accommodations
        • New Quizzes Reports
        • Notification Preferences
        • Originality Reports
        • Outcome Groups
        • Outcome Imports
        • Outcome Results
        • Outcomes
        • Pages
        • Peer Reviews
        • Planner
        • Poll Sessions
        • PollChoices
        • Polls
        • PollSubmissions
        • Proficiency Ratings
        • Progress
        • Public JWK
        • Quiz Assignment Overrides
        • Quiz Extensions
        • Quiz IP Filters
        • Quiz Question Groups
        • Quiz Questions
        • Quiz Reports
        • Quiz Statistics
        • Quiz Submission Events
        • Quiz Submission Files
        • Quiz Submission Questions
        • Quiz Submission User List
        • Quiz Submissions
        • Quizzes
        • Result
        • Roles
        • Rubrics
        • Sandboxes
        • Score
        • Search
        • Sections
        • Services
        • Shared Brand Configs
        • SIS Import Errors
        • SIS Imports
        • SIS Integration
        • Smart Search
        • Submission Comments
        • Submissions
        • Tabs
        • Temporary Enrollment Pairings
        • User Observees
        • Users
        • What If Grades
      • Outcomes
        • Outcomes CSV Format
      • Group Categories
        • Group Categories CSV Format
      • SIS
        • SIS CSV Format
      • External Tools
        • LTI
          • Introduction
          • Registration
          • Launch Overview
          • Configuring
          • Variable Substitutions
          • Deep Linking
          • Grading
          • Provisioning
          • PostMessage
          • Platform Notification Service
          • Placements
            • Placements Overview
            • Navigation
            • Homework Submission
            • Editor Button
            • Migration Selection
            • Link Selection (Modules)
            • Assignment Selection
            • Collaborations
        • xAPI
        • Canvas Roles
        • Plagiarism Detection Platform
          • Overview
          • Plagiarism Detection Platform Assignments
          • Plagiarism Detection Platform Users
          • Plagiarism Detection Submissions
          • Webhooks Subscriptions for Plagiarism Platform
          • JWT Access Tokens
      • Data Services
        • Live Events
          • Overview
            • Introduction
            • Setup
            • Caliper
            • Metadata
          • Event Format
            • Canvas
              • Account
              • Asset
              • Assignment
              • Attachment
              • Content
              • Conversation
              • Course
              • Discussion
              • Enrollment
              • Grade
              • Group
              • Learning
              • Logged
              • Module
              • Outcome
              • Outcomes
              • Plagiarism
              • Quiz
              • Rubric
              • Sis
              • Submission
              • Syllabus
              • User
              • Wiki
            • Caliper IMS 1.1
              • Assessment
              • Basic
              • Forum
              • Grading
              • Navigation Events
              • Session
    • Catalog
      • APIs
        • Analytics
        • Bulk Enrollments
        • Catalogs
        • Certificates
        • Completed Certificates
        • Courses
        • Email Domain Set
        • Enrollments
        • Orders
        • Programs
        • Progresses
        • Tags
        • User Registrations
        • Users
        • Waitlist Applicants
    • Credentials
      • Getting Started
      • Authentication
        • Password-Based Authentication
        • Authorization Code-Based Authentication
      • Pagination
      • APIs
        • Assertions
        • Backpack
        • Badgeclasses
        • Issuers
        • Organizations
        • Users
      • Release Notes
    • Data Access Platform
      • Key Concepts
      • Data Formats
      • Rate Limits & Policies
      • Datasets
        • Namespaces
          • canvas
            • canvas types
          • canvas_logs
          • catalog
        • Additional Notes
        • Entity Relationship Diagram
      • Query API
        • Authentication
        • Reference
      • Command Line (DAP CLI)
        • Getting Started
        • Secure Connection
        • Reference
          • dap snapshot
          • dap incremental
          • dap list
          • dap schema
          • dap initdb
          • dap syncdb
          • dap dropdb
      • Client Library
        • Examples
        • Reference
      • Release Notes
      • Status
    • DataSync
      • Interop API
      • Interop Data API
      • Grades Exchange API
      • OneRoster API
      • Platform API
    • Instructure Media
      • API Reference
        • Captions
        • Collection
        • Courses
        • Group
        • Insights
        • Media
        • Media Upload
        • Ping
        • Professional Captioning
        • Tags
        • Transfer Media
        • User
    • Quizzes
      • Quiz API
Powered by GitBook

Copyright © 2008-2024 Instructure, Inc. All rights reserved. Various trademarks held by their respective owners.

On this page

Was this helpful?

  1. Services
  2. DataSync

Interop API

PreviousDataSyncNextInterop Data API

Last updated 1 year ago

Was this helpful?

List Interop Tenants

get

Get a list of TenantInfo representing your licensed and authorized Integration tenants.

Authorizations
Query parameters
accountsstring · uuid[] · min: 1Optional

Optionally restrict the returned list of tenants to only those for the specified Accounts.

integrationsstring[] · min: 1Optional

Optionally restrict the returned list of tenants to only those for the specified Integration or Integrations. Use this parameter when you have multiple Integrations all serviced by the same client application. When omitted, includes tenants of all Integrations owned by your account.

pageinteger · int32Optional

Specify the page number (defaults to 0)

page_sizeinteger · int32Optional

Specify the page_size (defaults to the maximum page size)

Responses
200
TenantInfos response
application/json
Responseall of
get
GET /v2/interop/tenants HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Basic username:password
Accept: */*
200

TenantInfos response

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "account": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "public_id": "text",
        "timezone": "text",
        "userdata": "text"
      },
      "cloud": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "generation": 1,
        "env": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        }
      },
      "integration": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "version": "text"
      },
      "license": {
        "status": "text",
        "valid_from": "2025-05-25T20:25:49.414Z",
        "valid_to": "2025-05-25T20:25:49.414Z"
      },
      "status": {
        "op_state": "text",
        "setup_state": "text",
        "last_sync_at": "2025-05-25T20:25:49.414Z"
      },
      "sis_status": {
        "op_state": "text",
        "setup_state": "text",
        "last_sync_at": "2025-05-25T20:25:49.414Z"
      },
      "auth": {
        "type": "text",
        "client_id": "text",
        "client_secret": "password",
        "updated_at": "2025-05-25T20:25:49.414Z"
      }
    }
  ],
  "paging": {
    "next": "text"
  }
}

Find Interop Tenant

get
Authorizations
Path parameters
idstring · uuidRequired

id of the TenantInfo to find

Responses
200
TenantInfo response
application/json
Responseall of
get
GET /v2/interop/tenants/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Accept: */*
200

TenantInfo response

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "account": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "public_id": "text",
      "timezone": "text",
      "userdata": "text"
    },
    "cloud": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "generation": 1,
      "env": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      }
    },
    "integration": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "version": "text"
    },
    "license": {
      "status": "text",
      "valid_from": "2025-05-25T20:25:49.414Z",
      "valid_to": "2025-05-25T20:25:49.414Z"
    },
    "status": {
      "op_state": "text",
      "setup_state": "text",
      "last_sync_at": "2025-05-25T20:25:49.414Z"
    },
    "sis_status": {
      "op_state": "text",
      "setup_state": "text",
      "last_sync_at": "2025-05-25T20:25:49.414Z"
    },
    "auth": {
      "type": "text",
      "client_id": "text",
      "client_secret": "password",
      "updated_at": "2025-05-25T20:25:49.414Z"
    }
  },
  "error": {
    "status": 1,
    "code": "text",
    "message": "text",
    "ext_message": "text",
    "details": "text"
  }
}

List Scoping Schools

get

Get the list of ScopingSchools that define how to scope this tenant's repository by school

Authorizations
Query parameters
pageinteger · int32Optional

Specify the page number (defaults to 0)

page_sizeinteger · int32Optional

Specify the page_size (defaults to the maximum page size)

Responses
200
ScopingSchools response
application/json
Responseall of
get
GET /v2/interop/tenant/scoping/schools HTTP/1.1
Host: api.us2.kimonocloud.com
Accept: */*
200

ScopingSchools response

{
  "data": [
    {
      "account_id": "123e4567-e89b-12d3-a456-426614174000",
      "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
      "school_id": "123e4567-e89b-12d3-a456-426614174000",
      "school_ref_id": "text",
      "name": "text",
      "local_id": "text",
      "keywords": "text",
      "selected": true
    }
  ],
  "paging": {
    "next": "text"
  }
}

Delete Scoping Schools

delete
Authorizations
Responses
204
Success
delete
DELETE /v2/interop/tenant/scoping/schools HTTP/1.1
Host: api.us2.kimonocloud.com
Accept: */*
204

Success

No content

Find Scoping School

get
Authorizations
Path parameters
idstring · uuidRequired

id of the ScopingSchool to find

Responses
200
ScopingSchool response
application/json
Responseall of
get
GET /v2/interop/tenant/scoping/schools/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Accept: */*
200

ScopingSchool response

{
  "data": {
    "account_id": "123e4567-e89b-12d3-a456-426614174000",
    "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
    "school_id": "123e4567-e89b-12d3-a456-426614174000",
    "school_ref_id": "text",
    "name": "text",
    "local_id": "text",
    "keywords": "text",
    "selected": true
  },
  "error": {
    "status": 1,
    "code": "text",
    "message": "text",
    "ext_message": "text",
    "details": "text"
  }
}

Delete Scoping School

delete
Authorizations
Path parameters
idstring · uuidRequired

id of the ScopingSchool

Responses
204
Success
delete
DELETE /v2/interop/tenant/scoping/schools/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Accept: */*
204

Success

No content

List Scoping Courses

get

Get the list of Scoping Courses to apply to this tenant's repository

Authorizations
Query parameters
pageinteger · int32Optional

Specify the page number (defaults to 0)

page_sizeinteger · int32Optional

Specify the page_size (defaults to the maximum page size)

Responses
200
ScopingCourses response
application/json
Responseall of
get
GET /v2/interop/tenant/scoping/courses HTTP/1.1
Host: api.us2.kimonocloud.com
Accept: */*
200

ScopingCourses response

{
  "data": [
    {
      "account_id": "123e4567-e89b-12d3-a456-426614174000",
      "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
      "course_id": "123e4567-e89b-12d3-a456-426614174000",
      "course_ref_id": "text",
      "school_id": "123e4567-e89b-12d3-a456-426614174000",
      "school_ref_id": "text",
      "name": "text",
      "local_id": "text",
      "keywords": "text",
      "selected": true
    }
  ],
  "paging": {
    "next": "text"
  }
}

Delete Scoping Courses

delete
Authorizations
Responses
204
Success
delete
DELETE /v2/interop/tenant/scoping/courses HTTP/1.1
Host: api.us2.kimonocloud.com
Accept: */*
204

Success

No content

Find Scoping Course

get
Authorizations
Path parameters
idstring · uuidRequired

id of the ScopingCourse to find

Responses
200
ScopingCourse response
application/json
Responseall of
get
GET /v2/interop/tenant/scoping/courses/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Accept: */*
200

ScopingCourse response

{
  "data": {
    "account_id": "123e4567-e89b-12d3-a456-426614174000",
    "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
    "course_id": "123e4567-e89b-12d3-a456-426614174000",
    "course_ref_id": "text",
    "school_id": "123e4567-e89b-12d3-a456-426614174000",
    "school_ref_id": "text",
    "name": "text",
    "local_id": "text",
    "keywords": "text",
    "selected": true
  },
  "error": {
    "status": 1,
    "code": "text",
    "message": "text",
    "ext_message": "text",
    "details": "text"
  }
}

Delete Scoping Course

delete
Authorizations
Path parameters
idstring · uuidRequired

id of the ScopingCourse

Responses
204
Success
delete
DELETE /v2/interop/tenant/scoping/courses/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Accept: */*
204

Success

No content

  • GETList Interop Tenants
  • GETFind Interop Tenant
  • GETList Scoping Schools
  • POSTCreate Scoping Schools
  • DELETEDelete Scoping Schools
  • GETFind Scoping School
  • PUTUpdate Scoping School
  • DELETEDelete Scoping School
  • GETList Scoping Courses
  • POSTCreate Scoping Courses
  • DELETEDelete Scoping Courses
  • GETFind Scoping Course
  • PUTUpdate Scoping Course
  • DELETEDelete Scoping Course

Create Scoping Schools

post
Authorizations
Query parameters
replacebooleanOptional

true to replace existing Scoping Schools, false to append to existing Scoping Schools

Default: true
Body
Responses
200
Success
application/json
Responseall of
400
Bad Request
application/json
post
POST /v2/interop/tenant/scoping/schools HTTP/1.1
Host: api.us2.kimonocloud.com
Content-Type: application/json
Accept: */*
Content-Length: 255

{
  "data": [
    {
      "account_id": "123e4567-e89b-12d3-a456-426614174000",
      "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
      "school_id": "123e4567-e89b-12d3-a456-426614174000",
      "school_ref_id": "text",
      "name": "text",
      "local_id": "text",
      "keywords": "text",
      "selected": true
    }
  ]
}
{
  "data": {
    "account_id": "123e4567-e89b-12d3-a456-426614174000",
    "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
    "school_id": "123e4567-e89b-12d3-a456-426614174000",
    "school_ref_id": "text",
    "name": "text",
    "local_id": "text",
    "keywords": "text",
    "selected": true
  },
  "error": {
    "status": 1,
    "code": "text",
    "message": "text",
    "ext_message": "text",
    "details": "text"
  }
}

Update Scoping School

put
Authorizations
Path parameters
idstring · uuidRequired

id of the Scoping School to update

Body
account_idstring · uuidOptional
tenant_idstring · uuidOptional
school_idstring · uuidOptional
school_ref_idstringOptional
namestringOptional
local_idstringOptional
keywordsstringOptional
selectedbooleanOptional
Responses
200
ScopingSchool response
application/json
Responseall of
put
PUT /v2/interop/tenant/scoping/schools/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Content-Type: application/json
Accept: */*
Content-Length: 244

{
  "account_id": "123e4567-e89b-12d3-a456-426614174000",
  "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
  "school_id": "123e4567-e89b-12d3-a456-426614174000",
  "school_ref_id": "text",
  "name": "text",
  "local_id": "text",
  "keywords": "text",
  "selected": true
}
200

ScopingSchool response

{
  "data": {
    "account_id": "123e4567-e89b-12d3-a456-426614174000",
    "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
    "school_id": "123e4567-e89b-12d3-a456-426614174000",
    "school_ref_id": "text",
    "name": "text",
    "local_id": "text",
    "keywords": "text",
    "selected": true
  },
  "error": {
    "status": 1,
    "code": "text",
    "message": "text",
    "ext_message": "text",
    "details": "text"
  }
}

Create Scoping Courses

post
Authorizations
Query parameters
replacebooleanOptional

true to replace existing Scoping Courses, false to append to existing Scoping Courses

Default: true
Body
Responses
200
Success
application/json
Responseall of
400
Bad Request
application/json
post
POST /v2/interop/tenant/scoping/courses HTTP/1.1
Host: api.us2.kimonocloud.com
Content-Type: application/json
Accept: */*
Content-Length: 329

{
  "data": [
    {
      "account_id": "123e4567-e89b-12d3-a456-426614174000",
      "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
      "course_id": "123e4567-e89b-12d3-a456-426614174000",
      "course_ref_id": "text",
      "school_id": "123e4567-e89b-12d3-a456-426614174000",
      "school_ref_id": "text",
      "name": "text",
      "local_id": "text",
      "keywords": "text",
      "selected": true
    }
  ]
}
{
  "data": {
    "account_id": "123e4567-e89b-12d3-a456-426614174000",
    "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
    "course_id": "123e4567-e89b-12d3-a456-426614174000",
    "course_ref_id": "text",
    "school_id": "123e4567-e89b-12d3-a456-426614174000",
    "school_ref_id": "text",
    "name": "text",
    "local_id": "text",
    "keywords": "text",
    "selected": true
  },
  "error": {
    "status": 1,
    "code": "text",
    "message": "text",
    "ext_message": "text",
    "details": "text"
  }
}

Update Scoping Course

put
Authorizations
Path parameters
idstring · uuidRequired

id of the Scoping Course to update

Body
account_idstring · uuidOptional
tenant_idstring · uuidOptional
course_idstring · uuidOptional
course_ref_idstringOptional
school_idstring · uuidOptional
school_ref_idstringOptional
namestringOptional
local_idstringOptional
keywordsstringOptional
selectedbooleanOptional
Responses
200
ScopingCourse response
application/json
Responseall of
put
PUT /v2/interop/tenant/scoping/courses/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Content-Type: application/json
Accept: */*
Content-Length: 318

{
  "account_id": "123e4567-e89b-12d3-a456-426614174000",
  "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
  "course_id": "123e4567-e89b-12d3-a456-426614174000",
  "course_ref_id": "text",
  "school_id": "123e4567-e89b-12d3-a456-426614174000",
  "school_ref_id": "text",
  "name": "text",
  "local_id": "text",
  "keywords": "text",
  "selected": true
}
200

ScopingCourse response

{
  "data": {
    "account_id": "123e4567-e89b-12d3-a456-426614174000",
    "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
    "course_id": "123e4567-e89b-12d3-a456-426614174000",
    "course_ref_id": "text",
    "school_id": "123e4567-e89b-12d3-a456-426614174000",
    "school_ref_id": "text",
    "name": "text",
    "local_id": "text",
    "keywords": "text",
    "selected": true
  },
  "error": {
    "status": 1,
    "code": "text",
    "message": "text",
    "ext_message": "text",
    "details": "text"
  }
}