> ## Documentation Index
> Fetch the complete documentation index at: https://docs.praxis-ai.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Connect a learner's Blackboard Learn account to a Digital Twin's course tools
> Blackboard Learn sends the learner's browser here after they open the sign-in link a
Digital Twin gave them in a chat (the twin then reads their Blackboard course with their own,
read-only access). A link works once and for 10 minutes. The page that answers says
whether Blackboard is now connected; the learner then goes back to the chat and asks again.
Only the Blackboard account the learner uses in this course can be connected: the one they
opened the Digital Twin from in Blackboard. Nothing is connected otherwise.
## OpenAPI
````yaml /mdx/api-reference/admin/admin-api.json get /api/auth/blackboard_tool_complete
openapi: 3.0.0
info:
title: Pria Admin API
version: 2.0.282
description: >-
Pria API Documentation Praxis's developer platform is a core part of our
mission to empower organizations to grow better. Our APIs are designed to
enable teams of any shape or size to build robust integrations that help
them customize and get the most value out of Pria. All Pria APIs are built
using REST conventions and designed to have a predictable URL structure.
They use many standard HTTP features, including methods (POST,
GET, PUT, DELETE) and error response codes.
All API calls are
made under https://hiimpria.ai/api and all responses return standard JSON.
In these docs, you'll find lists of all available endpoints for a given API,
along with interactive code blocks for building requests. For walkthroughs
of basic usage for these APIs, check out the API guides.
A
session that a course page (Canvas) opened for an administrator — or that a
Digital Twin's sign-in provider opened for one of its people — starts with
user rights in that twin only: until the person confirms it's them with a
code (POST /api/user/launch-scope/challenge, then /api/auth/mfa-resend and
/api/auth/mfa-verify), every route outside that twin's day-to-day work
answers 403 with code LAUNCH_SCOPE_STEP_UP and the twin's id.
servers:
- url: https://hiimpria.ai
description: Pria API Server
security: []
tags:
- name: Authentication
description: User authentication, registration, and password management (/api/auth)
- name: OAuth
description: OAuth authentication providers - Google, GitHub, SSO (/api/auth/oauth)
- name: User
description: User profile management and account operations (/api/user)
- name: User Institutions
description: User institution memberships and switching (/api/user/institution)
- name: User Tools
description: Available tools for authenticated users (/api/user/tools)
- name: Institutions
description: Institution settings and configuration (/api/user/institution)
- name: Conversation
description: AI conversation and Q&A endpoints (/api/ai)
- name: Realtime
description: Real-time voice AI and WebRTC sessions (/api/ai/rt)
- name: Assistant
description: AI assistant configuration and management (/api/user/assistant)
- name: History
description: Conversation history and favorites (/api/user/history)
- name: RAG
description: >-
Document upload, embedding, and retrieval-augmented generation
(/api/user/files, /api/user/rag)
- name: Setting
description: Instance variables and settings management (/api/user/setting)
- name: Branding
description: Digital twin branding and customization (/api/agent/branding)
- name: Agent
description: Agent engagement and session management (/api/agent)
- name: SDK Launch
description: >-
SDK launch token signing and verification for secure iframe embedding
(/api/auth/sdk-sign, /api/auth/sdk-verify)
- name: Testing
description: Health checks, diagnostics, and test endpoints (/api/test)
- name: Admin Accounts
description: Account management for account managers (/api/admin/account)
- name: Admin Institutions
description: Institution management for admins (/api/admin/institution)
- name: Admin Users
description: User management for admins (/api/admin/user)
- name: Admin Entitlements
description: >-
User-institution relationships and permissions
(/api/admin/userInstitution)
- name: Admin Sessions
description: Session management for admins (/api/admin/session)
- name: Admin Histories
description: Conversation history management and analytics (/api/admin/history)
- name: Admin Assistants
description: AI assistant management for admins (/api/admin/assistant)
- name: Admin Questions
description: Institution question and prompt management (/api/admin/question)
- name: Admin Tools
description: Tool configuration management (/api/admin/tool)
- name: Admin AI Models
description: AI model configuration (/api/admin/aimodel)
- name: Admin MCP Servers
description: Model Context Protocol server management (/api/admin/mcpserver)
- name: Admin Feedbacks
description: User feedback management (/api/admin/feedback)
- name: Admin Uploads
description: Upload management (/api/admin/upload)
- name: Admin Charts
description: Analytics and visualization chart management (/api/admin/chart)
- name: Admin Memory
description: Admin inspection and editing of user/instance memory parameters.
- name: Admin Usage Limits
description: Per-user usage-vs-cap reporting and account-wide at-limit counts.
paths:
/api/auth/blackboard_tool_complete:
get:
tags:
- OAuth
summary: >-
Connect a learner's Blackboard Learn account to a Digital Twin's course
tools
description: >
Blackboard Learn sends the learner's browser here after they open the
sign-in link a
Digital Twin gave them in a chat (the twin then reads their Blackboard
course with their own,
read-only access). A link works once and for 10 minutes. The page that
answers says
whether Blackboard is now connected; the learner then goes back to the
chat and asks again.
Only the Blackboard account the learner uses in this course can be
connected: the one they
opened the Digital Twin from in Blackboard. Nothing is connected
otherwise.
parameters:
- in: query
name: state
required: true
schema:
type: string
description: The single-use value of the sign-in link.
- in: query
name: code
schema:
type: string
description: The authorization code Blackboard Learn returns.
- in: query
name: error
schema:
type: string
description: Set by Blackboard Learn when the sign-in did not complete.
responses:
'200':
description: Connected. An HTML page asks the learner to go back to the chat.
content:
text/html:
schema:
type: string
'400':
description: >-
The link is no longer valid (used, older than 10 minutes, altered,
or the Digital Twin's Blackboard site changed).
'401':
description: Blackboard did not confirm the sign-in. Nothing was connected.
'403':
description: >-
The learner signed in to Blackboard with a different account than
the one they use in this course. Nothing was connected.
'429':
description: Too many requests.
'502':
description: Blackboard Learn cannot be reached right now.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.