Workspace Service Principal

View as Markdown

The details of a ServicePrincipal resource.

GetGET /api/2.0/identity/service-principals/{service_principal_id}ListGET /api/2.0/identity/service-principalsCreatePOST /api/2.0/identity/service-principalsUpdatePATCH /api/2.0/identity/service-principals/{service_principal_id}DeleteDELETE /api/2.0/identity/service-principals/{service_principal_id}

ServicePrincipal object

The details of a ServicePrincipal resource.

account_idstringBeta

The parent account ID for the service principal in <Databricks>.

service_principal_idstringBeta

Internal service principal ID of the service principal in <Databricks>.

external_idstringBeta

ExternalId of the service principal in the customer's IdP.

application_idstringBeta

Application ID of the service principal. Set at creation time and cannot be changed afterwards; when omitted, the server generates one.

display_namestringBeta

Display name of the service principal.

account_sp_statusstringBeta

The activity status of a service principal in a <Databricks> account.

Values: STATE_UNSPECIFIED, ACTIVE, INACTIVE

View as Markdown

The ServicePrincipal object

{
  "account_id": "string",
  "service_principal_id": "string",
  "external_id": "string",
  "application_id": "string",
  "display_name": "string",
  "account_sp_status": "string"
}

Get Beta

GET /api/2.0/identity/service-principals/{service_principal_id}

Fetches a service principal by its internal ID from the <Databricks> account that parents the calling workspace.

API scopes: identity

Parameters

service_principal_idstringpath

Required. Internal ID of the service principal in <Databricks>.

Response

Returns the ServicePrincipal object.

View as Markdown

Response

{
  "account_id": "string",
  "service_principal_id": "string",
  "external_id": "string",
  "application_id": "string",
  "display_name": "string",
  "account_sp_status": "string"
}

List Beta

GET /api/2.0/identity/service-principals

Lists the service principals in the <Databricks> account that parents the calling workspace, returning one page per call. Supports filtering by application ID or external ID.

API scopes: identity

Parameters

page_sizeint32query

The maximum number of SPs to return. The service may return fewer than this value.

page_tokenstringquery

A page token, received from a previous ListServicePrincipals call. Provide this to retrieve the subsequent page.

filterstringquery

Optional. Allows filtering service principals by application id or external id.

Response

Returns a list of ServicePrincipal objects.

View as Markdown

Response

{
  "service_principals": [
    {
      "account_id": "string",
      "service_principal_id": "string",
      "external_id": "string",
      "application_id": "string",
      "display_name": "string",
      "account_sp_status": "string"
    }
  ],
  "next_page_token": "string"
}

Create Beta

POST /api/2.0/identity/service-principals

Creates a local service principal in the <Databricks> account that parents the calling workspace and returns the created service principal. A local service principal is one that is not synced from the customer's identity provider, and can be created whether or not Account Identity Management (AIM) is enabled.

When AIM is enabled, supplying an external ID returns an error. To provision the identity from your identity provider, resolve it by its external ID with ResolveServicePrincipal; to read an existing external identity, use the ExternalServicePrincipal resource.

API scopes: identity

Request body

service_principalobject

Required. Service principal to be created in <Databricks>

Show child attributesHide child attributes

account_idstring

The parent account ID for the service principal in <Databricks>.

service_principal_idstring

Internal service principal ID of the service principal in <Databricks>.

external_idstring

ExternalId of the service principal in the customer's IdP.

application_idstring

Application ID of the service principal. Set at creation time and cannot be changed afterwards; when omitted, the server generates one.

display_namestring

Display name of the service principal.

account_sp_statusstring

The activity status of a service principal in a <Databricks> account.

Values: STATE_UNSPECIFIED, ACTIVE, INACTIVE

Response

Returns the ServicePrincipal object.

View as Markdown

Request

{
  "service_principal": {
    "account_id": "string",
    "service_principal_id": "string",
    "external_id": "string",
    "application_id": "string",
    "display_name": "string",
    "account_sp_status": "string"
  }
}

Response

{
  "account_id": "string",
  "service_principal_id": "string",
  "external_id": "string",
  "application_id": "string",
  "display_name": "string",
  "account_sp_status": "string"
}

Update Beta

PATCH /api/2.0/identity/service-principals/{service_principal_id}

Updates an existing service principal in the <Databricks> account that parents the calling workspace. Only the fields named in the update mask are modified. Returns the updated ServicePrincipal resource.

When AIM is enabled and the service principal is an external identity (its external_id is set), only external_id can be updated; its other fields are sourced from your identity provider.

API scopes: identity

Parameters

service_principal_idstringpath

Required. Internal ID of the service principal in <Databricks>.

update_maskstringquery

Optional. The list of fields to update.

Request body

service_principalobject

Required. Service principal to be updated in <Databricks>

Show child attributesHide child attributes

account_idstring

The parent account ID for the service principal in <Databricks>.

service_principal_idstring

Internal service principal ID of the service principal in <Databricks>.

external_idstring

ExternalId of the service principal in the customer's IdP.

application_idstring

Application ID of the service principal. Set at creation time and cannot be changed afterwards; when omitted, the server generates one.

display_namestring

Display name of the service principal.

account_sp_statusstring

The activity status of a service principal in a <Databricks> account.

Values: STATE_UNSPECIFIED, ACTIVE, INACTIVE

Response

Returns the ServicePrincipal object.

View as Markdown

Request

{
  "service_principal": {
    "account_id": "string",
    "service_principal_id": "string",
    "external_id": "string",
    "application_id": "string",
    "display_name": "string",
    "account_sp_status": "string"
  }
}

Response

{
  "account_id": "string",
  "service_principal_id": "string",
  "external_id": "string",
  "application_id": "string",
  "display_name": "string",
  "account_sp_status": "string"
}

Delete Beta

DELETE /api/2.0/identity/service-principals/{service_principal_id}

Deletes a service principal by its internal ID from the <Databricks> account that parents the calling workspace.

API scopes: identity

Parameters

service_principal_idstringpath

Required. Internal ID of the service principal in <Databricks>.

View as Markdown

Response

{}