Interop API

List Interop Tenants

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

get

/tenants

Authorizations

Query parameters

accountsstring · uuid[]

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

integrationsstring[]

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 · int32

Specify the page number (defaults to 0)

page_sizeinteger · int32

Specify the page_size (defaults to the maximum page size)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.us2.kimonocloud.com/v2/interop/tenants' \
  --header 'Authorization: Basic username:password'

200

200

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "status": {
        "op_state": "text",
        "setup_state": "text",
        "last_sync_at": "2025-02-20T19:03:03.422Z"
      },
      "sis_status": {
        "op_state": "text",
        "setup_state": "text",
        "last_sync_at": "2025-02-20T19:03:03.422Z"
      },
      "auth": {
        "type": "text",
        "client_id": "text",
        "client_secret": "super-secret",
        "updated_at": "2025-02-20T19:03:03.422Z"
      },
      "account": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "public_id": "text",
        "timezone": "text",
        "userdata": "text"
      },
      "integration": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "version": "text"
      },
      "license": {
        "status": "text",
        "valid_from": "2025-02-20T19:03:03.422Z",
        "valid_to": "2025-02-20T19:03:03.422Z"
      },
      "cloud": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "generation": 1,
        "env": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        }
      }
    }
  ],
  "paging": {
    "next": "text"
  }
}

TenantInfos response

Find Interop Tenant

get

/tenants/{id}

Authorizations

Path parameters

idstring · uuidrequired

id of the TenantInfo to find

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.us2.kimonocloud.com/v2/interop/tenants/{id}'

200

200

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "status": {
      "op_state": "text",
      "setup_state": "text",
      "last_sync_at": "2025-02-20T19:03:03.422Z"
    },
    "sis_status": {
      "op_state": "text",
      "setup_state": "text",
      "last_sync_at": "2025-02-20T19:03:03.422Z"
    },
    "auth": {
      "type": "text",
      "client_id": "text",
      "client_secret": "super-secret",
      "updated_at": "2025-02-20T19:03:03.422Z"
    },
    "account": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "public_id": "text",
      "timezone": "text",
      "userdata": "text"
    },
    "integration": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "version": "text"
    },
    "license": {
      "status": "text",
      "valid_from": "2025-02-20T19:03:03.422Z",
      "valid_to": "2025-02-20T19:03:03.422Z"
    },
    "cloud": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "generation": 1,
      "env": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      }
    }
  },
  "error": {
    "status": 1,
    "code": "text",
    "message": "text",
    "ext_message": "text",
    "details": "text"
  }
}

TenantInfo response

List Scoping Schools

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

get

/tenant/scoping/schools

Authorizations

Query parameters

pageinteger · int32

Specify the page number (defaults to 0)

page_sizeinteger · int32

Specify the page_size (defaults to the maximum page size)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.us2.kimonocloud.com/v2/interop/tenant/scoping/schools'

200

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

ScopingSchools response

Create Scoping Schools

post

/tenant/scoping/schools

Authorizations

Query parameters

replaceboolean · default: true

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

Body

dataobject[]

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.us2.kimonocloud.com/v2/interop/tenant/scoping/schools' \
  --header 'Content-Type: application/json' \
  --data '{"data":[{}]}'

200

400

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

Success

Delete Scoping Schools

delete

/tenant/scoping/schools

Authorizations

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.us2.kimonocloud.com/v2/interop/tenant/scoping/schools'

204

204

No body

Success

Find Scoping School

get

/tenant/scoping/schools/{id}

Authorizations

Path parameters

idstring · uuidrequired

id of the ScopingSchool to find

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.us2.kimonocloud.com/v2/interop/tenant/scoping/schools/{id}'

200

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

ScopingSchool response

Update Scoping School

put

/tenant/scoping/schools/{id}

Authorizations

Path parameters

idstring · uuidrequired

id of the Scoping School to update

Body

account_idstring · uuid

tenant_idstring · uuid

school_idstring · uuid

school_ref_idstring

namestring

local_idstring

keywordsstring

selectedboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.us2.kimonocloud.com/v2/interop/tenant/scoping/schools/{id}' \
  --header 'Content-Type: application/json'

200

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

ScopingSchool response

Delete Scoping School

delete

/tenant/scoping/schools/{id}

Authorizations

Path parameters

idstring · uuidrequired

id of the ScopingSchool

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.us2.kimonocloud.com/v2/interop/tenant/scoping/schools/{id}'

204

204

No body

Success

List Scoping Courses

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

get

/tenant/scoping/courses

Authorizations

Query parameters

pageinteger · int32

Specify the page number (defaults to 0)

page_sizeinteger · int32

Specify the page_size (defaults to the maximum page size)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.us2.kimonocloud.com/v2/interop/tenant/scoping/courses'

200

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

ScopingCourses response

Create Scoping Courses

post

/tenant/scoping/courses

Authorizations

Query parameters

replaceboolean · default: true

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

Body

dataobject[]

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.us2.kimonocloud.com/v2/interop/tenant/scoping/courses' \
  --header 'Content-Type: application/json' \
  --data '{"data":[{}]}'

200

400

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

Success

Delete Scoping Courses

delete

/tenant/scoping/courses

Authorizations

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.us2.kimonocloud.com/v2/interop/tenant/scoping/courses'

204

204

No body

Success

Find Scoping Course

get

/tenant/scoping/courses/{id}

Authorizations

Path parameters

idstring · uuidrequired

id of the ScopingCourse to find

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.us2.kimonocloud.com/v2/interop/tenant/scoping/courses/{id}'

200

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

ScopingCourse response

Update Scoping Course

put

/tenant/scoping/courses/{id}

Authorizations

Path parameters

idstring · uuidrequired

id of the Scoping Course to update

Body

account_idstring · uuid

tenant_idstring · uuid

course_idstring · uuid

course_ref_idstring

school_idstring · uuid

school_ref_idstring

namestring

local_idstring

keywordsstring

selectedboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.us2.kimonocloud.com/v2/interop/tenant/scoping/courses/{id}' \
  --header 'Content-Type: application/json'

200

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

ScopingCourse response

Delete Scoping Course

delete

/tenant/scoping/courses/{id}

Authorizations

Path parameters

idstring · uuidrequired

id of the ScopingCourse

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.us2.kimonocloud.com/v2/interop/tenant/scoping/courses/{id}'

204

204

No body

Success