Store Databricks OAuth credentials

Learn more about the Store Databricks OAuth credentials API used to store Databricks OAuth credentials for Zero Copy Interaction Integration from Databricks.

Use Store Databricks OAuth credentials API to store the Databricks service principal client ID and client secret in Reltio. Reltio then uses these credentials to request and refresh Databricks access tokens for Zero Copy integration. When the request succeeds, the response confirms that the credentials are stored for the named Databricks connection. This operation does not require a public key or a SQL statement in Databricks.

HTTP method and endpoint

Use the following HTTP method and endpoint path to store the Databricks OAuth credentials for an existing connection.

POST {platformUrl}/reltio/api/tenants/{tenantId}/interactions/database-configs/{connectionName}/databricks/oauth/credentials

The following table describes the endpoint path parameters.


Parameter	Type	Required	Description
`tenantId`	String	Yes	Unique identifier of the tenant where the Databricks connection is defined. Example: ce5627DYnQ6abcD
`connectionName`	String	Yes	Name of the existing Databricks connection configuration that will store the OAuth credentials.

Request headers

The following request headers must be included.


Header	Value	Required
`Authorization`	Bearer `<access_token>`	Yes
`Content-Type`	application/json	Yes

Request body

The following table describes the supported request body parameters. Use this to provide the Databricks service principal credentials.


Parameter	Type	Required	Description	Accepted values / Default
`clientId`	String	Yes	OAuth client ID of the Databricks service principal.	Example: `a1b2c3d4-e5f6-7890-abcd-ef1234567890`
`clientSecret`	String	Yes	OAuth client secret of the Databricks service principal.	Example: Service principal secret value

Example request

Use the following example to see how a complete request is structured. Replace the sample clientId and clientSecret values with the credentials for your Databricks service principal.

POST {platformUrl}/reltio/api/tenants/{tenantId}/interactions/database-configs/{connectionName}/databricks/oauth/credentials
{
  "clientId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "clientSecret": "example-secret"
}

Response body

The following table describes the fields returned in the response body.


Field	Type	Description
`status`	String	Overall response status.
`data.status`	String	Status of the credential storage operation.
`data.message`	String	Result message returned by the API.
`data.connectionId`	String	Identifier of the Databricks connection configuration associated with the stored credentials.
`data.connectionName`	String	Name of the Databricks connection configuration associated with the stored credentials.
`data.timestamp`	Number	Timestamp value returned by the API for the credential storage operation.

Example response

The following example shows a successful response.

{
  "status": "success",
  "data": {
    "status": "success",
    "message": "Databricks M2M OAuth credentials stored successfully",
    "connectionId": "c1d2e3f4-...",
    "connectionName": "my-databricks-connection",
    "timestamp": 1743600000000
  }
}

If the request fails, the API returns HTTP 400 Bad Request with an error response similar to the following examples. Review the response message, correct the related mapping values, and then submit the request again.

{
  "successful": false,
  "error": "Code: DS_DATABRICKS_OAUTH_CLIENT_ID_REQUIRED; Message parameters: []. Databricks OAuth client ID is required. The clientId field cannot be null or empty when storing Databricks M2M OAuth credentials"
}

{
  "successful": false,
  "error": "Code: DS_DATABRICKS_OAUTH_CLIENT_SECRET_REQUIRED; Message parameters: []. Databricks OAuth client secret is required. The clientSecret field cannot be null or empty when storing Databricks M2M OAuth credentials"
}

Unify and manage your data