README.md

Documentation for Partner Connect API

Documentation for API Endpoints

All URIs are relative to https://domainnameofpartner

Class	Method	HTTP request	Description
AccountApi	deleteAccount	DELETE /delete-account	Test Only Delete the account related to a given domain. This API should remove all users and connections associated with all users under this domain. This API is only used for automated tests. Partners should only allow this API call on Databricks related test domain names (databricks-test.com and databricks-demo.com). If any other domain is used, api call should fail with 400 Bad Request
AccountApi	expireAccount	PUT /expire-account	Test Only Expire account api is used to expire a user trial. After this api is called, the partner is expected to return the redirect uri for handling expired users. The account_status should be set to expired. This api is only used for automated verification of the partner connect flow for expired accounts. This api needs to be limited to databricks test domain names (databricks-test.com and databricks-demo.com). Partners should return 400 bad request if it's called for any other domain name.
ConnectionApi	connect	POST /connect	The Connect API is used to sign-in or sign-up a user with a partner with Databricks resources pre-configured.
ConnectionApi	deleteConnection	POST /delete-connection	Delete the connection created by partner. This API is used for automated tests and is required in the Partner Connect experience. In the Partner Connect experience, Databricks calls this API to notify partners about connection deletion from Databricks's side.
ConnectionApi	testConnection	POST /test-connection	Test the connection created by calling connect endpoint. This api is currently only used in automated tests. In the future it may be included in the partner connect experience.
DatasourceApi	getConnectors	GET /connectors	Returns list of connectors supported by the partner. This is only applicable to Data ingestion partners.

Documentation for Models

• AccountInfo
• AccountUserInfo
• Auth
• ConnectRequest
• Connection
• ConnectionInfo
• ConnectionTestResult
• Connector
• ConnectorResponse
• DataPermission
• DeleteConnectionRequest
• DeleteConnectionResponse
• ErrorResponse
• ObjectPermission
• PartnerConfig
• PartnerConfig_endpoints
• PartnerConfig_test_workspace_detail
• ResourceToProvision
• TestResult
• UserInfo

Documentation for Authorization

basicAuth

• Type: HTTP basic authentication