> ## 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.
# Start the Google Services (per-user) OAuth consent flow
> Begins a Google OAuth 2.0 authorization-code flow scoped to the per-user services
the caller requests (Gmail / Drive / Calendar / Sheets / Docs). Generates a CSRF
state, stores it in `req.session.oauth_state` along with the caller's `userId`
and institution context, then 302-redirects to Google's consent screen with
`access_type=offline` and `prompt=consent` to ensure a refresh token is issued.
**Storage routing (Option B):**
- If the JWT has an institution attached, the resulting token is stored on
`UserInstitution.googleLoginToken` (institution-specific).
- If there is no institution, it goes on `User.googleLoginToken` (personal).
**Origin handling:** the `origin` query param (`profile` default, `chat` for the
in-chat consent prompt) is preserved in the session so the post-callback redirect
returns the user to the right place.
## OpenAPI
````yaml /mdx/api-reference/admin/admin-api.json get /api/auth/google/services/authorize
openapi: 3.0.0
info:
title: Pria Admin API
version: 2.0.1
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.
servers:
- url: https://pria.praxislxp.com
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 super admins (/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/google/services/authorize:
get:
tags:
- OAuth
summary: Start the Google Services (per-user) OAuth consent flow
description: >
Begins a Google OAuth 2.0 authorization-code flow scoped to the per-user
services
the caller requests (Gmail / Drive / Calendar / Sheets / Docs).
Generates a CSRF
state, stores it in `req.session.oauth_state` along with the caller's
`userId`
and institution context, then 302-redirects to Google's consent screen
with
`access_type=offline` and `prompt=consent` to ensure a refresh token is
issued.
**Storage routing (Option B):**
- If the JWT has an institution attached, the resulting token is stored
on
`UserInstitution.googleLoginToken` (institution-specific).
- If there is no institution, it goes on `User.googleLoginToken`
(personal).
**Origin handling:** the `origin` query param (`profile` default, `chat`
for the
in-chat consent prompt) is preserved in the session so the post-callback
redirect
returns the user to the right place.
parameters:
- in: query
name: scopes
required: true
schema:
type: string
description: >
Comma-separated list of Google service names to request. Each name
is
expanded via `GoogleServicesConfig.buildScopes`. Common values:
`gmail`, `drive`, `calendar`, `sheets`, `docs`.
example: gmail,calendar
- in: query
name: origin
schema:
type: string
enum:
- profile
- chat
default: profile
description: >
Where the user was when they triggered the consent. Controls the
post-callback
redirect — `chat` returns to the chat page, `profile` returns to the
profile page.
responses:
'302':
description: Redirect to Google's OAuth consent screen.
'400':
description: '`scopes` is missing or empty.'
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: No services specified
'401':
description: Missing or invalid JWT (verifyToken).
security:
- bearerAuth: []
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: JWT token passed in authorization header
````