Group

View as Markdown

Get group detailsGET /api/2.0/accounts/{account_id}/scim/v2/Groups/{id}List group detailsGET /api/2.0/accounts/{account_id}/scim/v2/GroupsCreate a new groupPOST /api/2.0/accounts/{account_id}/scim/v2/GroupsReplace a groupPUT /api/2.0/accounts/{account_id}/scim/v2/Groups/{id}Delete a groupDELETE /api/2.0/accounts/{account_id}/scim/v2/Groups/{id}Update group detailsPATCH /api/2.0/accounts/{account_id}/scim/v2/Groups/{id}

AccountGroup object

displayNamestring

String that represents a human-readable group name

externalIdstring

external_id should be unique for identifying groups

Constraints: <= 64 characters

idstring

<Databricks> group ID

membersarray of object

Show child attributesHide child attributes

displaystring

primaryboolean

$refstring

typestring

valuestring

rolesarray of object

Indicates if the group has the admin role.

Show child attributesHide child attributes

displaystring

primaryboolean

$refstring

typestring

valuestring

account_idstring

<Databricks> account ID

View as Markdown

The AccountGroup object

{
  "displayName": "string",
  "externalId": "string",
  "id": "string",
  "members": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "roles": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "account_id": "string"
}

Get group details GA

GET /api/2.0/accounts/{account_id}/scim/v2/Groups/{id}

Gets the information for a specific group in the <Databricks> account.

API scopes: scim

Parameters

account_idstringRequiredpath

<Databricks> account ID

idstringRequiredpath

Unique ID for a group in the <Databricks> account.

Response

Returns the AccountGroup object.

View as Markdown

Response

{
  "displayName": "string",
  "externalId": "string",
  "id": "string",
  "members": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "roles": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "account_id": "string"
}

List group details GA

GET /api/2.0/accounts/{account_id}/scim/v2/Groups

Gets all details of the groups associated with the <Databricks> account. As of 08/22/2025, this endpoint will no longer return members. Instead, members should be retrieved by iterating through Get group details. Existing accounts that rely on this attribute will not be impacted and will continue receiving member data as before.

API scopes: scim

Parameters

account_idstringRequiredpath

<Databricks> account ID

filterstringquery

Query by which the results have to be filtered. Supported operators are equals(eq), contains(co), starts with(sw) and not equals(ne). Additionally, simple expressions can be formed using logical operators - and and or. The SCIM RFC has more details but we currently only support simple expressions.

Examples:

• displayName co "foo" and displayName co "bar" : Group whose displayName contains foo and displayName contains bar.
• displayName co "foo" : Groups whose displayName contains foo.
• displayName eq "admins" : Groups whose displayName equals admins.
• displayName ne "baz" : Groups whose displayName not equals baz.
• displayName co "foo" or displayName co "bar" : Group whose displayName contains foo or displayName contains bar.
• displayName sw "bar" : Groups whose displayName starts with bar.

attributesstringquery

Comma-separated list of attributes to return in response.

excludedAttributesstringquery

Comma-separated list of attributes to exclude in response.

startIndexint64query

Specifies the index of the first result. First item is number 1.

countint64query

Desired number of results per page. Default is 10000.

Constraints: <= 100

sortBystringquery

Attribute to sort the results.

sortOrderstringquery

The order to sort the results.

Values:

• ORDER_UNSPECIFIED
• ascending
• descending

Response

Returns a list of AccountGroup objects.

View as Markdown

Response

{
  "itemsPerPage": 0,
  "Resources": [
    {
      "displayName": "string",
      "externalId": "string",
      "id": "string",
      "members": [
        {}
      ],
      "roles": [
        {}
      ],
      "account_id": "string"
    }
  ],
  "startIndex": 0,
  "totalResults": 0
}

Create a new group GA

POST /api/2.0/accounts/{account_id}/scim/v2/Groups

Creates a group in the <Databricks> account with a unique name, using the supplied group details.

API scopes: scim

Parameters

account_idstringRequiredpath

<Databricks> account ID

Request body

displayNamestring

String that represents a human-readable group name

externalIdstring

idstring

<Databricks> group ID

membersarray of object

Show child attributesHide child attributes

displaystring

primaryboolean

$refstring

typestring

valuestring

rolesarray of object

Indicates if the group has the admin role.

Show child attributesHide child attributes

displaystring

primaryboolean

$refstring

typestring

valuestring

Response

Returns the AccountGroup object.

View as Markdown

Request

{
  "displayName": "string",
  "externalId": "string",
  "id": "string",
  "members": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "roles": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ]
}

Response

{
  "displayName": "string",
  "externalId": "string",
  "id": "string",
  "members": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "roles": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "account_id": "string"
}

Replace a group GA

PUT /api/2.0/accounts/{account_id}/scim/v2/Groups/{id}

Updates the details of a group by replacing the entire group entity.

API scopes: scim

Parameters

account_idstringRequiredpath

<Databricks> account ID

idstringRequiredpath

<Databricks> group ID

Request body

displayNamestring

String that represents a human-readable group name

externalIdstring

membersarray of object

Show child attributesHide child attributes

displaystring

primaryboolean

$refstring

typestring

valuestring

rolesarray of object

Indicates if the group has the admin role.

Show child attributesHide child attributes

displaystring

primaryboolean

$refstring

typestring

valuestring

View as Markdown

Request

{
  "displayName": "string",
  "externalId": "string",
  "members": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "roles": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ]
}

Response

{}

Delete a group GA

DELETE /api/2.0/accounts/{account_id}/scim/v2/Groups/{id}

Deletes a group from the <Databricks> account.

API scopes: scim

Parameters

account_idstringRequiredpath

<Databricks> account ID

idstringRequiredpath

Unique ID for a group in the <Databricks> account.

View as Markdown

Response

{}

Update group details GA

PATCH /api/2.0/accounts/{account_id}/scim/v2/Groups/{id}

Partially updates the details of a group.

API scopes: scim

Parameters

account_idstringRequiredpath

<Databricks> account ID

idstringRequiredpath

Unique ID in the <Databricks> workspace.

Request body

Operationsarray of object

Show child attributesHide child attributes

opstring

Type of patch operation.

Values:

• PATCH_OP_UNSPECIFIED
• add
• remove
• replace

pathstring

Selection of patch operation

valueobject

Value to modify

schemasarray of string

The schema of the patch request. Must be ["urn:ietf:params:scim:api:messages:2.0:PatchOp"].

Values:

• PATCH_SCHEMA_UNSPECIFIED
• urn:ietf:params:scim:api:messages:2.0:PatchOp

View as Markdown

Request

{
  "Operations": [
    {
      "op": "string",
      "path": "string",
      "value": {}
    }
  ],
  "schemas": [
    "string"
  ]
}

Response

{}