Scim API 2.0

预览

此功能已在公共预览

本文描述如何使用Databricks SCIM api向Databricks提供用户、服务主体和组。

SCIM,或跨域身份管理系统,是一个开放标准,允许您自动化用户配置。Databricks既支持基于ui的SCIM供应,也支持使用REST api和JSON的供应。Databricks SCIM API遵循SCIM协议2.0版本。

有关基于ui的SCIM配置设置,请参见从您的标识提供程序同步用户和组

帐户级和工作空间级的SCIM

您可以使用帐户级别的SCIM供应从您的身份提供者配置到Databricks帐户的SCIM供应连接器,或者使用工作空间级别的SCIM供应将SCIM供应连接器配置到每个工作空间。

  • 帐户级别的SCIM配置:您可以使用帐户级别的SCIM供应从帐户中创建、更新和删除用户。

  • 工作空间级别的SCIM配置:您可以使用工作空间级别的SCIM配置从各个工作空间创建、更新和删除用户。

要使用REST API管理帐户级SCIM供应,请参见:

要使用REST API管理工作空间级别的SCIM供应,请参见:

有关工作区级与帐户级SCIM供应的更多信息,请参见从您的标识提供程序同步用户和组

您的Databricks帐户必须具有Databricks高级计划

SCIM 2.0接口

一个砖工作空间管理可以调用所有工作空间级别的SCIM API端点:

非管理用户和服务主体可以调用工作区级别获取端点,工作区级别用户获取端点以显示名称和id以及工作空间级别集团获取端点以显示组显示名称和id。

帐户管理员可以调用帐户级别的SCIM API端点:

有关错误代码,请参见SCIM API 2.0错误代码

调用工作空间级的SCIM api

要调用工作空间级别的SCIM api,请替换< databricks-instance >工作空间的URL您的Databricks部署。

https//<-实例>/api/2.0/预览/scim/v2/<api-端点>

调用帐户级SCIM api

您必须是帐户admin才能调用SCIM API 2.0(帐户)

上调用帐户级SCIM APIaccounts.gcp.www.neidfyre.com域,而不是工作空间域。例如:

https//账户gcpcom/api/2.0/账户/account_id/scim/v2/用户/user_id

头参数

参数

类型

描述

授权(必需)

或者:

. netrc档案(如使用旋度

字符串

设置为持票人<访问令牌>

重要!生成这个令牌的Databricks管理用户不应该由您的身份提供者(IdP)管理。可以使用IdP解除由IdP管理的Databricks管理用户的配置,这将导致禁用SCIM配置集成。

而不是授权标题,您可以使用. netrc——netrc(或- n)选项。该文件将机器名和令牌与代码分开存储,从而减少了多次键入凭据字符串的需要。的. netrc的每个组合包含一个条目< databricks-instance >和令牌。例如:

< databricks-instance >登录令牌密码<访问令牌>

内容类型(写入操作所需)

字符串

设置为应用程序/ scim + json

接受(读取操作所需)

字符串

设置为应用程序/ scim + json

过滤结果

使用筛选器返回用户或组的子集。对于所有用户,用户用户名和组displayName支持字段。管理员用户可以在活跃的属性。

操作符

描述

行为

情商

=

属性值和操作符值必须相同。

不等于

属性和操作符值不相同。

有限公司

包含

操作符值必须是属性值的子字符串。

西南

开始于

属性必须以运算符值开头并包含运算符值。

而且

逻辑和

当所有表达式的值为true时进行匹配。

逻辑或

当任何表达式的值为true时进行匹配。

排序结果

使用sortBy而且排序方式查询参数.默认情况下是按ID排序。