Skip to content

trilogy-group/oneroster-ts

BranchesTags

Repository files navigation

oneroster

Developer-friendly & type-safe Typescript SDK specifically catered to leverage oneroster API.

Summary

OneRoster API: # Authentication

All endpoints require authentication using the Authorization: Bearer <token> header.

The token can be obtained with:

curl -X POST https://alpha-auth-development-idp.auth.us-west-2.amazoncognito.com/oauth2/token \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "grant_type=client_credentials&client_id=<your-client-id>&client_secret=<your-client-secret>"

Use the correct IDP server depending on the environment you're using:

Reach out to the platform team to get a client/secret pair for your application.

Pagination

Our API uses offset pagination for list endpoints. Paginated responses include the following fields:

  • offset: Offset for the next page of results
  • limit: Number of items per page (default: 100)

Example request:

GET /ims/oneroster/rostering/v1p2/users?offset=20&limit=20

All listing endpoints support offset pagination.

Filtering

All listing endpoints support filtering using the filter query parameter, following 1EdTech's filtering specification.

The filter should be a string with the following format:

?filter=[field][operator][value]

Example request:

GET /ims/oneroster/rostering/v1p2/users?filter=status='active'

Example request with multiple filters:

GET /ims/oneroster/rostering/v1p2/users?filter=status='active' AND name='John'

Filtering by nested relations is not supported.

Sorting

All listing endpoints support sorting using the sort and orderBy query parameters, following 1EdTech's sorting specification

Example request:

GET /ims/oneroster/rostering/v1p2/users?sort=lastName&orderBy=asc

Table of Contents

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @superbuilders/oneroster

PNPM

pnpm add @superbuilders/oneroster

Bun

bun add @superbuilders/oneroster

Yarn

yarn add @superbuilders/oneroster zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

Note

This package is published with CommonJS and ES Modules (ESM) support.

Model Context Protocol (MCP) Server

This SDK is also an installable MCP server where the various SDK methods are exposed as tools that can be invoked by AI applications.

Node.js v20 or greater is required to run the MCP server from npm.

Claude installation steps

Add the following server definition to your claude_desktop_config.json file:

{
  "mcpServers": {
    "OneRoster": {
      "command": "npx",
      "args": [
        "-y", "--package", "@superbuilders/oneroster",
        "--",
        "mcp", "start",
        "--client-id", "...",
        "--client-secret", "...",
        "--token-url", "..."
      ]
    }
  }
}
Cursor installation steps

Create a .cursor/mcp.json file in your project root with the following content:

{
  "mcpServers": {
    "OneRoster": {
      "command": "npx",
      "args": [
        "-y", "--package", "@superbuilders/oneroster",
        "--",
        "mcp", "start",
        "--client-id", "...",
        "--client-secret", "...",
        "--token-url", "..."
      ]
    }
  }
}

You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:

curl -L -o mcp-server \
    https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
chmod +x mcp-server

If the repo is a private repo you must add your Github PAT to download a release -H "Authorization: Bearer {GITHUB_PAT}".

{
  "mcpServers": {
    "Todos": {
      "command": "./DOWNLOAD/PATH/mcp-server",
      "args": [
        "start"
      ]
    }
  }
}

For a full list of server arguments, run:

npx -y --package @superbuilders/oneroster -- mcp start --help

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { OneRoster } from "@superbuilders/oneroster";

const oneRoster = new OneRoster({
  security: {
    clientID: process.env["ONEROSTER_CLIENT_ID"] ?? "",
    clientSecret: process.env["ONEROSTER_CLIENT_SECRET"] ?? "",
  },
});

async function run() {
  const result = await oneRoster.scoreScalesManagement.getAllScoreScales({
    fields: "sourcedId,name",
    filter: "status='active'",
  });

  for await (const page of result) {
    // Handle the page
    console.log(page);
  }
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme Environment Variable
clientID
clientSecret		 oauth2 OAuth2 Client Credentials Flow ONEROSTER_CLIENT_ID
ONEROSTER_CLIENT_SECRET
ONEROSTER_TOKEN_URL

You can set the security parameters through the security optional parameter when initializing the SDK client instance. For example:

import { OneRoster } from "@superbuilders/oneroster";

const oneRoster = new OneRoster({
  security: {
    clientID: process.env["ONEROSTER_CLIENT_ID"] ?? "",
    clientSecret: process.env["ONEROSTER_CLIENT_SECRET"] ?? "",
  },
});

async function run() {
  const result = await oneRoster.scoreScalesManagement.getAllScoreScales({
    fields: "sourcedId,name",
    filter: "status='active'",
  });

  for await (const page of result) {
    // Handle the page
    console.log(page);
  }
}

run();

Available Resources and Operations

Available methods

academicSessionsManagement

assessmentLineItemsManagement

assessmentResultsManagement

categoriesManagement

classesManagement

courseComponentResourcesManagement

courseComponentsManagement

coursesManagement

demographicsManagement

enrollmentsManagement

gradingPeriodsManagement

lineItemsManagement

organizationsManagement

resourcesClassesManagement

resourcesCoursesManagement

resourcesManagement

resourcesUsersManagement

resultsManagement

schoolsManagement

scoreScalesManagement

studentsManagement

teachersManagement

termsManagement

usersManagement

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Available standalone functions

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will also be an async iterable that can be consumed using the for await...of syntax.

Here's an example of one such pagination call:

import { OneRoster } from "@superbuilders/oneroster";

const oneRoster = new OneRoster({
  security: {
    clientID: process.env["ONEROSTER_CLIENT_ID"] ?? "",
    clientSecret: process.env["ONEROSTER_CLIENT_SECRET"] ?? "",
  },
});

async function run() {
  const result = await oneRoster.scoreScalesManagement.getAllScoreScales({
    fields: "sourcedId,name",
    filter: "status='active'",
  });

  for await (const page of result) {
    // Handle the page
    console.log(page);
  }
}

run();

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { OneRoster } from "@superbuilders/oneroster";

const oneRoster = new OneRoster({
  security: {
    clientID: process.env["ONEROSTER_CLIENT_ID"] ?? "",
    clientSecret: process.env["ONEROSTER_CLIENT_SECRET"] ?? "",
  },
});

async function run() {
  const result = await oneRoster.scoreScalesManagement.getAllScoreScales({
    fields: "sourcedId,name",
    filter: "status='active'",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  for await (const page of result) {
    // Handle the page
    console.log(page);
  }
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { OneRoster } from "@superbuilders/oneroster";

const oneRoster = new OneRoster({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  security: {
    clientID: process.env["ONEROSTER_CLIENT_ID"] ?? "",
    clientSecret: process.env["ONEROSTER_CLIENT_SECRET"] ?? "",
  },
});

async function run() {
  const result = await oneRoster.scoreScalesManagement.getAllScoreScales({
    fields: "sourcedId,name",
    filter: "status='active'",
  });

  for await (const page of result) {
    // Handle the page
    console.log(page);
  }
}

run();

Error Handling

Some methods specify known errors which can be thrown. All the known errors are enumerated in the models/errors/errors.ts module. The known errors for a method are documented under the Errors tables in SDK docs. For example, the getAllScoreScales method may throw the following errors:

Error Type Status Code Content Type
errors.BadRequestResponseError1 400 application/json
errors.UnauthorizedRequestResponseError1 401 application/json
errors.ForbiddenResponseError1 403 application/json
errors.NotFoundResponseError1 404 application/json
errors.UnprocessableEntityResponseError1 422 application/json
errors.TooManyRequestsResponseError1 429 application/json
errors.InternalServerErrorResponse1 500 application/json
errors.APIError 4XX, 5XX */*

If the method throws an error and it is not captured by the known errors, it will default to throwing a APIError.

import { OneRoster } from "@superbuilders/oneroster";
import {
  BadRequestResponseError1,
  ForbiddenResponseError1,
  InternalServerErrorResponse1,
  NotFoundResponseError1,
  SDKValidationError,
  TooManyRequestsResponseError1,
  UnauthorizedRequestResponseError1,
  UnprocessableEntityResponseError1,
} from "@superbuilders/oneroster/models/errors";

const oneRoster = new OneRoster({
  security: {
    clientID: process.env["ONEROSTER_CLIENT_ID"] ?? "",
    clientSecret: process.env["ONEROSTER_CLIENT_SECRET"] ?? "",
  },
});

async function run() {
  let result;
  try {
    result = await oneRoster.scoreScalesManagement.getAllScoreScales({
      fields: "sourcedId,name",
      filter: "status='active'",
    });

    for await (const page of result) {
      // Handle the page
      console.log(page);
    }
  } catch (err) {
    switch (true) {
      // The server response does not match the expected SDK schema
      case (err instanceof SDKValidationError): {
        // Pretty-print will provide a human-readable multi-line error message
        console.error(err.pretty());
        // Raw value may also be inspected
        console.error(err.rawValue);
        return;
      }
      case (err instanceof BadRequestResponseError1): {
        // Handle err.data$: BadRequestResponseError1Data
        console.error(err);
        return;
      }
      case (err instanceof UnauthorizedRequestResponseError1): {
        // Handle err.data$: UnauthorizedRequestResponseError1Data
        console.error(err);
        return;
      }
      case (err instanceof ForbiddenResponseError1): {
        // Handle err.data$: ForbiddenResponseError1Data
        console.error(err);
        return;
      }
      case (err instanceof NotFoundResponseError1): {
        // Handle err.data$: NotFoundResponseError1Data
        console.error(err);
        return;
      }
      case (err instanceof UnprocessableEntityResponseError1): {
        // Handle err.data$: UnprocessableEntityResponseError1Data
        console.error(err);
        return;
      }
      case (err instanceof TooManyRequestsResponseError1): {
        // Handle err.data$: TooManyRequestsResponseError1Data
        console.error(err);
        return;
      }
      case (err instanceof InternalServerErrorResponse1): {
        // Handle err.data$: InternalServerErrorResponse1Data
        console.error(err);
        return;
      }
      default: {
        // Other errors such as network errors, see HTTPClientErrors for more details
        throw err;
      }
    }
  }
}

run();

Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.

In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the models/errors/httpclienterrors.ts module:

HTTP Client Error Description
RequestAbortedError HTTP request was aborted by the client
RequestTimeoutError HTTP request timed out due to an AbortSignal signal
ConnectionError HTTP client was unable to make a request to a server
InvalidRequestError Any input used to create a request is invalid
UnexpectedClientError Unrecognised or unexpected error

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { OneRoster } from "@superbuilders/oneroster";

const oneRoster = new OneRoster({
  serverURL: "https://api.staging.alpha-1edtech.com",
  security: {
    clientID: process.env["ONEROSTER_CLIENT_ID"] ?? "",
    clientSecret: process.env["ONEROSTER_CLIENT_SECRET"] ?? "",
  },
});

async function run() {
  const result = await oneRoster.scoreScalesManagement.getAllScoreScales({
    fields: "sourcedId,name",
    filter: "status='active'",
  });

  for await (const page of result) {
    // Handle the page
    console.log(page);
  }
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { OneRoster } from "@superbuilders/oneroster";
import { HTTPClient } from "@superbuilders/oneroster/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new OneRoster({ httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

Warning

Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { OneRoster } from "@superbuilders/oneroster";

const sdk = new OneRoster({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable ONEROSTER_DEBUG to true.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy

About

TypeScript SDK for the 1EdTech OneRoster API

Resources

Readme

License

0BSD license

Security policy

Security policy
Activity
Custom properties

Stars

5 stars

Watchers

7 watching

Forks

2 forks
Report repository

Releases 11

typescript - v0.6.3 - 2025-05-01 14:30:23 Latest
May 1, 2025
+ 10 releases

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages