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 >與磚工作區實例名例如,dbc-a1b2345c-d6e7.cloud.www.eheci.com。<用戶名>磚的工作空間的用戶名的用戶,例如someone@example.com。
得到用戶的ID
端點 |
HTTP方法 |
|---|---|
|
|
管理用戶:檢索單個用戶資源從磚工作區,鑒於其磚ID。
例子
請求
curl——netrc - x\https:// < databricks-instance > / api / 2.0 /預覽/ scim / v2 /用戶/ <用戶id >\|金橋。
替換:
創建用戶
端點 |
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 >與磚工作區實例名例如,dbc-a1b2345c-d6e7.cloud.www.eheci.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 >與磚工作區實例名例如,dbc-a1b2345c-d6e7.cloud.www.eheci.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 >與磚工作區實例名例如,dbc-a1b2345c-d6e7.cloud.www.eheci.com。<用戶id >磚工作空間的用戶的ID,例如2345678901234567。用戶ID,電話讓用戶。<用戶名>磚的工作空間的用戶名的用戶,例如someone@example.com。用戶名,電話讓用戶。
列出可用的權利的磚身份類型,見:
添加角色的用戶ID
端點 |
HTTP方法 |
|---|---|
|
|
例子
旋度——netrc - x的補丁\https:// < databricks-instance > / api / 2.0 /預覽/ scim / v2 /用戶/ <用戶id >\——頭內容類型:應用程序/ scim + json的\——數據@add-role-to-user.json\|金橋。
add-role-to-user.json:
{“模式”:(“urn: ietf:參數:scim: api:消息:2.0:PatchOp”),“操作”:({“人事處”:“添加”,“路徑”:“角色”,“價值”:({“價值”:“< role-arn >或< instance-profile-role-arn >”}]}]}
替換:
刪除角色從一個用戶ID
端點 |
HTTP方法 |
|---|---|
|
|
例子
旋度——netrc - x的補丁\https:// < databricks-instance > / api / 2.0 /預覽/ scim / v2 /用戶/ <用戶id >\——頭內容類型:應用程序/ scim + json的\——數據@remove-role-from-user.json\|金橋。
remove-role-from-user.json:
{“模式”:(“urn: ietf:參數:scim: api:消息:2.0:PatchOp”),“操作”:({“人事處”:“刪除”,“路徑”:“角色(eq值\“< role-arn >或< instance-profile-role-arn > \”)”}]}
替換:
刪除用戶的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 >與磚工作區實例名例如,dbc-a1b2345c-d6e7.cloud.www.eheci.com。<用戶id >磚工作空間的用戶的ID,例如2345678901234567。
自動禁用用戶
預覽
這個特性是在公共預覽。
管理用戶:禁用用戶沒有登錄一個可定製的段。計劃工作由用戶活動也會被考慮。
端點 |
HTTP方法 |
|---|---|
|
|
請求主體是一個鍵-值對的值是期限多久之前可以不活躍的用戶被自動釋放。