openapi: 3.0.1
info:
  title: Sana Assignments Groups API
  description: Tenant-scoped REST API for the Sana platform (Sana AI / Sana Agents and Sana Learn). All requests are authenticated with a Bearer access token obtained via the OAuth 2.0 client credentials flow and are scoped to a customer's <domain>.sana.ai tenant. The endpoints below are transcribed from Sana's public API reference and cover platform administration (users, groups, programs, courses, paths, assignments, teamspaces), reporting/insights, and standards-based integration surfaces (xAPI). SCIM 2.0 provisioning is offered at /scim/v2 and is not modeled here. AI agent/assistant capabilities are configured primarily in-product and are not exposed as a public chat-completions endpoint in this reference. No endpoints are fabricated; replace <domain> with your tenant domain.
  termsOfService: https://sanalabs.com/legal
  contact:
    name: Sana
    url: https://docs.sana.ai/api-docs/
  version: '0.0'
servers:
- url: https://<domain>.sana.ai
  description: Tenant-scoped base URL; replace <domain> with your Sana tenant.
security:
- bearerAuth: []
tags:
- name: Groups
paths:
  /api/v0/groups:
    get:
      operationId: listGroups
      tags:
      - Groups
      summary: List all groups.
      responses:
        '200':
          description: OK
    post:
      operationId: createGroup
      tags:
      - Groups
      summary: Create a group.
      responses:
        '200':
          description: OK
  /api/v0/groups/{groupId}:
    parameters:
    - name: groupId
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: getGroup
      tags:
      - Groups
      summary: Get a group.
      responses:
        '200':
          description: OK
    patch:
      operationId: updateGroup
      tags:
      - Groups
      summary: Update a group.
      responses:
        '200':
          description: OK
    delete:
      operationId: deleteGroup
      tags:
      - Groups
      summary: Delete a group.
      responses:
        '200':
          description: OK
  /api/v0/groups/{groupId}/users:
    parameters:
    - name: groupId
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: listGroupUsers
      tags:
      - Groups
      summary: List users in a group.
      responses:
        '200':
          description: OK
    post:
      operationId: addGroupUsers
      tags:
      - Groups
      summary: Add users to a group.
      responses:
        '200':
          description: OK
  /api/v0/groups/{groupId}/users/{userId}:
    parameters:
    - name: groupId
      in: path
      required: true
      schema:
        type: string
    - name: userId
      in: path
      required: true
      schema:
        type: string
    patch:
      operationId: updateGroupUser
      tags:
      - Groups
      summary: Update a user in a group.
      responses:
        '200':
          description: OK
    delete:
      operationId: deleteGroupUser
      tags:
      - Groups
      summary: Delete a user from a group.
      responses:
        '200':
          description: OK
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Bearer access token obtained from POST /api/token via the OAuth 2.0 client credentials flow. Sent as: Authorization: Bearer <accessToken>.'