Skip to content
DataRecs Docs
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Getting Started
Introduction
Quickstart
Concepts
Workspaces
Connections
Reconciliation Jobs
Data Types, Filtering & Comparison
Supported Sources
Security & Data Residency
Guides
Creating a Connection
Connecting to Snowflake
Running a Reconciliation
Configuring a Reconciliation Job
Scheduling with the Built-in Scheduler
Temporal Handling
Managing API Keys
Connect DataRecs to AI tools (MCP)
Limits & Quotas
SSO Setup
Connection Health & Stale Connections
Using Webhooks
Customising Webhook Payloads
Scheduling with Airflow
Bring Your Own Key (BYOK)
Bring Your Own Storage (BYOS)
Errors & Troubleshooting
Events
Reconciliation Run Lifecycle Events
CLI Reference
CLI Overview
Terraform Provider
Terraform Provider
Reference
Support
Changelog & Versioning
REST API
REST API Overview
API Reference (generated)
Overview
ApiKeys
ApiKeysController_findAll
ApiKeysController_update
ApiKeysController_create
ApiKeysController_remove
ApiKeysController_findOne
audit-log
AuditLogController_findAll
Authentication
AuthenticationController_handleCallback
AuthenticationController_getAuthConfig
AuthenticationController_resolveTenant
AuthenticationController_discoverTenants
AuthenticationController_getCurrentUser
AuthenticationController_login
AuthenticationController_refreshToken
AuthenticationController_logout
AuthenticationController_ssoLogin
AuthenticationController_ssoCallback
billing
BillingController_getUsage
connections
ConnectionsController_getAllConnections
ConnectionsController_createConnection
ConnectionsController_listReservations
ConnectionsController_getConnectionById
ConnectionsController_updateConnection
ConnectionsController_deleteConnection
ConnectionsController_getConnectionStats
ConnectionsController_testConnection
ConnectionsController_getDatabases
ConnectionsController_getSchemas
ConnectionsController_getTables
ConnectionsController_getColumns
ExcelSharePointConsentController_getConsentUrl
ExcelSharePointConsentController_handleConsentCallback
ExcelSharePointConsentController_listGrantedSites
Groups
GroupsController_listGroups
GroupsController_createGroup
GroupsController_getGroup
GroupsController_updateGroup
GroupsController_deleteGroup
GroupsController_listMembers
GroupsController_addMember
GroupsController_removeMember
jobs
JobsController_findAll
JobsController_create
JobsController_findOne
JobsController_remove
JobsController_update
job-runs
JobRunsController_trigger
JobRunsController_findAll
JobRunsController_findOne
JobRunsController_cancel
JobRunsController_getEvents
WorkspaceRunsController_findRecent
job-results
JobResultsController_getSummary
JobResultsController_getMismatches
JobResultsController_download
job-groups
JobGroupsController_findAll
JobGroupsController_create
JobGroupsController_findOne
JobGroupsController_remove
JobGroupsController_update
job-schedules
JobSchedulesController_findAll
JobSchedulesController_create
JobSchedulesController_remove
JobSchedulesController_update
Permissions
PermissionsController_listPermissions
Roles
RolesController_listPlatformRoles
RolesController_listCustomRoles
RolesController_updateCustomRole
RolesController_createCustomRole
RolesController_getCustomRole
RolesController_deleteCustomRole
RolesController_getRoleAssignments
Users
UsersController_listUsers
UsersController_inviteUser
UsersController_listInvitations
UsersController_cancelInvitation
UsersController_listRequests
UsersController_approveRequest
UsersController_denyRequest
UsersController_getStats
UsersController_validateImpersonation
UsersController_getUserPermissions
UsersController_updateBypassSso
UsersController_resetIdentity
UsersController_archiveUser
webhook-deliveries
WebhookDeliveriesController_findAll
WebhookDeliveriesController_replay
WebhookDeliveriesController_findOne
WebhookDeliveriesController_retry
webhook-endpoints
WebhookEndpointsController_findAll
WebhookEndpointsController_create
WebhookEndpointsController_findOne
WebhookEndpointsController_update
WebhookEndpointsController_remove
WebhookEndpointsController_availableVariables
WebhookEndpointsController_preview
WebhookEndpointsController_rotateSecret
WebhookEndpointsController_listSecrets
WebhookEndpointsController_setSecret
WebhookEndpointsController_deleteSecret
webhook-test
WebhookTestController_emitTestEvent
webhook-event-types
WebhookEventTypesController_getCatalog
webhook-subscriptions
WebhookSubscriptionsController_findAll
WebhookSubscriptionsController_create
WebhookSubscriptionsController_findOne
WebhookSubscriptionsController_update
WebhookSubscriptionsController_remove
Workspaces
WorkspacesController_findAll
WorkspacesController_update
WorkspacesController_create
WorkspacesController_remove
WorkspacesController_findOne
EmailSettings
EmailSettingsController_getSettings
EmailSettingsController_updateSettings
EmailRecipientRules
EmailRecipientRulesController_list
EmailRecipientRulesController_create
EmailRecipientRulesController_delete
tenant-encryption
TenantEncryptionController_getEncryptionConfig
TenantEncryptionController_configureByok
TenantEncryptionController_testAccess
TenantEncryptionController_getMigrationStatus
TenantEncryptionController_getMigrationProgress
TenantEncryptionController_triggerMigration
TenantEncryptionController_triggerRevert
oidc-connectors
OidcConnectorsController_findAll
OidcConnectorsController_create
OidcConnectorsController_findOne
OidcConnectorsController_remove
OidcConnectorsController_update
oidc-token-exchange
TokenExchangeController_exchange
data-storage
DataStorageController_getStorageConfig
DataStorageController_configureByos
DataStorageController_testPermissions
DataStorageController_triggerMigration
DataStorageController_triggerRevert
DataStorageController_getMigrationStatus
DataStorageController_getMigrationProgress
DataStorageController_forceReleaseLock
DeviceAuth
DeviceAuthController_requestDeviceCode
DeviceAuthController_pollForToken
DeviceAuthController_verifyDeviceCode
DeviceAuthController_refreshCliTokens
DeviceAuthController_listSessions
DeviceAuthController_revokeSession
sso
SsoConnectionController_findOne
SsoConnectionController_create
SsoConnectionController_remove
SsoConnectionController_update
SsoConnectionController_enableScim
SsoConnectionController_disableScim
SsoConnectionController_rotateScimToken
SsoConnectionController_testLogin
SsoConnectionController_migrate
SsoConnectionController_migrationStatus
SsoConnectionController_revert
Scim
ScimController_listUsers
ScimController_createUser
ScimController_getUser
ScimController_replaceUser
ScimController_deleteUser
ScimController_patchUser
ScimController_listGroups
ScimController_createGroup
ScimController_getGroup
ScimController_deleteGroup
ScimController_patchGroup
ScimController_getServiceProviderConfig
ScimController_getResourceTypes
ScimController_getSchemas
GitHub
Select theme
Dark
Light
Auto
DeviceAuthController_verifyDeviceCode
POST
/auth/device/verify
Responses
Section titled “Responses”
201
Section titled “201”
