Interop API

List Interop Tenants

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

GEThttps://api.us2.kimonocloud.com/v2/interop/tenants

Authorization

Vendor

Query parameters

Response

200

TenantInfos response

Body

application/json

dataarray of TenantInfo (object)

pagingobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.us2.kimonocloud.com/v2/interop/tenants', {
    method: 'GET',
    headers: {
      "Authorization": "basic <token>"
    },
});
const data = await response.json();

Response

200

{
  "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",
        "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": "2024-11-21T10:54:02.151Z",
        "valid_to": "2024-11-21T10:54:02.151Z"
      },
      "status": {
        "op_state": "text",
        "setup_state": "text",
        "last_sync_at": "2024-11-21T10:54:02.151Z"
      },
      "sis_status": {
        "op_state": "text",
        "setup_state": "text",
        "last_sync_at": "2024-11-21T10:54:02.151Z"
      },
      "auth": {
        "type": "text",
        "client_id": "text",
        "client_secret": "password",
        "updated_at": "2024-11-21T10:54:02.151Z"
      }
    }
  ],
  "paging": {
    "next": "text"
  }
}

Find Interop Tenant

GEThttps://api.us2.kimonocloud.com/v2/interop/tenants/{id}

Path parameters

id*string (uuid)

id of the TenantInfo to find

Response

200

TenantInfo response

Body

application/json

dataTenantInfo (object)

errorobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.us2.kimonocloud.com/v2/interop/tenants/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "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",
      "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": "2024-11-21T10:54:02.151Z",
      "valid_to": "2024-11-21T10:54:02.151Z"
    },
    "status": {
      "op_state": "text",
      "setup_state": "text",
      "last_sync_at": "2024-11-21T10:54:02.151Z"
    },
    "sis_status": {
      "op_state": "text",
      "setup_state": "text",
      "last_sync_at": "2024-11-21T10:54:02.151Z"
    },
    "auth": {
      "type": "text",
      "client_id": "text",
      "client_secret": "password",
      "updated_at": "2024-11-21T10:54:02.151Z"
    }
  },
  "error": {
    "code": "text",
    "message": "text",
    "ext_message": "text",
    "details": "text"
  }
}

List Scoping Schools

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

GEThttps://api.us2.kimonocloud.com/v2/interop/tenant/scoping/schools

Query parameters

Response

200

ScopingSchools response

Body

application/json

dataarray of ScopingSchool (object)

pagingobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.us2.kimonocloud.com/v2/interop/tenant/scoping/schools', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "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": false
    }
  ],
  "paging": {
    "next": "text"
  }
}

Create Scoping Schools

POSThttps://api.us2.kimonocloud.com/v2/interop/tenant/scoping/schools

Query parameters

Body

application/json

One or more Scoping Schools to create

dataarray of ScopingSchool (object)

Response

200400

Success

Body

application/json

dataScopingSchool (object)

errorobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.us2.kimonocloud.com/v2/interop/tenant/scoping/schools', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "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": false
  },
  "error": {
    "code": "text",
    "message": "text",
    "ext_message": "text",
    "details": "text"
  }
}

Delete Scoping Schools

DELETEhttps://api.us2.kimonocloud.com/v2/interop/tenant/scoping/schools

Response

204

Success

Request

JavaScriptCurlPython

const response = await fetch('https://api.us2.kimonocloud.com/v2/interop/tenant/scoping/schools', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Find Scoping School

GEThttps://api.us2.kimonocloud.com/v2/interop/tenant/scoping/schools/{id}

Path parameters

id*string (uuid)

id of the ScopingSchool to find

Response

200

ScopingSchool response

Body

application/json

dataScopingSchool (object)

errorobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.us2.kimonocloud.com/v2/interop/tenant/scoping/schools/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "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": false
  },
  "error": {
    "code": "text",
    "message": "text",
    "ext_message": "text",
    "details": "text"
  }
}

Update Scoping School

PUThttps://api.us2.kimonocloud.com/v2/interop/tenant/scoping/schools/{id}

Path parameters

id*string (uuid)

id of the Scoping School to update

Body

application/json

Scoping School

account_idstring (uuid)

tenant_idstring (uuid)

school_idstring (uuid)

school_ref_idstring

namestring

local_idstring

keywordsstring

selectedboolean

Response

200

ScopingSchool response

Body

application/json

dataScopingSchool (object)

errorobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.us2.kimonocloud.com/v2/interop/tenant/scoping/schools/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "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": false
  },
  "error": {
    "code": "text",
    "message": "text",
    "ext_message": "text",
    "details": "text"
  }
}

Delete Scoping School

DELETEhttps://api.us2.kimonocloud.com/v2/interop/tenant/scoping/schools/{id}

Path parameters

id*string (uuid)

id of the ScopingSchool

Response

204

Success

Request

JavaScriptCurlPython

const response = await fetch('https://api.us2.kimonocloud.com/v2/interop/tenant/scoping/schools/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

List Scoping Courses

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

GEThttps://api.us2.kimonocloud.com/v2/interop/tenant/scoping/courses

Query parameters

Response

200

ScopingCourses response

Body

application/json

dataarray of ScopingCourse (object)

pagingobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.us2.kimonocloud.com/v2/interop/tenant/scoping/courses', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "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": false
    }
  ],
  "paging": {
    "next": "text"
  }
}

Create Scoping Courses

POSThttps://api.us2.kimonocloud.com/v2/interop/tenant/scoping/courses

Query parameters

Body

application/json

One or more Scoping Courses to create

dataarray of ScopingCourse (object)

Response

200400

Success

Body

application/json

dataScopingCourse (object)

errorobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.us2.kimonocloud.com/v2/interop/tenant/scoping/courses', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "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": false
  },
  "error": {
    "code": "text",
    "message": "text",
    "ext_message": "text",
    "details": "text"
  }
}

Delete Scoping Courses

DELETEhttps://api.us2.kimonocloud.com/v2/interop/tenant/scoping/courses

Response

204

Success

Request

JavaScriptCurlPython

const response = await fetch('https://api.us2.kimonocloud.com/v2/interop/tenant/scoping/courses', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Find Scoping Course

GEThttps://api.us2.kimonocloud.com/v2/interop/tenant/scoping/courses/{id}

Path parameters

id*string (uuid)

id of the ScopingCourse to find

Response

200

ScopingCourse response

Body

application/json

dataScopingCourse (object)

errorobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.us2.kimonocloud.com/v2/interop/tenant/scoping/courses/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "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": false
  },
  "error": {
    "code": "text",
    "message": "text",
    "ext_message": "text",
    "details": "text"
  }
}

Update Scoping Course

PUThttps://api.us2.kimonocloud.com/v2/interop/tenant/scoping/courses/{id}

Path parameters

id*string (uuid)

id of the Scoping Course to update

Body

application/json

Scoping Course

account_idstring (uuid)

tenant_idstring (uuid)

course_idstring (uuid)

course_ref_idstring

school_idstring (uuid)

school_ref_idstring

namestring

local_idstring

keywordsstring

selectedboolean

Response

200

ScopingCourse response

Body

application/json

dataScopingCourse (object)

errorobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.us2.kimonocloud.com/v2/interop/tenant/scoping/courses/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "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": false
  },
  "error": {
    "code": "text",
    "message": "text",
    "ext_message": "text",
    "details": "text"
  }
}

Delete Scoping Course

DELETEhttps://api.us2.kimonocloud.com/v2/interop/tenant/scoping/courses/{id}

Path parameters

id*string (uuid)

id of the ScopingCourse

Response

204

Success

Request

JavaScriptCurlPython

const response = await fetch('https://api.us2.kimonocloud.com/v2/interop/tenant/scoping/courses/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();