- Overview
- Changelog
- Versioning
- Quick-Start Template for Building an App
- FAQs
- Guides
- Authentication
- Getting Started with Authentication
- Authentication and Token Refresh Guide
- SSO
- Feature Flags
- Authenticate UserPOST
- Request Passwordless Exchange TokenPOST
- Exchange Passwordless Token for Access TokensPOST
- Register UserPOST
- Refresh Access TokenPOST
- Update Own PasswordPATCH
- Validate Magic Link TokenPOST
- Passwordless Authentication (Email Magic Link)POST
- Verify Email OTPPOST
- Request Password Recovery EmailPOST
- Reset PasswordPOST
- Agents
- Agent Access
- Agent Alias
- Agent Tags
- Agent Chat Threads
- Agent Comment
- Agent Rating
- Agent Review
- Agent Tools
- Agent Vote
- Agent Type
- Evaluation Datasets
- Evaluation Runs
- Agent Permissions
- Agent Skills
- Get all Agents
- Create a new Agent
- Get an Agent
- Update an Agent
- Delete an Agent
- Activate an Agent
- Get Agent-Corpus Connections
- Create Multiple Agent-Corpus Connections
- Delete Agent-Corpus Connections
- Get Agent-Corpus Connection Details
- Create Agent-Corpus Connection
- Update Agent-Corpus Connection
- Delete Agent-Corpus Connection
- Get agent history with pagination
- Restore an agent to a previous checkpoint
- Get a single agent history record by history ID
- Create Custom Instructions for an Agent
- Update Custom Instructions for an Agent
- Delete a Custom Instruction for an Agent
- Get Agent Prompt History
- Create a Recent Agent
- Delete a Recent Agent
- Get Agent Details with Starred Status
- Create Starred Agent
- Delete Starred Agent
- Get the Status of an Agent
- Get all Character Voices
- Get Agent Filter
- Generate an image for an agent based on the provided description
- Get all Agents by Project
- Get list of Recent Agents
- Get all workflows for an agent
- Get all Starred Agents of the Authenticated User
- Get Staging Diff
- Get publish history for an agent
- Get rollback diff preview for a publish record
- Roll back staging agent to a previous publish
- Publish staging agent to main
- Clone an Agent
- Get diff detail for a publish record
- Agent Response
- Stream Agent Response (SSE)
- Generate Agent Response (Non-Streaming)
- Generate Token for Voice Call
- Get an Agent Response
- Update an Agent Response
- Delete an Agent Response
- Get Comments for Agent Response
- Create a Comment for Agent Response
- Create a Feedback for an Agent Response
- Pin an Agent Response
- Unpin an Agent Response
- Get Supporting Content of an Agent Response
- Get Thoughts of an Agent Response
- Get Agent Responses based on filters
- Get Agent Responses of an Agent
- Create Agent Response Log
- Get Pinned Agent Responses
- Create Bulk Agent Response Logs
- Stop an in-flight streaming response
- Chat Thread
- Chat Logs
- Conversation Starters
- Teams
- Projects
- Project Permissions
- Retrieve all Projects
- Create a Project
- Get a Project
- Update a Project
- Delete a Project
- Get Agent Responses using Project ID
- Add a Recent Project for a User
- Add Users to a Project
- Remove a User from a Project
- Get all Workflows for a Project
- Get multiple Projects by their IDs
- Get Projects based on filters
- Get Recent Projects for a User
- Get Projects with Team Details
- Corpora
- Corpus Permissions
- Get all Permissions for a Corpus
- Grant permission on a corpus
- Update a permission on a corpus
- Revoke permission on a corpus
- Batch grant permissions on a corpus
- Batch revoke permissions on a corpus
- Get calling user's permissions on a corpus
- Get a user's permissions on a corpus
- Get a user's permissions across multiple corpora
- Get all Corpus
- Upload a Document to a Corpus
- Create a Corpus
- Get a Corpus
- Update a Corpus
- Delete a Corpus
- Get Corpus Agent Connections
- Get Default Corpus Agent Connection
- Annotate/Tag a Corpus
- Get Conversation Starters for a Corpus
- Get all Documents for a Corpus
- Delete Document(s) from a Corpus
- Check Duplicate Documents in a Corpus
- Trigger a Refresh (Reindex) of a Corpus
- Get Sitemaps for a Corpus
- Get Corpora with Refresh (Reindex) Enabled
- Corpus Permissions
- Documents
- Organizations
- Organization Permissions
- Get all Configurations
- Get active configuration for an Organization
- Get the Model Deployment for an Organization
- Get all Tools in an Organization
- Disable a Tool for all Agents in an Organization
- Enable a Tool for all Agents in an Organization
- Get all API Tool Templates
- Create a new API Tool Template
- Create a new API tool
- Create an attachment tool
- Create a new RAG tool in an Organization
- Create a Web Search Tool in an Organization
- Get all Users in an Organization
- Create a User in an Organization
- Get all Configurations of user's Organization
- Register LLM Configuration
- Update LLM Configuration
- Toggle LLM Configuration Availability
- Delete LLM Configuration
- Get a specific LLM configuration by ID (admin only)
- Users
- Get a User
- Update a User
- Delete a User
- Get Agent Responses of a User
- Assign a user to multiple permission sets
- Get all User Permissions
- Preview a user's permissions after assigning/removing permission sets
- Get Projects of a User
- Get all Workflow Tables for a User
- Get all Workflows for a User
- Delete multiple Users
- Get a specific User by user_email
- Get all Users
- Get authenticated User
- Get User Projects
- Analytics
- Get Agent Cost Data
- Get Agent Document Count Data
- Get Agent Indexing Mode Data
- Get Agent Most Active Data
- Get Agent Query Count Data
- Get Recent Agent Data
- Get Agent Summary Statistics
- Get Agent Token Data
- Get Agent Vote Data
- Get Corpus Document Count Data
- Get Corpus Indexing Mode Data
- Get Cost Data
- Get Document Count Data
- Get Indexing Mode Data
- Get Project Cost Data
- Get Project Document Count Data
- Get Project Indexing Mode Data
- Get Project Most Active Data
- Get Project Query Count Data
- Get Recent Project Data
- Get Project Summary Statistics
- Get Project Token Data
- Get Project Vote Data
- Get Overall Summary Statistics
- Get Team Cost Data
- Get Team Document Count Data
- Get Team Indexing Mode Data
- Get Team Most Active Data
- Get Team Query Count Data
- Get Recent Team Data
- Get Team Summary Statistics
- Get Team Token Data
- Get Team Vote Data
- Get Total Entity Counts
- Get User Cost Data
- Get User Document Count Data
- Get User Indexing Mode Data
- Get User Most Active Data
- Get User Query Count Data
- Get Recent User Data
- Get User Summary Statistics
- Get User Token Data
- Get User Vote Data
- Get Vote Count Data
- Get Workflow Summary Statistics
- Get Query Count Data
- Get Token Data
- Configurations
- Guardrails
- Feature Flags
- Get All Feature Flags
- Get Agent Alias Feature Flag
- Get Agent Evaluation Feature Flag
- Get Api Tools Feature Flag
- Get Caching Feature Flag
- Get Call Feature Flag
- Get Chat Agent Creation Feature Flag
- Get Chat Widget Feature Flag
- Get dall_e Image Generation Feature Flag
- Get Developer Portal Feature Flag
- Get Flush Cache Feature Flag
- Get Google Drive Connector Feature Flag
- Get Guardrail Feature Flag
- Permission Sets Feature Flag
- Get PII Redaction Feature Flag
- Get Share Agent Feature Flag
- Get Sharepoint Legacy Feature Flag
- Show Quota Limit Feature Flag
- Get Skills Feature Flag
- Get Staging Agent Feature Flag
- Get Workflow Evaluation Feature Flag
- Get Youtube Index Feature Flag
- Notifications
- Tools
- Workflows
- Evaluation Datasets
- Evaluation Runs
- Workflow Permissions
- Get all Workflows
- Stream Workflow Response (SSE)
- Create a Workflow
- Get a Workflow
- Update a Workflow
- Delete a Workflow
- Get all Workflow Chat Threads
- Create a Workflow Chat Thread
- Get all Workflow Responses
- Create a Workflow Chat Response
- Get a Workflow Chat Thread
- Update a Workflow Chat Thread
- Delete a Workflow Chat Thread
- Get all Workflow Chat Responses
- Delete a Workflow Response
- Create a Workflow Feedback
- Retrieve a list of reviews for a given workflow response
- Create a Workflow Review
- Get Workflow Responses based on filters
- Citation
- Sitemaps
- Google Drive
- Skills
- Permission Sets
Initiate Microsoft CIAM SSO Login (Azure AD B2C or Entra External ID)
GET
/auth-service/api/v2/sso/azure-ciam/login
next (optional): URL to redirect to after successful authentication. Defaults to your configured frontend URL.invite_token (optional): Raw invite token from an invite URL. When present, the invite flow is triggered after authentication.1.
next parameter2.
3.
next URL with authentication tokens as query parametersOn Azure AD B2C, selecting 'Forgot your password?' returns an
AADB2C90118 error to the callback, which forwards you to the reset journey and then back through sign-in. Entra External ID handles reset within its own flow. No action is required from the client either way.Request
Query Params
Header Params
Responses
🔵302
This response does not have a body.
🔵307
🟠403
🟠422
🔴503
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff 'https:///auth-service/api/v2/sso/azure-ciam/login?next=undefined&invite_token=undefined' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer 'Response Response Example
403 - Success
{
"success": false,
"message": "Request Failed",
"data": {
"error": {
"code": "HTTP_403",
"details": "Microsoft CIAM SSO is currently disabled. Please contact Ejento support to enable this feature."
}
}
}