Please note, this is a v1 model. There is not currently an equivalent v2 model. It is OK to rely on this model, we are not planning to deprecate it. The only reason there's not a v2 equavalent is that it would have been substantially similar to this one.
An Integration is a connection between a Source (e.g., Canvas) and your Application.
Integrations may be scoped to either the entire data source, or particular schools / courses within the data source. We encourage administrators and developers to reduce the scope of data sharing to only essential people and organizational units to reduce data transfer requirements and security risks. In addition to scoping the available data that developers can access, administrators can also limit the access and functionality of particular applications. When setting up your application, you are able to define your requested permissions. Administrators can choose to grant or deny this privileges when they are establishing an integration.
Integration Access Tokens
Upon establishing an integration, a new access token is generated for the developer. This access token will be used to access Graph API data for the particular integration. The token is automatically scoped to the correct set of people, organizations, and permissions, so you do not have to worry about accessing data that is unauthorized.
Please note, this is a v1 model. There is not currently an equivalent v2 model. It is OK to rely on this model, we are not planning to deprecate it. The only reason there's not a v2 equavalent is that it would have been substantially similar to this one.
Properties
| Property | Type | Description |
|---|---|---|
id | UUID | A stable UUID representing this integration. |
created_date | Date | The date upon which this integration was initially created. |
updated_date | Date | The latest time upon which this integration was updated. |
permissions | Array | An array of UUIDs representing the permissions that this integration has access to. |
scope | String | Can be either all or selected. Whether the integration has access to all data from this source, or it is limited to certain schools / courses. |
targets | Array | Optional. If scope is selected, this contains an array of UUIDs to which the integration has access. |
status | String | The status of this integration. Either inactive, active, or disabled. |
access_token | String | The access token that you can use to access Graph API data for this integration. |
application | Application | Optional. Provided only for Clever and Classlink connections. |
source | Source | Metadata about the source to which this integration connects. |
team | Team | Metadata about the school to whom this source belongs. |
provider | Provider | Metadata about the source data system (e.g., Canvas). |
entity | Entity | The real-world school or district to whom this source belongs. |
Additional Notes
- The
access_tokenwill not change if permissions or targets are changed. However, it will change if an integration is destroyed and then recreated. - The
sourcecannot currently be changed after it is set. In order to provide a develop access to a new source, administrators must create a new integration. - The
applicationparameter can be safely ignored. It is used primarily for internal purposes. - Integrations will have a status of
inactiveif they are scheduled to start automatically at a later date. - Requests to retrieve graph data will be denied if integrations are set to
inactiveordisabled.