Workspace User

View as Markdown

Get user detailsGET /api/2.0/preview/scim/v2/Users/{id}List usersGET /api/2.0/preview/scim/v2/UsersCreate a new userPOST /api/2.0/preview/scim/v2/UsersReplace a userPUT /api/2.0/preview/scim/v2/Users/{id}Delete a userDELETE /api/2.0/preview/scim/v2/Users/{id}Update user detailsPATCH /api/2.0/preview/scim/v2/Users/{id}

User object

activebooleanPublic Preview

If this user is active

displayNamestringPublic Preview

String that represents a concatenation of given and family names. For example John Smith. This field cannot be updated through the Workspace SCIM APIs when identity federation is enabled. Use Account SCIM APIs to update displayName.

emailsarray of objectPublic Preview

All the emails associated with the <Databricks> user. This attribute cannot be updated through the SCIM PATCH or PUT APIs; any supplied change is ignored.

Show child attributesHide child attributes

displaystringPublic Preview

primarybooleanPublic Preview

$refstringPublic Preview

typestringPublic Preview

valuestringPublic Preview

entitlementsarray of objectPublic Preview

Entitlements assigned to the user. See assigning entitlements for a full list of supported values.

Show child attributesHide child attributes

displaystringPublic Preview

primarybooleanPublic Preview

$refstringPublic Preview

typestringPublic Preview

valuestringPublic Preview

externalIdstring<= 64 charactersPublic Preview

External ID is not currently supported. It is reserved for future use.

groupsarray of objectPublic Preview

Show child attributesHide child attributes

displaystringPublic Preview

primarybooleanPublic Preview

$refstringPublic Preview

typestringPublic Preview

valuestringPublic Preview

idstringint64Public Preview

<Databricks> user ID.

nameobjectPublic Preview

Show child attributesHide child attributes

familyNamestringPublic Preview

Family name of the <Databricks> user.

givenNamestringPublic Preview

Given name of the <Databricks> user.

rolesarray of objectPublic Preview

Corresponds to AWS instance profile/arn role.

Show child attributesHide child attributes

displaystringPublic Preview

primarybooleanPublic Preview

$refstringPublic Preview

typestringPublic Preview

valuestringPublic Preview

schemasarray of stringPublic Preview

The schema of the user.

Values:

• USER_SCHEMA_UNSPECIFIED
• urn:ietf:params:scim:schemas:core:2.0:User
• urn:ietf:params:scim:schemas:extension:workspace:2.0:User

userNamestringemailPublic Preview

Email address of the <Databricks> user. This attribute cannot be updated through the SCIM PATCH or PUT APIs; any supplied change is ignored.

View as Markdown

The User object

{
  "active": true,
  "displayName": "string",
  "emails": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "entitlements": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "externalId": "string",
  "groups": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "id": "string",
  "name": {
    "familyName": "string",
    "givenName": "string"
  },
  "roles": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "userName": "string"
}

Get user details Public Preview

GET /api/2.0/preview/scim/v2/Users/{id}

Gets information for a specific user in <Databricks> workspace.

API scopes: scim

Parameters

idstringint64Requiredpath

Unique ID for a user in the <Databricks> workspace.

attributesstringquery

Comma-separated list of attributes to return in response.

countint32query

Desired number of results per page.

excludedAttributesstringquery

Comma-separated list of attributes to exclude in response.

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 "john" and userName co "doe" : Users whose displayName contains john and userName contains doe.
• displayName co "doe" : Users whose displayName contains doe.
• displayName eq "john" : Users whose displayName equals john.
• displayName ne "john" : Users whose displayName not equals john.
• displayName co "john" or userName co "doe" : Users whose displayName contains john or userName contains doe.
• displayName sw "jo" : Users whose displayName starts with jo.

sortBystringquery

Attribute to sort the results. Multi-part paths are supported. For example, userName, name.givenName, and emails.

sortOrderstringquery

The order to sort the results.

Values:

• GET_SORT_ORDER_UNSPECIFIED
• ascending
• descending

startIndexint32query

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

Response

Returns the User object.

View as Markdown

Response

{
  "active": true,
  "displayName": "string",
  "emails": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "entitlements": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "externalId": "string",
  "groups": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "id": "string",
  "name": {
    "familyName": "string",
    "givenName": "string"
  },
  "roles": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "userName": "string"
}

List users Public Preview

GET /api/2.0/preview/scim/v2/Users

Gets details for all the users associated with a <Databricks> workspace.

API scopes: scim

Parameters

attributesstringquery

Comma-separated list of attributes to return in response.

countint64<= 100query

Desired number of results per page.

excludedAttributesstringquery

Comma-separated list of attributes to exclude in response.

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 "john" and userName co "doe" : Users whose displayName contains john and userName contains doe.
• displayName co "doe" : Users whose displayName contains doe.
• displayName eq "john" : Users whose displayName equals john.
• displayName ne "john" : Users whose displayName not equals john.
• displayName co "john" or userName co "doe" : Users whose displayName contains john or userName contains doe.
• displayName sw "jo" : Users whose displayName starts with jo.

sortBystringquery

Attribute to sort the results. Multi-part paths are supported. For example, userName, name.givenName, and emails.

sortOrderstringquery

The order to sort the results.

Values:

• ORDER_UNSPECIFIED
• ascending
• descending

startIndexint64query

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

Response

Returns a list of User objects.

View as Markdown

Response

{
  "itemsPerPage": 0,
  "Resources": [
    {
      "active": true,
      "displayName": "string",
      "emails": [
        {}
      ],
      "entitlements": [
        {}
      ],
      "externalId": "string",
      "groups": [
        {}
      ],
      "id": "string",
      "name": {},
      "roles": [
        {}
      ],
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ],
      "userName": "string"
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "startIndex": 1,
  "totalResults": 10
}

Create a new user Public Preview

POST /api/2.0/preview/scim/v2/Users

Creates a new user in the <Databricks> workspace. This new user will also be added to the <Databricks> account.

API scopes: scim

Request body

activeboolean

If this user is active

displayNamestring

String that represents a concatenation of given and family names. For example John Smith. This field cannot be updated through the Workspace SCIM APIs when identity federation is enabled. Use Account SCIM APIs to update displayName.

emailsarray of object

All the emails associated with the <Databricks> user.

Show child attributesHide child attributes

displaystring

primaryboolean

$refstring

typestring

valuestring

entitlementsarray of object

Entitlements assigned to the user. See assigning entitlements for a full list of supported values.

Show child attributesHide child attributes

displaystring

primaryboolean

$refstring

typestring

valuestring

externalIdstring

External ID is not currently supported. It is reserved for future use.

groupsarray of object

Show child attributesHide child attributes

displaystring

primaryboolean

$refstring

typestring

valuestring

idstringint64

<Databricks> user ID.

nameobject

Show child attributesHide child attributes

familyNamestring

Family name of the <Databricks> user.

givenNamestring

Given name of the <Databricks> user.

rolesarray of object

Corresponds to AWS instance profile/arn role.

Show child attributesHide child attributes

displaystring

primaryboolean

$refstring

typestring

valuestring

schemasarray of string

The schema of the user.

Values:

• USER_SCHEMA_UNSPECIFIED
• urn:ietf:params:scim:schemas:core:2.0:User
• urn:ietf:params:scim:schemas:extension:workspace:2.0:User

userNamestringemail

Email address of the <Databricks> user.

Response

Returns the User object.

View as Markdown

Request

{
  "active": true,
  "displayName": "string",
  "emails": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "entitlements": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "externalId": "string",
  "groups": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "id": "string",
  "name": {
    "familyName": "string",
    "givenName": "string"
  },
  "roles": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "userName": "string"
}

Response

{
  "active": true,
  "displayName": "string",
  "emails": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "entitlements": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "externalId": "string",
  "groups": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "id": "string",
  "name": {
    "familyName": "string",
    "givenName": "string"
  },
  "roles": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "userName": "string"
}

Replace a user Public Preview

PUT /api/2.0/preview/scim/v2/Users/{id}

Replaces a user's information with the data supplied in request. The userName and emails attributes cannot be updated through this API; any supplied changes to them are ignored (no-op).

API scopes: scim

Parameters

idstringint64Requiredpath

<Databricks> user ID.

Request body

activeboolean

If this user is active

displayNamestring

String that represents a concatenation of given and family names. For example John Smith. This field cannot be updated through the Workspace SCIM APIs when identity federation is enabled. Use Account SCIM APIs to update displayName.

emailsarray of object

All the emails associated with the <Databricks> user. This attribute cannot be updated through the SCIM PATCH or PUT APIs; any supplied change is ignored.

Show child attributesHide child attributes

displaystring

primaryboolean

$refstring

typestring

valuestring

entitlementsarray of object

Entitlements assigned to the user. See assigning entitlements for a full list of supported values.

Show child attributesHide child attributes

displaystring

primaryboolean

$refstring

typestring

valuestring

externalIdstring

External ID is not currently supported. It is reserved for future use.

groupsarray of object

Show child attributesHide child attributes

displaystring

primaryboolean

$refstring

typestring

valuestring

nameobject

Show child attributesHide child attributes

familyNamestring

Family name of the <Databricks> user.

givenNamestring

Given name of the <Databricks> user.

rolesarray of object

Corresponds to AWS instance profile/arn role.

Show child attributesHide child attributes

displaystring

primaryboolean

$refstring

typestring

valuestring

schemasarray of string

The schema of the user.

Values:

• USER_SCHEMA_UNSPECIFIED
• urn:ietf:params:scim:schemas:core:2.0:User
• urn:ietf:params:scim:schemas:extension:workspace:2.0:User

userNamestringemail

Email address of the <Databricks> user. This attribute cannot be updated through the SCIM PATCH or PUT APIs; any supplied change is ignored.

View as Markdown

Request

{
  "active": true,
  "displayName": "string",
  "emails": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "entitlements": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "externalId": "string",
  "groups": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "name": {
    "familyName": "string",
    "givenName": "string"
  },
  "roles": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "userName": "string"
}

Response

{}

Delete a user Public Preview

DELETE /api/2.0/preview/scim/v2/Users/{id}

Deletes a user. Deleting a user from a <Databricks> workspace also removes objects associated with the user.

API scopes: scim

Parameters

idstringint64Requiredpath

Unique ID for a user in the <Databricks> workspace.

View as Markdown

Response

{}

Update user details Public Preview

PATCH /api/2.0/preview/scim/v2/Users/{id}

Partially updates a user resource by applying the supplied operations on specific user attributes. The userName and emails attributes cannot be updated through this API; any supplied changes to them are ignored (no-op).

API scopes: scim

Parameters

idstringint64Requiredpath

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": "add",
      "path": "string",
      "value": {}
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ]
}

Response

{}