Instructure Developer Documentation Portal

Interop API

PreviousDataSync NextInterop 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-05T05:36:30.984Z",
        "valid_to": "2025-05-05T05:36:30.984Z"
      },
      "status": {
        "op_state": "text",
        "setup_state": "text",
        "last_sync_at": "2025-05-05T05:36:30.984Z"
      },
      "sis_status": {
        "op_state": "text",
        "setup_state": "text",
        "last_sync_at": "2025-05-05T05:36:30.984Z"
      },
      "auth": {
        "type": "text",
        "client_id": "text",
        "client_secret": "password",
        "updated_at": "2025-05-05T05:36:30.984Z"
      }
    }
  ],
  "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-05T05:36:30.984Z",
      "valid_to": "2025-05-05T05:36:30.984Z"
    },
    "status": {
      "op_state": "text",
      "setup_state": "text",
      "last_sync_at": "2025-05-05T05:36:30.984Z"
    },
    "sis_status": {
      "op_state": "text",
      "setup_state": "text",
      "last_sync_at": "2025-05-05T05:36:30.984Z"
    },
    "auth": {
      "type": "text",
      "client_id": "text",
      "client_secret": "password",
      "updated_at": "2025-05-05T05:36:30.984Z"
    }
  },
  "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

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"
  }
}