a.users_v2: Account Users

class databricks.sdk.service.iam.AccountUsersV2API

User identities recognized by Databricks and represented by email addresses.

Databricks recommends using SCIM provisioning to sync users and groups automatically from your identity provider to your Databricks account. SCIM streamlines onboarding a new employee or team by using your identity provider to create users and groups in Databricks account and give them the proper level of access. When a user leaves your organization or no longer needs access to Databricks account, admins can terminate the user in your identity provider and that user’s account will also be removed from Databricks account. This ensures a consistent offboarding process and prevents unauthorized users from accessing sensitive data.

create([, active: Optional[bool], display_name: Optional[str], emails: Optional[List[ComplexValue]], external_id: Optional[str], id: Optional[str], name: Optional[Name], roles: Optional[List[ComplexValue]], user_name: Optional[str]]) → AccountUser

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

Parameters:

  • active – bool (optional) If this user is active

  • display_name – str (optional) String that represents a concatenation of given and family names. For example John Smith.

  • emails – List[ComplexValue] (optional) All the emails associated with the Databricks user.

  • external_id – str (optional) External ID is not currently supported. It is reserved for future use.

  • id – str (optional) Databricks user ID.

  • name – Name (optional)

  • roles – List[ComplexValue] (optional) Indicates if the group has the admin role.

  • user_name – str (optional) Email address of the Databricks user.

Returns:

AccountUser

delete(id: str)

Deletes a user. Deleting a user from a Databricks account also removes objects associated with the user.

Parameters:

id – str Unique ID for a user in the Databricks account.

get(id: str [, attributes: Optional[str], count: Optional[int], excluded_attributes: Optional[str], filter: Optional[str], sort_by: Optional[str], sort_order: Optional[GetSortOrder], start_index: Optional[int]]) → AccountUser

Gets information for a specific user in Databricks account.

Parameters:

  • id – str Unique ID for a user in the Databricks account.

  • attributes – str (optional) Comma-separated list of attributes to return in response.

  • count – int (optional) Desired number of results per page. Default is 10000.

  • excluded_attributes – str (optional) Comma-separated list of attributes to exclude in response.

  • filter –

    str (optional) 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.

    [SCIM RFC]: https://tools.ietf.org/html/rfc7644#section-3.4.2.2

  • sort_by – str (optional) Attribute to sort the results. Multi-part paths are supported. For example, userName, name.givenName, and emails.

  • sort_order – GetSortOrder (optional) The order to sort the results.

  • start_index – int (optional) Specifies the index of the first result. First item is number 1.

Returns:

AccountUser

list([, attributes: Optional[str], count: Optional[int], excluded_attributes: Optional[str], filter: Optional[str], sort_by: Optional[str], sort_order: Optional[ListSortOrder], start_index: Optional[int]]) → Iterator[AccountUser]

Gets details for all the users associated with a Databricks account.

Parameters:

  • attributes – str (optional) Comma-separated list of attributes to return in response.

  • count – int (optional) Desired number of results per page. Default is 10000.

  • excluded_attributes – str (optional) Comma-separated list of attributes to exclude in response.

  • filter –

    str (optional) 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.

    [SCIM RFC]: https://tools.ietf.org/html/rfc7644#section-3.4.2.2

  • sort_by – str (optional) Attribute to sort the results. Multi-part paths are supported. For example, userName, name.givenName, and emails.

  • sort_order – ListSortOrder (optional) The order to sort the results.

  • start_index – int (optional) Specifies the index of the first result. First item is number 1.

Returns:

Iterator over AccountUser

patch(id: str [, operations: Optional[List[Patch]], schemas: Optional[List[PatchSchema]]])

Partially updates a user resource by applying the supplied operations on specific user attributes.

Parameters:
update(id: str [, active: Optional[bool], display_name: Optional[str], emails: Optional[List[ComplexValue]], external_id: Optional[str], name: Optional[Name], roles: Optional[List[ComplexValue]], user_name: Optional[str]])

Replaces a user’s information with the data supplied in request.

Parameters:

  • id – str Databricks user ID.

  • active – bool (optional) If this user is active

  • display_name – str (optional) String that represents a concatenation of given and family names. For example John Smith.

  • emails – List[ComplexValue] (optional) All the emails associated with the Databricks user.

  • external_id – str (optional) External ID is not currently supported. It is reserved for future use.

  • name – Name (optional)

  • roles – List[ComplexValue] (optional) Indicates if the group has the admin role.

  • user_name – str (optional) Email address of the Databricks user.