Not logged in - Login
< back

SDK Provisioning Integration

Contents [hide]

Provisioning Integration

Limitations

SIMS ID does not provide all the data that exists within SIMS and it is not a replacement for the rich data available through the SIMS Partner programme’s APIs; SIMS ID can pass lightweight data suitable for user provisioning and group association; this data can also be passed securely using a range of protocols.

Approaches to Provisioning

SIMS ID has a provisioning API that exposes a subset of data; Access to this API is restricted to secure access using the SIMS ID STS.

The SIMS ID Provisioning API is defined by Swagger.

Swagger is a tool used to provide a list of SIMS ID APIs. This forms the API documentation and will be available on a public URL.

The following data (subject to the agreement of the data controller) will be available for sites that are aligned with your product.

User information

  • Name

  • Groups/class/house/year

  • Age range eg <13 / >16

  • Unique ID

Site information

  • Name

  • DFE

  • Unique ID

For a complete list of available information please refer to the SWAGGER endpoint for the relevant API below

API endpoint

A Swagger documented API is available on the SIMS ID Partner Development Platform for Provisioning Integrators to develop against. A corresponding endpoint will be made available to Partners in the live environment.

Provisioning API Swagger endpoint

Swagger endpoint for the SIMS ID Provisioning API

This endpoint matches the available API calls in the live environment but is backed by the Dummy Data.

IMS Global One Roster API.

During Q1 of 2018 am IMS Global One Roster compliant API will be launched to support integrators that favour this format.

A Swagger documented API is available on the SIMS ID Partner Development Platform for Provisioning Integrators to develop against. A corresponding endpoint will be made available to Partners in the live environment.

The One Roster specification is available from the IMS Global Site

Provisioning API Swagger endpoint

Swagger endpoint for the SIMS ID IMS Global One Roster Provisioning API

This endpoint matches the avaialble API calls in the live environment but is backed by the Dummy Data.

SDK Main Page | Authentication & SSO | Provisioning Integration | SIMS ID a stable integration platform