OneRoster
Run OneRoster sync manually
Trigger an immediate OneRoster roster synchronisation for the given group. The authenticated user must be an owner of the group and a saved, enabled sync configuration must exist.
The server reads enrollments.csv and users.csv from the configured FTP endpoint and creates, updates, or removes group members accordingly. OneRoster roles are mapped as follows: student → student member, teacher → teacher member, administrator → owner member.
Returns 400 when no configuration exists, the FTP connection fails, the CSV files are missing or empty, or a file contains more than 1 000 records.
post/api/v1/groups/oneroster-sync/{id}/
Path parameters
idinteger required
Numeric resource ID.
Response
The request succeeded and returned the OneRoster sync configuration for the group.
Example response
{
"success": true,
"data": {
"id": 7,
"status": 3,
"url": "ftps://user:password@ftp.example.com/oneroster/",
"last_synced_at": 1716800000
}
}