Requirements
You need to have Postman installed.
- Verify that the OneRoster REST API is installed into the studio tenant.
- Run the Mappings jobs for this consumer.
- Set up the API testing URL using your tenant name.Use the URL format: https://[tenant name].dev-rapididentity.com with the appropriate endpoint.Available endpoints:
- https://[tenant name]/api/rest/studio/ims/oneroster/v1p1/schools
- https://[tenant name]/api/rest/studio/ims/oneroster/v1p1/users
- https://[tenant name]/api/rest/studio/ims/oneroster/v1p1/classes
- https://[tenant name]/api/rest/studio/ims/oneroster/v1p1/enrollments
- https://[tenant name]/api/rest/studio/ims/oneroster/v1p1/courses
- Create the key and consumer secret for the target application.Navigate to Application > Configure > Connection Settings
- Configure Postman with the following settings:
- Select OAuth 1.0 as the Authorization Type
- Set HMAC-SHA256 as the Signature Method
- Enter the Consumer Key and Consumer Secret values as configured on the Tenant
- Set the HTTP verb as GET
- Trigger the API and verify the response.You should receive a 200(OK) success response message.