SCIM-API (ServicePrincipals)

Viktigt

Den här funktionen finns som allmänt tillgänglig förhandsversion.

Med SCIM (ServicePrincipals) kan du hantera Azure Active Directory tjänstens huvudnamn i Azure Databricks.

Krav

Ditt Azure Databricks konto måste ha Azure Databricks Premium Plan.

Hämta tjänstens huvudnamn

Slutpunkt HTTP-metod
2.0/preview/scim/v2/ServicePrincipals GET

Hämta en lista över alla tjänsthuvudnamn i Azure Databricks arbetsytan.

När det anropas av en icke-administratörsanvändare returneras endast användarnamnet, användarens visningsnamn och objekt.

Exempelbegäran

GET /api/2.0/preview/scim/v2/ServicePrincipals  HTTP/1.1
Host: <databricks-instance>
Accept: application/scim+json
Authorization: Bearer dapi48…a6138b

Du kan använda filter för att ange delmängder av tjänstens huvudnamn. Du kan till exempel använda eq filterparametern (lika med) för att applicationId hämta ett specifikt huvudnamn för tjänsten:

GET /api/2.0/preview/scim/v2/ServicePrincipals?filter=applicationId+eq+b4647a57-063a-43e3-a6b4-c9a4e9f9f0b7  HTTP/1.1
Host: <databricks-instance>
Accept: application/scim+json
Authorization: Bearer dapi48…a6138b

I arbetsytor med ett stort antal tjänsthuvudnamn kan du undanta attribut från begäran för att förbättra prestandan.

GET /api/2.0/preview/scim/v2/ServicePrincipals?excludedAttributes=entitlements,groups  HTTP/1.1
Host: <databricks-instance>
Accept: application/scim+json
Authorization: Bearer dapi48…a6138b

Hämta tjänstens huvudnamn efter ID

Slutpunkt HTTP-metod
2.0/preview/scim/v2/ServicePrincipals/{id} GET

Hämta en enskild resurs för tjänstens huvudnamn från Azure Databricks arbetsyta, givet ett Azure Databricks-ID.

Exempelbegäran

GET /api/2.0/preview/scim/v2/ServicePrincipals/7535194597985784  HTTP/1.1
Host: <databricks-instance>
Accept: application/scim+json
Authorization: Bearer dapi48…a6138b

Lägg till tjänstens huvudnamn

Slutpunkt HTTP-metod
2.0/preview/scim/v2/ServicePrincipals POST

Lägg till ett huvudnamn för tjänsten Azure Databricks arbetsytan. Tjänstens huvudnamn räknas mot gränsen på 10 000 användare per arbetsyta.

Begärandeparametrar följer standardprotokollet SCIM 2.0.

Begäranden bör innehålla följande attribut:

  • schemas: inställt på urn:ietf:params:scim:schemas:core:2.0:ServicePrincipal
  • applicationId: Azure AD-program-ID för tjänstens huvudnamn
  • displayName: valfritt

Exempelbegäran

POST /api/2.0/preview/scim/v2/ServicePrincipals HTTP/1.1
Host: <databricks-instance>
Authorization: Bearer dapi48…a6138b
Content-Type: application/scim+json
{
  "schemas":[
    "urn:ietf:params:scim:schemas:core:2.0:ServicePrincipal"
  ],
  "applicationId":"b4647a57-063a-43e3-a6b4-c9a4e9f9f0b7",
  "displayName":"test-service-principal",
  "groups":[
    {
       "value":"123456"
    }
  ],
  "entitlements":[
    {
       "value":"allow-cluster-create"
    }
  ]
}

Uppdatera tjänstens huvudnamn efter ID (PATCH)

Slutpunkt HTTP-metod
2.0/preview/scim/v2/ServicePrincipals/{id} PATCH

Uppdatera en resurs för tjänstens huvudnamn med åtgärder för specifika attribut, applicationId förutom och , som är id oföränderliga.

Använd metoden PATCH för att lägga till, uppdatera eller ta bort enskilda attribut. Använd PUT-metoden för att skriva över hela tjänstens huvudnamn i en enda åtgärd.

Begärandeparametrar följer standardprotokollet SCIM 2.0 och är beroende av attributets schemas värde.

Lägga till rättigheter

Exempelbegäran

PATCH /api/2.0/preview/scim/v2/ServicePrincipals/654321  HTTP/1.1
Host: <databricks-instance>
Content-Type: application/scim+json
Authorization: Bearer dapi48…a6138b
{
  "schemas":[
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations":[
    {
      "op":"add",
      "path":"entitlements",
      "value":[
        {
           "value":"allow-cluster-create"
        }
      ]
    }
  ]
}

Ta bort rättigheter

Exempelbegäran

PATCH /api/2.0/preview/scim/v2/ServicePrincipals/654321  HTTP/1.1
Host: <databricks-instance>
Content-Type: application/scim+json
Authorization: Bearer dapi48…a6138b
{
  "schemas":[
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations":[
    {
      "op":"remove",
      "path":"entitlements",
      "value":[
        {
           "value":"allow-cluster-create"
        }
      ]
    }
  ]
}

Lägga till i en grupp

Exempelbegäran

PATCH /api/2.0/preview/scim/v2/ServicePrincipals/654321  HTTP/1.1
Host: <databricks-instance>
Content-Type: application/scim+json
Authorization: Bearer dapi48…a6138b
{
  "schemas":[
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations":[
    {
      "op":"add",
      "path":"groups",
      "value":[
        {
           "value":"123456"
        }
      ]
    }
  ]
}

Ta bort från en grupp

Exempelbegäran

PATCH /api/2.0/preview/scim/v2/Groups/<group_id>  HTTP/1.1
Host: <databricks-instance>
Content-Type: application/scim+json
Authorization: Bearer dapi48…a6138b
{
  "schemas":[
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations":[
    {
      "op":"remove",
      "path":"members[value eq \"<service_principal_id>\"]"
    }
  ]
}

Uppdatera tjänstens huvudnamn efter ID (PUT)

Slutpunkt HTTP-metod
2.0/preview/scim/v2/ServicePrincipals/{id} PUT

Skriva över hela resursen för tjänstens huvudnamn, förutom applicationId och , som inte kan id ändras.

Använd PATCH-metoden för att lägga till, uppdatera eller ta bort enskilda attribut.

Viktigt

Du måste inkludera schemas attributet i begäran med det exakta värdet urn:ietf:params:scim:schemas:core:2.0:ServicePrincipal .

Exempelbegäran

Lägga till en rättighet

PUT /api/2.0/preview/scim/v2/ServicePrincipals/654321 HTTP/1.1
Host: <databricks-instance>
Authorization: Bearer dapi48…a6138b
Content-Type: application/scim+json
{
  "schemas":[
    "urn:ietf:params:scim:schemas:core:2.0:ServicePrincipal"
  ],
  "applicationId":"b4647a57-063a-43e3-a6b4-c9a4e9f9f0b7",
  "displayName":"test-service-principal",
  "groups":[
    {
       "value":"123456"
    }
  ],
  "entitlements":[
    {
       "value":"allow-cluster-create"
    }
  ]
}

Ta bort alla rättigheter och grupper

Att ta bort alla rättigheter och grupper är ett omvändbart alternativ till att inaktivera tjänstens huvudnamn.

Använd metoden PUT för att undvika att behöva kontrollera befintliga rättigheter och gruppmedlemskap först.

PUT /api/2.0/preview/scim/v2/ServicePrincipals/654321 HTTP/1.1
Host: <databricks-instance>
Authorization: Bearer dapi48…a6138b
Content-Type: application/scim+json
{
  "schemas":[
    "urn:ietf:params:scim:schemas:core:2.0:ServicePrincipal"
  ],
  "applicationId":"b4647a57-063a-43e3-a6b4-c9a4e9f9f0b7",
  "displayName":"test-service-principal",
  "groups":[],
  "entitlements":[]
}

Inaktivera tjänstens huvudnamn efter ID

Slutpunkt HTTP-metod
2.0/preview/scim/v2/ServicePrincipals/{id} DELETE

Inaktivera en resurs för tjänstens huvudnamn. Den här åtgärden kan inte ångras.

DELETE /api/2.0/preview/scim/v2/ServicePrincipals/654321  HTTP/1.1
Host: <databricks-instance>
Accept: application/scim+json
Authorization: Bearer dapi48…a6138b

Som ett omvändbart alternativ kan du ta bort alla dess rättigheter och grupper i stället för att ta bort tjänstens huvudnamn.

Ett huvudnamn för tjänsten som inte äger eller tillhör en Azure Databricks tas bort automatiskt efter 30 dagar.