Sana Users API

openapi: 3.1.0
info:
  title: Sana Assignments Users 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: Users
paths:
  /api/v0/users:
    get:
      operationId: listUsers
      tags:
      - Users
      summary: List all users
      parameters:
      - $ref: '#/components/parameters/next'
      - $ref: '#/components/parameters/limit'
      responses:
        '200':
          description: A page of users
    post:
      operationId: createUser
      tags:
      - Users
      summary: Create a user
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - email
              properties:
                email:
                  type: string
                  format: email
                firstName:
                  type: string
                lastName:
                  type: string
                role:
                  type: string
                  enum:
                  - learner
                  - group-admin
                  - admin
                language:
                  type: string
                  description: IETF BCP 47 language tag
                customAttributes:
                  type: object
                  additionalProperties: true
      responses:
        '201':
          description: User created
  /api/v0/users/{userId}:
    get:
      operationId: getUser
      tags:
      - Users
      summary: Retrieve a specific user
      parameters:
      - $ref: '#/components/parameters/userId'
      responses:
        '200':
          description: A user
    patch:
      operationId: updateUser
      tags:
      - Users
      summary: Update a user
      parameters:
      - $ref: '#/components/parameters/userId'
      responses:
        '200':
          description: User updated
    delete:
      operationId: deleteUser
      tags:
      - Users
      summary: Delete a user
      parameters:
      - $ref: '#/components/parameters/userId'
      responses:
        '204':
          description: User deleted
  /api/v0/users/{userId}/send-invite:
    post:
      operationId: sendUserInvite
      tags:
      - Users
      summary: Send an invite email to a user
      parameters:
      - $ref: '#/components/parameters/userId'
      responses:
        '200':
          description: Invite sent
  /api/v0/users/{userId}/invite-link:
    post:
      operationId: createUserInviteLink
      tags:
      - Users
      summary: Generate a new invite link for a user
      parameters:
      - $ref: '#/components/parameters/userId'
      responses:
        '200':
          description: Invite link generated
  /api/v0/users/{userId}/groups:
    get:
      operationId: listUserGroups
      tags:
      - Users
      summary: List a user's groups
      parameters:
      - $ref: '#/components/parameters/userId'
      responses:
        '200':
          description: A list of groups
  /api/v0/users/{userId}/manager/{managerId}:
    put:
      operationId: setUserManager
      tags:
      - Users
      summary: Set a user's manager
      parameters:
      - $ref: '#/components/parameters/userId'
      - name: managerId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Manager set
  /api/v0/users/{userId}/manager:
    delete:
      operationId: removeUserManager
      tags:
      - Users
      summary: Remove a user's manager
      parameters:
      - $ref: '#/components/parameters/userId'
      responses:
        '204':
          description: Manager removed
  /api/v0/users/attributes-schema:
    get:
      operationId: getUserAttributesSchema
      tags:
      - Users
      summary: List the custom attribute schema
      responses:
        '200':
          description: Attribute schema
components:
  parameters:
    limit:
      name: limit
      in: query
      required: false
      description: Number of items to return (default 100, max 1000)
      schema:
        type: integer
        default: 100
        maximum: 1000
    next:
      name: next
      in: query
      required: false
      description: Cursor to fetch the next batch of results
      schema:
        type: string
    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)