Add CurrentWorkspaceIdentifier for non-numeric workspace IDs

CurrentWorkspaceID returns int64 and parses the server's response header
with strconv.ParseInt(_, 10, 64). That works for classic numeric workspace
IDs but cannot represent workspace identifiers in any other format — the
SDK currently has no way to surface those to callers.

Add CurrentWorkspaceIdentifier(ctx) (string, error) which returns the
identifier exactly as the server echoes it back, without parsing. Refactor
CurrentWorkspaceID to delegate to it so there is a single source of truth
for the HTTP I/O; the int64 path becomes a thin ParseInt adapter on top.

Backwards compatible: existing callers of CurrentWorkspaceID() (int64, error)
keep working byte-for-byte against classic numeric workspaces. Callers that
need to handle other workspace identifier formats should migrate to
CurrentWorkspaceIdentifier.

Co-authored-by: Isaac
Signed-off-by: Divyansh Vijayvergia <divyansh.vijayvergia@databricks.com>

Author: Divyansh-db

NEXT_CHANGELOG.md

@@ -6,6 +6,8 @@
 
 ### New Features and Improvements
 
+* Add `WorkspaceClient.CurrentWorkspaceIdentifier(ctx) (string, error)` which returns the workspace identifier exactly as the server echoes it back, without attempting to parse it as a number. Use this in preference to `CurrentWorkspaceID` if your code may run against workspaces whose identifier is not a classic numeric ID.
+
 ### Bug Fixes
 
 ### Documentation

workspace_functions.go

@@ -7,16 +7,22 @@ import (
 	"github.com/databricks/databricks-sdk-go/httpclient"
 )
 
-// CurrentWorkspaceID returns the workspace ID of the workspace that this client is
-// connected to.
+// CurrentWorkspaceIdentifier returns the workspace identifier of the workspace
+// that this client is connected to, as the server echoes it back.
+//
+// The returned value may be either a classic numeric workspace ID (e.g.
+// "7474644166319138") or another workspace identifier format that the server
+// understands. Prefer this over [WorkspaceClient.CurrentWorkspaceID] if your
+// code may run against workspaces whose identifier is not a classic numeric
+// ID.
 //
 // On unified (SPOG) hosts, Config.WorkspaceID is sent in the
 // X-Databricks-Workspace-Id request header to route the call to the correct
 // workspace; on unified hosts with no WorkspaceID set, the request has no
 // routing information and will fail. The ID is read back from the
 // X-Databricks-Org-Id response header on /api/2.0/preview/scim/v2/Me — the
 // server still emits the legacy response header name during the migration.
-func (w *WorkspaceClient) CurrentWorkspaceID(ctx context.Context) (int64, error) {
+func (w *WorkspaceClient) CurrentWorkspaceIdentifier(ctx context.Context) (string, error) {
 	var workspaceIdStr string
 	opts := []httpclient.DoOption{
 		httpclient.WithResponseHeader("X-Databricks-Org-Id", &workspaceIdStr),
@@ -25,13 +31,21 @@ func (w *WorkspaceClient) CurrentWorkspaceID(ctx context.Context) (int64, error)
 	if w.Config != nil && w.Config.WorkspaceID != "" {
 		opts = append(opts, httpclient.WithRequestHeader("X-Databricks-Workspace-Id", w.Config.WorkspaceID))
 	}
-	err := w.apiClient.Do(ctx, "GET", "/api/2.0/preview/scim/v2/Me", opts...)
-	if err != nil {
-		return 0, err
+	if err := w.apiClient.Do(ctx, "GET", "/api/2.0/preview/scim/v2/Me", opts...); err != nil {
+		return "", err
 	}
-	workspaceId, err := strconv.ParseInt(workspaceIdStr, 10, 64)
+	return workspaceIdStr, nil
+}
+
+// CurrentWorkspaceID returns the classic numeric workspace ID of the workspace
+// this client is connected to.
+//
+// Returns a parse error for workspaces whose identifier is not a classic
+// numeric ID — use [WorkspaceClient.CurrentWorkspaceIdentifier] in that case.
+func (w *WorkspaceClient) CurrentWorkspaceID(ctx context.Context) (int64, error) {
+	workspaceIdStr, err := w.CurrentWorkspaceIdentifier(ctx)
 	if err != nil {
 		return 0, err
 	}
-	return workspaceId, nil
+	return strconv.ParseInt(workspaceIdStr, 10, 64)
 }

workspace_functions_test.go

@@ -101,3 +101,38 @@ func TestCurrentWorkspaceIDOmitsWorkspaceIdHeaderWhenConfigMissingWorkspaceID(t
 	assert.Equal(t, 1, meCalls)
 	assert.Empty(t, gotOrgIdHeader)
 }
+
+func TestCurrentWorkspaceIdentifierReturnsRawIdentifier(t *testing.T) {
+	// CurrentWorkspaceIdentifier returns the workspace identifier exactly as
+	// the server echoes it back on the X-Databricks-Org-Id response header,
+	// without attempting to parse it as a number. This is the path callers
+	// should use when the workspace identifier might be something other than
+	// a classic numeric workspace ID (e.g. a CPDR connection ID).
+	const identifier = "7a99b43c-b46c-432b-b0a7-814217701909"
+	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		if r.URL.Path == "/api/2.0/preview/scim/v2/Me" {
+			w.Header().Set("X-Databricks-Org-Id", identifier)
+			w.Write([]byte(`{}`))
+			return
+		}
+		http.NotFound(w, r)
+	}))
+	defer server.Close()
+
+	w, err := NewWorkspaceClient(&Config{
+		Host:        server.URL,
+		Token:       "token",
+		WorkspaceID: identifier,
+	})
+	require.NoError(t, err)
+
+	got, err := w.CurrentWorkspaceIdentifier(t.Context())
+	require.NoError(t, err)
+	assert.Equal(t, identifier, got)
+
+	// CurrentWorkspaceID, by contrast, returns a parse error on non-numeric
+	// identifiers — callers carrying CPDR workspaces must use
+	// CurrentWorkspaceIdentifier instead.
+	_, err = w.CurrentWorkspaceID(t.Context())
+	assert.Error(t, err)
+}