SCIM API 2.0

预览

这个特性是在公共预览。

本文描述了如何使用砖SCIM api来提供用户、服务主体,砖和组。

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

基于ui SCIM配置设置,请参阅同步用户和组身份提供商。

帐户级别和工作空间层SCIM供应

您可以配置一个SCIM配置连接器从你的身份提供者砖账户,使用帐户级别SCIM供应,或配置独立SCIM每个工作区,配置连接器使用工作空间层SCIM供应。

  • 帐户级别SCIM配置:砖推荐你使用帐户级别SCIM提供创建、更新和删除所有用户的账户。你将管理用户和组的分配在砖工作区。你的工作必须支持联合身份验证为了管理的分配用户工作区。砖建议您指定用户工作区使用工作区任务API。

帐户级别SCIM图

  • 工作空间层SCIM配置:如果没有启用您的工作区联合身份验证,或者如果你有一个混合的工作区,一些支持联合身份验证,有些没有,你必须管理帐户级别和工作空间层SCIM并行配置。在混合的情况下,你不需要工作空间层SCIM提供任何支持联合身份验证的工作区。

    如果你已经有工作空间层SCIM配置设置工作区,使联合身份验证,您应该设置帐户级别SCIM供应和关闭工作空间层SCIM粮食供应者。看到工作空间层SCIM配置迁移到帐户的水平。

管理帐户级别SCIM为用户供应,服务主体,使用REST API和组,见:

使用REST API管理工作空间层SCIM配置,见:

关于工作的更多信息和帐户级别SCIM供应、明白了同步用户和组身份提供商。

需求

SCIM 2.0 api

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

非管理用户和服务主体可以调用工作空间层我端点,工作空间层用户端点来显示名称和id,和工作空间层集团让终端显示组显示名称和id。

账户管理员可以调用户头级别SCIM API端点:

错误代码,请参阅SCIM API 2.0错误代码。

调用工作空间层SCIM api

打电话给工作空间层SCIM api,替换< databricks-instance >与工作空间的URL你的砖部署。

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

电话帐户级别SCIM api

你一定是一个帐户管理调用SCIM API 2.0(账户)。

你的帐户级别SCIM API调用accounts.cloud.www.neidfyre.com域,而不是你的工作空间域。例如:

https:/ /账户。云。砖。com/api/2.0/账户/{account_id}/scim/v2/用户/{user_id}

头参数

参数

类型

描述

授权(必需)

或者:

的. netrc文件(如果使用旋度)

字符串

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

看到身份验证使用砖个人的访问令牌学习如何使用UI和生成令牌令牌API 2.0学习如何使用API生成令牌。

重要!砖的管理员用户生成这个令牌不应该由你的身份提供者(IdP)。一砖管理用户管理的国内流离失所者可以去除使用国内流离失所者,这将导致您的SCIM供应集成将被禁用。

而不是一个授权头,您可以使用. netrc文件以及——netrc(或- n)选项。这个文件存储机器名称和标记代码分开,减少了需要多次凭证类型字符串。的. netrc为每个组合包含一个条目< databricks-instance >和令牌。例如:

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

内容类型(要求写操作)

字符串

设置为应用程序/ scim + json。

接受(所需读取操作)

字符串

设置为应用程序/ scim + json。

过滤结果

使用过滤器来返回一个用户或组的子集。对于所有用户来说,用户用户名和组displayName支持领域。管理员用户可以过滤用户活跃的属性。

操作符

描述

行为

情商

=

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

不

不等于

属性和操作符的值是不相同的。

有限公司

包含

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

西南

开始于

属性必须开始,包含操作符的值。

和

逻辑和

当所有匹配表达式计算为true。

或

逻辑或

匹配任何表达式的求值结果为true。

排序结果

排序结果使用sortBy和排序方式查询参数。默认是按ID排序。