a.service_principals_v2: Account Service Principals

class databricks.sdk.service.iam.AccountServicePrincipalsV2API

Identities for use with jobs, automated tools, and systems such as scripts, apps, and CI/CD platforms. Databricks recommends creating service principals to run production jobs or modify production data. If all processes that act on production data run with service principals, interactive users do not need any write, delete, or modify privileges in production. This eliminates the risk of a user overwriting production data by accident.

create([, active: Optional[bool], application_id: Optional[str], display_name: Optional[str], external_id: Optional[str], id: Optional[str], roles: Optional[List[ComplexValue]]]) → AccountServicePrincipal

Creates a new service principal in the Databricks account.

Parameters:

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

  • application_id – str (optional) UUID relating to the service principal

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

  • external_id – str (optional)

  • id – str (optional) Databricks service principal ID.

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

Returns:

AccountServicePrincipal

delete(id: str)

Delete a single service principal in the Databricks account.

Parameters:

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

get(id: str) → AccountServicePrincipal

Gets the details for a single service principal define in the Databricks account.

Parameters:

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

Returns:

AccountServicePrincipal

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[AccountServicePrincipal]

Gets the set of service principals 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.

  • 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 AccountServicePrincipal

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

Partially updates the details of a single service principal in the Databricks account.

Parameters:
update(id: str [, active: Optional[bool], application_id: Optional[str], display_name: Optional[str], external_id: Optional[str], roles: Optional[List[ComplexValue]]])

Updates the details of a single service principal.

This action replaces the existing service principal with the same name.

Parameters:

  • id – str Databricks service principal ID.

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

  • application_id – str (optional) UUID relating to the service principal

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

  • external_id – str (optional)

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