Items - Associate Identity (beta)

Tjänst:: Core

API-version:: v1

Associerar standardidentiteten med ett objekt.

Anmärkning

Det här API:et är en del av en betaversion och tillhandahålls endast i utvärderings- och utvecklingssyfte. Den kan ändras baserat på feedback och rekommenderas inte för produktionsanvändning. När du anropar det här API:et måste anropare ange true som värde för frågeparametern beta.

Det här API:et stöder tidskrävande åtgärder (LRO).

Det här API:et stöds för ett antal objekttyper, hittar objekttyper som stöds och information om deras definitionsstruktur i Översikt över objekthantering.

behörigheter

Anroparen måste ha läs- och skrivbehörighet för objektet.

Obligatoriska delegerade omfång

För objekt-API:er använder du följande omfångstyper:

Allmänt omfång: Item.ReadWrite.All
Specifikt omfång: itemType. ReadWrite.All (till exempel: Notebook.ReadWrite.All)

Mer information om omfång finns i artikeln om omfång.

Microsoft Entra identiteter som stöds

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identitet	Support
User	Ja
Tjänsthuvudnamn och hanterade identiteter	När objekttypen i anropet stöds. Kontrollera motsvarande API för den objekttyp som du anropar för att se om ditt anrop stöds.

Gränssnitt

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/identities/default/assign?beta={beta}

URI-parametrar

Name	I	Obligatorisk	Typ	Description
itemId	path	True	string (uuid)	Objekt-ID:t.
workspaceId	path	True	string (uuid)	Arbetsyte-ID.
beta	query	True	boolean	Den här obligatoriska parametern måste anges för att få åtkomst till `true` det här API:et, som för närvarande är i betaversion.

Begärandetext

Name	Obligatorisk	Typ	Description
assignmentType	True	IdentityAssignmentEntityType	Den typ av ämne som gör en associaste-identitetsbegäran.

Svar

Name	Typ	Description
200 OK	UpdateItemIdentityResponse	Begäran har slutförts.
202 Accepted		Begäran accepterad, identitetsassociation pågår. Sidhuvuden Location: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Gränsen för tjänstfrekvens överskreds. Servern returnerar ett `Retry-After` huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas. Sidhuvuden Retry-After: integer
Other Status Codes	ErrorResponse	Vanliga felkoder: ItemNotFound – Det begärda objektet hittades inte. InvalidRequest – Ogiltig associationsbegäran.

Exempel

Associate identity example

Exempelbegäran

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/5b218778-e7a5-4d73-8187-f10824047715/identities/default/assign?beta=True

{
  "assignmentType": "Caller"
}

Exempelsvar

Statuskod:: 200

{
  "assignmentStatus": [
    {
      "itemId": "eab1679a-8cab-40d6-9ba6-5c2a07a7ce81",
      "status": "Succeeded"
    },
    {
      "itemId": "8eedb1b0-3af8-4b17-8e7e-663e61e12211",
      "parentItemId": "eab1679a-8cab-40d6-9ba6-5c2a07a7ce81",
      "status": "Succeeded"
    },
    {
      "itemId": "83b128a3-f58f-4eee-ab0b-e7e25a748f54",
      "parentItemId": "eab1679a-8cab-40d6-9ba6-5c2a07a7ce81",
      "status": "Failed",
      "errorInfo": {
        "errorCode": "AssignmentFailed",
        "message": "The assignment operation failed due to insufficient permissions."
      }
    }
  ]
}

Statuskod:: 202

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Definitioner

Name	Description
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Detaljer om felsvaret.
IdentityAssignmentEntityType	Den typ av ämne som gör en associaste-identitetsbegäran.
IdentityAssignmentStatusType	Status för identitetstilldelningen. Ytterligare status kan läggas till över tid.
ItemAssignmentStatus	Status för en identitetstilldelning till ett objekt.
UpdateItemIdentityRequest	Associera nyttolasten för identitetsbegäran.
UpdateItemIdentityResponse	Associera identitetssvar.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name	Typ	Description
resourceId	string	Resurs-ID:t som är inblandat i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
relatedResource	ErrorRelatedResource	Detaljer om resursen relaterad till felet.
requestId	string (uuid)	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Detaljer om felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
relatedResource	ErrorRelatedResource	Detaljer om resursen relaterad till felet.

IdentityAssignmentEntityType

Uppräkning

Den typ av ämne som gör en associaste-identitetsbegäran.

Värde	Description
Caller	Användaren eller tjänstens huvudnamn som skickar begäran om associerad identitet.

IdentityAssignmentStatusType

Uppräkning

Status för identitetstilldelningen. Ytterligare status kan läggas till över tid.

Värde	Description
Succeeded	Identiteten har tilldelats objektet.
Failed	Identitetstilldelningen misslyckades.

ItemAssignmentStatus

Objekt

Status för en identitetstilldelning till ett objekt.

Name	Typ	Description
errorInfo	ErrorResponseDetails	Felinformationen om identitetstilldelningen misslyckades.
itemId	string (uuid)	Objektets ID.
parentItemId	string (uuid)	ID för det överordnade objektet.
status	IdentityAssignmentStatusType	Status för identitetstilldelningen. Ytterligare status kan läggas till över tid.

UpdateItemIdentityRequest

Objekt

Associera nyttolasten för identitetsbegäran.

Name	Typ	Description
assignmentType	IdentityAssignmentEntityType	Den typ av ämne som gör en associaste-identitetsbegäran.

UpdateItemIdentityResponse

Objekt

Associera identitetssvar.

Name	Typ	Description
assignmentStatus	ItemAssignmentStatus[]	Den identitet som tilldelats objektet efter uppdateringen.