SCIM API 2.0(用户)工作区
预览
这个特性是在公共预览。
这是一个为用户工作空间层SCIM API参考文章。
您可以使用SCIM(用户)API来创建用户在砖和给他们适当的访问级别,从用户添加角色、删除角色,暂时锁定和解锁用户帐户,并删除用户访问(去除)当他们离开你的组织或不再需要访问数据砖工作区。
使用api来提供用户信息直接向您的帐户相反,看到的SCIM API 2.0(账户)。信息使用帐户级别或工作空间层SCIM供应时,看到的帐户级别和工作空间层SCIM。
错误代码,请参阅SCIM API 2.0错误代码。
让用户
端点 |
HTTP方法 |
|---|---|
|
|
管理用户:检索砖工作区中的所有用户的列表。
非管理用户:检索砖工作区中的所有用户的列表,返回用户名、用户显示名称和对象ID。
例子
这个例子得到所有用户的信息。
curl——netrc - x\https:// < databricks-instance > / api / 2.0 /预览/ scim / v2 /用户\|金桥。
下面的例子使用了情商(=)过滤器查询参数用户名得到一个特定用户的信息。
curl——netrc - x\“https:// < databricks-instance > / api / 2.0 /预览/ scim / v2 /用户?过滤器=用户名+ eq + <用户名>”\|金桥。
替换:
< databricks-instance >与砖工作区实例名例如,1234567890123456.7.gcp.www.neidfyre.com。<用户名>砖的工作空间的用户名的用户,例如someone@example.com。
创建用户
端点 |
HTTP方法 |
|---|---|
|
|
管理用户:在砖工作区中创建一个用户。用户将自动添加到帐户。看到如何砖同步用户工作区之间和账户?。
请求参数遵循标准的SCIM 2.0协议。
请求必须包含以下属性:
模式设置为urn: ietf:参数:scim:模式:核心:2.0:用户用户名
例子
curl——netrc - x\https:// < databricks-instance > / api / 2.0 /预览/ scim / v2 /用户\——头内容类型:应用程序/ scim + json的\——数据@create-user.json\|金桥。
create-user.json:
{“模式”:(“urn: ietf:参数:scim:模式:核心:2.0:用户”),“用户名”:“<用户名>”,“组织”:({“价值”:“123456”}),“权利”:【{“价值”:“allow-cluster-create”}]}
替换:
< databricks-instance >与砖工作区实例名例如,1234567890123456.7.gcp.www.neidfyre.com。<用户名>砖的工作空间的用户名的用户,例如someone@example.com。
列出可用的权利的砖身份类型,见:
更新用户的ID (补丁)
端点 |
HTTP方法 |
|---|---|
|
|
管理用户:更新用户资源对特定属性和操作,除了那些不变的(用户名和用户标识)。的补丁推荐的方法把方法设置或更新用户的权利。
请求参数遵循标准SCIM 2.0协议和依赖的价值模式属性。
例子
这个例子添加allow-cluster-create授权给指定的用户。
旋度——netrc - x的补丁\https:// < databricks-instance > / api / 2.0 /预览/ scim / v2 /用户/ <用户id >\——头内容类型:应用程序/ scim + json的\——数据@update-user.json\|金桥。
update-user.json:
{“模式”:(“urn: ietf:参数:scim: api:消息:2.0:PatchOp”),“操作”:({“人事处”:“添加”,“路径”:“权利”,“价值”:({“价值”:“allow-cluster-create”}]}]}
替换:
< databricks-instance >与砖工作区实例名例如,1234567890123456.7.gcp.www.neidfyre.com。<用户id >砖工作空间的用户的ID,例如2345678901234567。用户ID,电话让用户。
列出可用的权利的砖身份类型,见:
更新用户的ID (把)
端点 |
HTTP方法 |
|---|---|
|
|
管理用户:用户资源覆盖到多个属性,除了那些不变的(用户名和用户标识)。
请求必须包含模式属性设置为urn: ietf:参数:scim:模式:核心:2.0:用户。
请注意
的补丁推荐的方法把方法设置或更新用户的权利。
例子
本例中指定用户的变化现在只有以前的权利allow-cluster-create权利。
curl——netrc - x\https:// < databricks-instance > / api / 2.0 /预览/ scim / v2 /用户/ <用户id >\——头内容类型:应用程序/ scim + json的\——数据@overwrite-user.json\|金桥。
overwrite-user.json:
{“模式”:(“urn: ietf:参数:scim:模式:核心:2.0:用户”),“用户名”:“<用户名>”,“权利”:({“价值”:“allow-cluster-create”}]}
替换:
< databricks-instance >与砖工作区实例名例如,1234567890123456.7.gcp.www.neidfyre.com。<用户id >砖工作空间的用户的ID,例如2345678901234567。用户ID,电话让用户。<用户名>砖的工作空间的用户名的用户,例如someone@example.com。用户名,电话让用户。
列出可用的权利的砖身份类型,见:
删除用户的ID
端点 |
HTTP方法 |
|---|---|
|
|
管理用户:删除一个用户资源。用户并不拥有或属于一个工作区砖30天后自动清除。
删除一个用户还从工作区中删除对象与用户相关联。例如,笔记本电脑存档,集群被终止,和就业变成无主的。
用户的主目录并不是自动删除。只有管理员可以访问或删除删除用户的主目录。
访问控制列表(ACL)配置的用户即使在保留用户从工作区中删除。
激活和停用的用户ID
预览
这个特性是在公共预览。
端点 |
HTTP方法 |
|---|---|
|
|
管理用户:激活或禁用用户。去活化用户删除用户的所有访问工作区但是权限和对象与用户保持不变。集群与用户保持运行,和笔记本电脑留在原来的位置。用户的令牌保留但不能用于验证用户停用。安排工作,然而,失败除非分配给一个新主人。
您可以使用让用户和得到用户的ID请求查看用户是否活跃不活跃。
请注意
允许至少5分钟的缓存清除失活生效。
设置活动的价值假禁用用户真正的激活用户。
例子
请求
旋度——netrc - x的补丁\https:// < databricks-instance > / api / 2.0 /预览/ scim / v2 /用户/ <用户id >\——头内容类型:应用程序/ scim + json的\——数据@toggle-user-activation.json\|金桥。
toggle-user-activation.json:
{“模式”:(“urn: ietf:参数:scim: api:消息:2.0:PatchOp”),“操作”:({“人事处”:“替换”,“路径”:“活跃”,“价值”:({“价值”:“假”}]}]}
替换:
< databricks-instance >与砖工作区实例名例如,1234567890123456.7.gcp.www.neidfyre.com。<用户id >砖工作空间的用户的ID,例如2345678901234567。
自动禁用用户
预览
这个特性是在公共预览。
管理用户:禁用用户没有登录一个可定制的段。计划工作由用户活动也会被考虑。
端点 |
HTTP方法 |
|---|---|
|
|
请求主体是一个键-值对的值是期限多久之前可以不活跃的用户被自动释放。