SCIM API 2.0 (Felhasználók)

Fontos

Ez a funkció a nyilvános előzetes verzióban érhető el.

Egy Azure Databricks-rendszergazda az összes SCIM API-végpontot meghívhatja. A nem rendszergazdai felhasználók meghívhatja a Felhasználók beolvassa végpontot a felhasználó megjelenítendő nevének és azonosítójának olvasása érdekében.

Megjegyzés

Minden munkaterület legfeljebb 10 000 felhasználóval és 5000 csoporttal lehet. A szolgáltatásnév beleszámít a felhasználó maximális értékére.

Az SCIM (Felhasználók) segítségével felhasználókat hozhat létre az Azure Databricks-ban, megfelelő szintű hozzáférést adhat nekik, ideiglenesen zárolhatja és feloldhatja a felhasználói fiókokat, valamint megszüntetheti a hozzáférést a felhasználók számára (megszüntetheti őket), amikor elhagyják a szervezetet, vagy már nincs szükségük a Azure Databricks.

Követelmények

Az Azure Databricks-fióknak a következő csomagokkal kell Azure Databricks Prémium:.

Felhasználók lekért száma

Végpont HTTP-metódus
2.0/preview/scim/v2/Users GET

Rendszergazdai felhasználók: A munkaterületen található összes felhasználó Azure Databricks lekérése.

Nem rendszergazdai felhasználók: Lekéri a Azure Databricks munkaterületen lévő összes felhasználó listáját, és csak a felhasználónevet, a felhasználó megjelenítendő nevét és az objektumazonosítót adja vissza.

Példák

Ez a példa az összes felhasználóról lekért információt.

curl --netrc -X GET \
https://<databricks-instance>/api/2.0/preview/scim/v2/Users \
| jq .

Ez a példa az (egyenlő) szűrőlekérdezés paraméterét használja a paraméterrel egy adott eqequserName felhasználóval kapcsolatos információk lekérdezhetők.

curl --netrc -X GET \
"https://<databricks-instance>/api/2.0/preview/scim/v2/Users?filter=userName+eq+<username>" \
| jq .

Cserélje le ezt:

  • <databricks-instance> a <databricks-instance>például adb-1234567890123456.7.azuredatabricks.net : .
  • <username> a Azure Databricks felhasználó felhasználónevével, például someone@example.com : .

Ez a példa egy .netrc-fájlt ésegy jq fájlt használ.

Felhasználó lekérte azonosító alapján

Végpont HTTP-metódus
2.0/preview/scim/v2/Users/{id} GET

Rendszergazdai felhasználók: Egyetlen felhasználói erőforrás lekérése a Azure Databricks munkaterületről a Azure Databricks alapján.

Példa

Kérés

curl --netrc -X GET \
https://<databricks-instance>/api/2.0/preview/scim/v2/Users/<user-id> \
| jq .

Cserélje le ezt:

  • <databricks-instance> a <databricks-instance>például adb-1234567890123456.7.azuredatabricks.net : .
  • <user-id> a Azure Databricks munkaterület-azonosítójával, 2345678901234567 például: . A felhasználói azonosító lehíváshoz hívja meg a Get users (Felhasználók lehívása) hívást.

Ez a példa egy .netrc-fájlt ésegy jq fájlt használ.

Reagálás

Felhasználó létrehozása

Végpont HTTP-metódus
2.0/preview/scim/v2/Users POST

Rendszergazdai felhasználók: Hozzon létre egy felhasználót a Azure Databricks munkaterületen.

A kérelemparaméterek a szabványos SCIM 2.0 protokollt követik.

A kérelmeknek a következő attribútumokat kell tartalmazniuk:

  • schemas állítsa a halmazt a urn:ietf:params:scim:schemas:core:2.0:User
  • userName

Példa

curl --netrc -X POST \
https://<databricks-instance>/api/2.0/preview/scim/v2/Users \
--header 'Content-type: application/scim+json' \
--data @create-user.json \
| jq .

create-user.json:

{
  "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ],
  "userName": "<username>",
  "groups": [
    {
       "value":"123456"
    }
  ],
  "entitlements":[
    {
       "value":"allow-cluster-create"
    }
  ]
}

Cserélje le ezt:

  • <databricks-instance> a <databricks-instance>például adb-1234567890123456.7.azuredatabricks.net : .
  • <username> a Azure Databricks felhasználó felhasználónevével, például someone@example.com : .

Ez a példa egy .netrc-fájlt ésegy jq fájlt használ.

Felhasználó frissítése azonosító ( PATCH ) alapján

Végpont HTTP-metódus
2.0/preview/scim/v2/Users/{id} PATCH

Rendszergazdai felhasználók: A felhasználói erőforrásokat adott attribútumokkal kapcsolatos műveletekkel frissítheti, kivéve azokat, amelyek nem módosíthatók ( userName és userId ). A felhasználói jogosultságok beállításának vagy frissítésének módszeréhez a metódus PATCHPUT használata javasolt.

A kérelemparaméterek a szabványos SCIM 2.0 protokollt követik, és az attribútum értékével schemas függenek.

Példa

Ez a példa hozzáadja allow-cluster-create a jogosultságot a megadott felhasználóhoz.

curl --netrc -X PATCH \
https://<databricks-instance>/api/2.0/preview/scim/v2/Users/<user-id> \
--header 'Content-type: application/scim+json' \
--data @update-user.json \
| jq .

update-user.json:

{
  "schemas": [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ],
  "Operations": [
    {
      "op": "add",
      "path": "entitlements",
      "value": [
        {
           "value": "allow-cluster-create"
        }
      ]
    }
  ]
}

Cserélje le ezt:

  • <databricks-instance> a <databricks-instance>például adb-1234567890123456.7.azuredatabricks.net : .
  • <user-id> a Azure Databricks munkaterület-azonosítójával, 2345678901234567 például: . A felhasználói azonosító lehíváshoz hívja meg a Get users (Felhasználók lehívása) hívást.

Ez a példa egy .netrc-fájlt ésegy jq fájlt használ.

Felhasználó frissítése azonosító ( PUT ) alapján

Végpont HTTP-metódus
2.0/preview/scim/v2/Users/{id} PUT

Rendszergazdai felhasználók: Írja felül a felhasználói erőforrást több attribútumra, kivéve azokat, amelyek nem módosíthatók ( userName és userId ).

A kérelemnek tartalmaznia kell schemas a attribútumot, amely a következőre van beállítva: urn:ietf:params:scim:schemas:core:2.0:User .

Megjegyzés

A felhasználói jogosultságok beállításának vagy frissítésének módszeréhez a metódus PATCHPUT használata javasolt.

Példa

Ez a példa úgy módosítja a megadott felhasználó korábbi jogosultságát, hogy csak a jogosultsággal allow-cluster-create legyen.

curl --netrc -X PUT \
https://<databricks-instance>/api/2.0/preview/scim/v2/Users/<user-id> \
--header 'Content-type: application/scim+json' \
--data @overwrite-user.json \
| jq .

overwrite-user.json:

{
  "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ],
  "userName": "<username>",
  "entitlements": [
    {
      "value": "allow-cluster-create"
    }
  ]
}

Cserélje le ezt:

  • <databricks-instance> a <databricks-instance>például adb-1234567890123456.7.azuredatabricks.net : .
  • <user-id> a Azure Databricks munkaterület-azonosítójával, 2345678901234567 például: . A felhasználói azonosító lehíváshoz hívja meg a Get users (Felhasználók lehívása) hívást.
  • <username> a Azure Databricks felhasználó felhasználónevével, például someone@example.com : . A felhasználónév lehíváshoz hívja meg a Get users (Felhasználók lehívása) hívást.

Ez a példa egy .netrc-fájlt ésegy jq fájlt használ.

Felhasználó törlése azonosító alapján

Végpont HTTP-metódus
2.0/preview/scim/v2/Users/{id} DELETE

Rendszergazdai felhasználók: Felhasználói erőforrás eltávolítása. A rendszer 30 nap után automatikusan kiüríti azt a felhasználót, aki nem a munkaterülethez tartozik vagy Azure Databricks rendelkezik a munkaterülettel.

Ha töröl egy felhasználót egy munkaterületről, azzal a felhasználóhoz társított objektumokat is eltávolítja. A jegyzetfüzetek például archiválva vannak, a fürtök leállnak, és a feladatok tulajdonos nélküliek lesznek.

A felhasználó kezdőkönyvtára nem törlődik automatikusan. Egy törölt felhasználó kezdőkönyvtárához csak rendszergazda férhet hozzá vagy távolíthat el.

Példakérelem

curl --netrc -X DELETE \
https://<databricks-instance>/api/2.0/preview/scim/v2/Users/<user-id>

Cserélje le ezt:

  • <databricks-instance> a <databricks-instance>például adb-1234567890123456.7.azuredatabricks.net : .
  • <user-id> a Azure Databricks munkaterület-azonosítójával, 2345678901234567 például: . A felhasználói azonosító lehíváshoz hívja meg a Get users (Felhasználók lehívása) hívást.

Ez a példa egy .netrc fájlt használ.

Felhasználó aktiválása és inaktiválása azonosító alapján

Fontos

Ez a funkció a nyilvános előzetes verzióban érhető el.

Végpont HTTP-metódus
2.0/preview/scim/v2/Users/{id} PATCH

Rendszergazdai felhasználók: Felhasználó aktiválása vagy inaktiválása. A felhasználó inaktiválásával a felhasználó minden munkaterülethez hozzáférhet, de a felhasználóhoz társított engedélyeket és objektumokat változatlanul hagyja. A felhasználóhoz társított fürtök továbbra is futnak, és a jegyzetfüzetek az eredeti helyükön maradnak. A felhasználó jogkivonatai megmaradnak, de nem használhatók hitelesítésre a felhasználó inaktiválása közben. Az ütemezett feladatok azonban meghiúsulnak, kivéve, ha új tulajdonoshoz rendelik hozzá.

A Felhasználók lekérése és a Felhasználó lekérése azonosító alapján kérésekkel megtekintheti, hogy a felhasználók aktívak vagy inaktívak.

Megjegyzés

Legalább öt percet hagyjon a gyorsítótár kiürítésének, hogy az inaktiválás aktivációja életbe lép.

Fontos

A Azure Active Directory Azure Databricks előfizetés közreműködői vagy tulajdonosi szerepkörével Azure Databricks Azure AD bejelentkezési folyamatával újraaktiválhatja magát. Ha egy ilyen szerepkört használó felhasználót inaktiválni kell, akkor a jogosultságait is vissza kell vonnia az előfizetésben.

Állítsa az aktív értéket értékre a felhasználó inaktiválásához és a felhasználó falsetrue aktiválásához.

Példa

Kérés

curl --netrc -X PATCH \
https://<databricks-instance>/api/2.0/preview/scim/v2/Users/<user-id> \
--header 'Content-type: application/scim+json' \
--data @toggle-user-activation.json \
| jq .

toggle-user-activation.json:

{
  "schemas": [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ],
  "Operations": [
    {
      "op": "replace",
      "path": "active",
      "value": [
        {
          "value": "false"
        }
      ]
    }
  ]
}

Cserélje le ezt:

  • <databricks-instance> a Azure Databricks példány <databricks-instance>például adb-1234567890123456.7.azuredatabricks.net : .
  • <user-id> a Azure Databricks munkaterület-azonosítójával, 2345678901234567 például: .

Ez a példa egy .netrc-fájlt ésegy jq fájlt használ.

Reagálás

{
  "emails": [
    {
      "type": "work",
      "value": "someone@example.com",
      "primary": true
    }
  ],
  "displayName": "Someone User",
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User",
    "urn:ietf:params:scim:schemas:extension:workspace:2.0:User"
  ],
  "name": {
    "familyName": "User",
    "givenName": "Someone"
  },
  "active": false,
  "groups": [],
  "id": "123456",
  "userName": "someone@example.com"
}

Aktív és inaktív felhasználók szűrése

Fontos

Ez a funkció a nyilvános előzetes verzióban érhető el.

Végpont HTTP-metódus
2.0/preview/scim/v2/Users GET

Rendszergazdai felhasználók: Az aktív vagy inaktív felhasználók listájának lekérése.

Példa

curl --netrc -X GET \
"https://<databricks-instance>/api/2.0/preview/scim/v2/Users?filter=active+eq+false" \
| jq .

Cserélje <databricks-instance> le a helyére Azure Databricks munkaterület <databricks-instance>adb-1234567890123456.7.azuredatabricks.net például: .

Ez a példa egy .netrc-fájlt ésegy jq fájlt használ.

Felhasználók automatikus inaktiválása

Fontos

Ez a funkció a nyilvános előzetes verzióban érhető el.

Rendszergazdai felhasználók: Inaktiválja a testre szabható ideig nem bejelentkezett felhasználókat. A felhasználó által birtokolt ütemezett feladatok szintén tevékenységnek minősülnek.

Végpont HTTP-metódus
2.0/preview/workspace-conf PATCH

A kérelem törzse egy kulcs-érték pár, ahol az érték az az időkorlát, ameddig a felhasználó inaktív lehet az automatikus inaktiválás előtt.

Példa

curl --netrc -X PATCH \
https://<databricks-instance>/api/2.0/preview/workspace-conf \
--data @deactivate-users.json \
| jq .

deactivate-users.json:

{
  "maxUserInactiveDays": "90"
}

Cserélje <databricks-instance> le a helyére Azure Databricks munkaterület <databricks-instance>adb-1234567890123456.7.azuredatabricks.net például: .

Ez a példa egy .netrc-fájlt ésegy jq fájlt használ.

Munkaterület maximális felhasználói inaktivitási időtartamának leése

Fontos

Ez a funkció a nyilvános előzetes verzióban érhető el.

Rendszergazdai felhasználók: Lekérik a munkaterülethez meghatározott felhasználói inaktivitási korlátot.

Végpont HTTP-metódus
2.0/preview/workspace-conf GET

Példakérelem

curl --netrc -X GET \
"https://<databricks-instance>/api/2.0/preview/workspace-conf?keys=maxUserInactiveDays" \
| jq .

Cserélje <databricks-instance> le a helyére Azure Databricks munkaterület <databricks-instance>adb-1234567890123456.7.azuredatabricks.net például: .

Ez a példa egy .netrc-fájlt ésegy jq fájlt használ.

Példaválasz

{
  "maxUserInactiveDays": "90"
}