Sana Assignments API

The Assignments API from Sana — 1 operation(s) for assignments.

OpenAPI Specification

sana-assignments-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Sana Assignments API
  version: v0/v1
  description: Sana's REST API for the Sana AI knowledge/learning platform. Programmatic access to users, groups, programs, assignments, courses, paths, teamspaces, reporting/Insights, and xAPI statements. Authentication is OAuth 2.0 client credentials returning a bearer token; GET requests require the `read` scope and write requests require the `write` scope. The API is served per tenant at https://<domain>.sana.ai.
  contact:
    name: Sana API Documentation
    url: https://docs.sana.ai/api-docs/
servers:
- url: https://{domain}.sana.ai
  description: Per-tenant Sana host
  variables:
    domain:
      default: app
      description: Your Sana workspace subdomain
security:
- bearerAuth: []
tags:
- name: Assignments
paths:
  /api/v0/users/{userId}/assignments:
    get:
      operationId: listUserAssignments
      tags:
      - Assignments
      summary: List a user's assignments
      parameters:
      - $ref: '#/components/parameters/userId'
      responses:
        '200':
          description: A list of assignments
    post:
      operationId: assignContentToUser
      tags:
      - Assignments
      summary: Assign content to a user
      parameters:
      - $ref: '#/components/parameters/userId'
      responses:
        '200':
          description: Content assigned
    delete:
      operationId: removeUserAssignment
      tags:
      - Assignments
      summary: Remove an assignment from a user
      parameters:
      - $ref: '#/components/parameters/userId'
      responses:
        '204':
          description: Assignment removed
components:
  parameters:
    userId:
      name: userId
      in: path
      required: true
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer access token obtained from POST /api/token via the OAuth 2.0 client credentials grant.
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{domain}.sana.ai/api/token
          scopes:
            read: Read access (required for GET requests)
            write: Write access (required for POST, PATCH, DELETE requests)