Skip to main content

Interface: GenerateDatabaseCredentialRequest

Interface: GenerateDatabaseCredentialRequest

Request parameters for generating database OAuth credentials

Properties

claims?

optional claims: RequestedClaims[];

Optional claims for fine-grained UC table permissions. When specified, the token will only grant access to the specified tables.

Example

{
  claims: [{
    permission_set: RequestedClaimsPermissionSet.READ_ONLY,
    resources: [{ table_name: "catalog.schema.users" }]
  }]
}

endpoint

endpoint: string;

Endpoint resource path. Retrieve using the Databricks CLI:

databricks postgres list-endpoints projects/{project-id}/branches/{branch-id}

Use the name field from the output.

Example

"projects/{project-id}/branches/{branch-id}/endpoints/{endpoint-identifier}"

Databricks Developer Hub

Ready to ship your next agentic app in minutes?

Read docs