Del via

Få autorisert tilgang for en oppdragsgiver

  • Tjeneste:

    • Kjerne

  • API-versjon:

    • v1

Henter tillatt datatilgang for et gitt prinsipp i henhold til OneLake-sikkerhetsrollene som er konfigurert på elementet. Dette API-et konsoliderer en oppdragsgivers tillatelser på tvers av roller, og gir en «effektiv tilgang»-visning av deres tillatelser.

Bemerkning

Denne API-en er en del av en forhåndsversjon, og er bare tilgjengelig for evaluerings- og utviklingsformål. Det kan endres basert på tilbakemelding og anbefales ikke for produksjonsbruk.

Nødvendige delegerte omfang

OneLake.ReadWrite.All

Microsoft Entra-støttede identiteter

Denne API-en støtter Microsoft -identiteter oppført i denne delen.

Identitet Kundestøtte
Bruker Ja
tjenestekontohaver og administrerte identiteter Ja

Grensesnitt

GET https://onelake.dfs.fabric.microsoft.com/v1.0/workspaces/{workspaceId}/artifacts/{artifactId}/securityPolicy/principalAccess

URI-parametere

Navn I Påkrevd Type Beskrivelse
itemId bane Sann streng (uuid) ID-en til Fabric-elementet for å plassere rollene.

Topptekst for forespørsel

Navn Påkrevd Type Beskrivelse
If-Match streng En ETag-verdi. ETag må angis i anførselstegn. Hvis angitt, vil kallet bare lykkes hvis ressursens ETag samsvarer med den angitte ETag.
Hvis-None-Match streng En ETag-verdi. ETag må angis i anførselstegn. Hvis det er angitt, lykkes samtalen bare hvis ressursens ETag ikke samsvarer med den angitte ETag.

Brødtekst for forespørsel

Navn Type Påkrevd Beskrivelse
aadObjectId streng Ja Entra-objekt-ID-en til brukeren som skal sjekke tilgangen til.
inputPath streng Ja Enten "Tabeller" eller "filer". Svaret vil returnere principalens tilgang til enten tabell- eller filseksjonen i elementet alene, basert på hvilken input som ble spesifisert.
fortsettelseToken streng valgfritt Brukes til å hente fortsatte resultater hvis det opprinnelige settet er mer enn maxResults.
maxResults heltall valgfritt Maksimalt antall elementer per side. Hvis det ikke er spesifisert, er standard 500.

Svar

Navn Type Beskrivelse
200 OK Forespørselen er fullført.

Overskrifter

Etag: tråd
429 For mange forespørsler ErrorResponse Grensen for tjenestesats ble overskredet. Serveren returnerer en Retry-After topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler.

Overskrifter

Retry-After: heltall
Andre statuskoder ErrorResponse Vanlige feilkoder:

- ItemNotFound - Indikerer at serveren ikke kan finne det forespurte elementet.
- PreconditionFailed -Indicates at den nåværende ressursen ETag ikke samsvarer med verdien spesifisert i If-Match-headeren.

Eksempler

Eksempelforespørsel

HTTP

GET https://onelake.dfs.fabric.microsoft.com/v1.0/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/artifacts/25bac802-080d-4f73-8a42-1b406eb1fceb/securityPolicy/principalAccess

{
  "aadObjectId": "CA81C0F4-5C79-4907-BD0A-B4D576AEA59B",
  "inputPath": "Tables",
  "continuationToken": "(token, optional)",
  "maxResults": (optional)
}

Eksempelsvar

  • Statuskode:
    • 200
ETag: 33a64df551425fcc55e4d42a148795d9f25f89d4
{
  "identityETag": "3fc4dc476ded773e4cf43936190bf20fa9480a077b25edc0b4bbe247112542f6",
  "metadataETag": "\"eyJhciI6IlwiMHg4REU3NjQ2MzA2QTIxNjhcIiIsInNjIjoiXCIweDhERTcwQzdBNjlENzk1Q1wiIiwiaXIiOiJcIjB4OERFNjhEREMyNjhBM0U0XCIiLCJkciI6IlwiNWM0YmFhZWIwYTE2MzYxZjkzNThjMzNjMDllYmM2ODJhZjQ1NmIxMDZlNTRmN2E1MzRhNjk5NzA1MjgzMTU5Yy1mODUxMjc0MDBjYjY0YzFkYTA2NjFlZWIyNzg4ZTNhZDc1N2Y3MTZhZWIyYTk0OTA4NGUxOGI2MWUyYWNjNzAxXCIifQ==\"",
  "value": [
    {
      "path": "Tables/dbo/Customers",
      "access": [
        "Read"
      ],
      "rows": "SELECT * FROM [dbo].[Customers] WHERE [customerId] = '123' UNION SELECT * FROM [dbo].[Customers] WHERE [customerID] = 'ALFKI'",
      "effect": "Permit"
    },
    {
      "path": "Tables/dbo/Employees",
      "access": [
        "Read"
      ],
      "rows": "SELECT * FROM [dbo].[Employees] WHERE [address] = '123'",
      "effect": "Permit"
    },
    {
      "path": "Tables/dbo/EmployeeTerritories",
      "access": [
        "Read"
      ],
      "effect": "Permit"
    }
  ]
}

Definisjoner

Navn Beskrivelse
Tilgang Typen tilgangstillatelse som gis. For øyeblikket er Readden eneste støttede tilgangstypen . Flere tilgangstyper kan bli lagt til over tid.
ColumnAccess Representerer en kolonne som hovedpersonen har tilgang til, inkludert effekten og handlingen gitt på den kolonnen.
ColumnAction Handlingen tillot på en søyle. For øyeblikket er Readden eneste støttede handlingen . Flere handlingstyper kan bli lagt til over tid.
ColumnEffect Effekten gjelder for en kolonne. For øyeblikket er Permitden eneste støttede effekten . Flere effekttyper kan bli lagt til over tid.
Effekt Effekten en oppdragsgiver har på tilgangen til datakilden. For øyeblikket er den eneste støttede effekttypen Permit, som gir tilgang til ressursen. Flere effekttyper kan bli lagt til over tid.
FeilRelatertRessurs Objektet for feilrelaterte ressursdetaljer.
ErrorResponse Feilsvaret.
FeilSvarDetaljer Feilsvardetaljene.
PrincipalAccessEntry Representerer den effektive tilgangen en principal har til en spesifikk ressurssti, inkludert tilgangstype, effekt og eventuell rad- eller kolonnefiltrering som er brukt.
PrincipalAccessResponse Responsobjektet som inneholder den effektive tilgangen for en principal på tvers av alle ressurser innenfor den angitte inngangsstien.

Tilgang

Opplisting

Typen tilgangstillatelse som gis. For øyeblikket er Readden eneste støttede tilgangstypen . Flere tilgangstyper kan bli lagt til over tid.

Verdi Beskrivelse
Lese Les tilgang til ressursen.

ColumnAccess

Objekt

Representerer en kolonne som hovedpersonen har tilgang til, inkludert effekten og handlingen gitt på den kolonnen.

Navn Type Beskrivelse
navn streng Det kasussensitive navnet på kolonnen rektoren har tilgang til.
columnEffect ColumnEffect Effekten gjelder for kolonnen. For øyeblikket er Permitden eneste støttede verdien . Flere effekttyper kan bli lagt til over tid.
columnAction ColumnAction[] Omfanget av handlinger tillatt på kolonnen. For øyeblikket er Readden eneste støttede verdien . Flere handlingstyper kan bli lagt til over tid.

ColumnAction

Opplisting

Handlingen tillot på en søyle. For øyeblikket er Readden eneste støttede handlingen . Flere handlingstyper kan bli lagt til over tid.

Verdi Beskrivelse
Lese Les handlingen i spalten.

ColumnEffect

Opplisting

Effekten gjelder for en kolonne. For øyeblikket er Permitden eneste støttede effekten . Flere effekttyper kan bli lagt til over tid.

Verdi Beskrivelse
Tillate Kolonneeffekttypen Permit.

Effekt

Opplisting

Effekten en oppdragsgiver har på tilgangen til datakilden. For øyeblikket er den eneste støttede effekttypen Permit, som gir tilgang til ressursen. Flere effekttyper kan bli lagt til over tid.

Verdi Beskrivelse
Tillate Effekttypen Permit.

FeilRelatertRessurs

Objekt

Objektet for feilrelaterte ressursdetaljer.

Navn Type Beskrivelse
resourceId streng Ressurs-ID-en som er involvert i feilen.
ressurstype streng Typen ressurs som er involvert i feilen.

ErrorResponse

Objekt

Feilsvaret.

Navn Type Beskrivelse
feilkode streng En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
melding streng En menneskelig lesbar representasjon av feilen.
merDetaljer FeilSvarDetaljer[] Liste over flere feildetaljer.
relatertRessurs FeilRelatertRessurs Feilrelaterte ressursdetaljer.
requestId streng (uuid) ID for forespørselen som er knyttet til feilen.

FeilSvarDetaljer

Objekt

Feilsvardetaljene.

Navn Type Beskrivelse
feilkode streng En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
melding streng En menneskelig lesbar representasjon av feilen.
relatertRessurs FeilRelatertRessurs Feilrelaterte ressursdetaljer.

PrincipalAccessEntry

Objekt

Representerer den effektive tilgangen en principal har til en spesifikk ressurssti, inkludert tilgangstype, effekt og eventuell rad- eller kolonnefiltrering som er brukt.

Navn Type Beskrivelse
bane streng Veien til ressursen som principalen har tilgang til, slik som Tables/dbo/Customers.
Adkomst Tilgang[] Arrayet av tilgangstillatelser gitt til hovedpersonen for denne ressursen.
Kolonner ColumnAccess[] Rekken av kolonner rektoren har tilgang til. Hver oppføring spesifiserer kolonnenavn, effekt og tillatte handlinger. Hvis denne egenskapen utelates, gjelder ingen sikkerhet på kolonnenivå og alle kolonner er tillatt.
Rader streng Et T-SQL-uttrykk som representerer sikkerhetsfilteret på radnivå anvendt på prinsippets tilgang. Kun rader som matcher dette predikatet er synlige for prinsippet. Denne egenskapen utelates hvis det ikke gjelder rad-nivå-filtrering.
effekt Effekt Effekten som hovedpersonen har på tilgangen til datakilden. For øyeblikket er den eneste støttede effekttypen Permit, som gir tilgang til ressursen. Flere effekttyper kan bli lagt til over tid.

PrincipalAccessResponse

Objekt

Responsobjektet som inneholder den effektive tilgangen for en principal på tvers av alle ressurser innenfor den angitte inngangsstien.

Navn Type Beskrivelse
identityETag streng En ETag-verdi som representerer den nåværende tilstanden til hovedpersonens identitet og gruppemedlemskap. Endringer når principalens gruppemedlemskap eller identitetsegenskaper oppdateres.
metadataETag streng En ETag-verdi som representerer den nåværende tilstanden til sikkerhetsmetadataene for elementet. Endres når sikkerhetsrollene eller policyene på varen oppdateres.
verdi PrincipalAccessEntry[] Et array av tilgangsoppføringer som representerer den effektive tilgangen principalen har på tvers av ressurser innenfor den angitte inngangsstien.
  • Last updated on