For Developers

Troubleshooting Issues

Incorrect Configuration Settings or Keys

Most problems with Synergy integrations are due to incorrect configuration settings.

Incorrect Authentication Method

OAuth 2.0 is the recommended method for authenticating with the OneRoster API. Please select this method whenever possible.

OAuth 1.0 is an older authentication method that has been deprecated.

Client ID

The Client ID is the client ID that you use to connect to the server. Example: edlink

Client Secret

The Client Secret is the client secret that you use to connect to the server. Example: 26yDxcltbkmn554rs1D9wj

Server URL

The Server URL is the URL of the server that you want to connect to. Example: https://certification.imsglobal.org/or12ctsapi/ims/oneroster/rostering/v1p2

Token URL

The Token URL is the URL of the server that you use to get authentication tokens. Example: https://oauth2server.imsglobal.org/oauth2server/clienttoken

Incorrect Timezone for Assignments

If assignments are showing with incorrect due dates, please make sure that you have selected the correct time zone. The OneRoster specification does not use a time format that includes timezone information. This means that the timezone must be set in the Edlink UI.

Select Timezone

Incorrect Scopes (Permissions)

It's possible for OneRoster requests to fail if the client does not have the correct scopes. For example, if the client does not have access to the https://purl.imsglobal.org/spec/or/v1p1/scope/gradebook.readonly scope, then gradepassback requests will fail. Check to make sure that the client has the correct scopes.