v1

latestOpenAPI 3.0.0Apache 2.02026-08-0610023171.4 KB
OneRoster

Get OneRoster sync configuration

Return the OneRoster sync configuration record for the given group. The authenticated user must be an owner of the group.

When no configuration has been saved yet, data is returned with all fields set to null.

get/api/v1/groups/oneroster-sync-data/{id}/

Response

The request succeeded and returned the OneRoster sync configuration for the group.

successboolean

Example response

{
  "success": true,
  "data": {
    "id": 7,
    "status": 3,
    "url": "ftps://user:password@ftp.example.com/oneroster/",
    "last_synced_at": 1716800000
  }
}