Items - Associate Identity (beta)

Servicio:: Core

Versión de la API:: v1

Asocia la identidad predeterminada a un elemento.

Nota:

Esta API forma parte de una versión beta y solo se proporciona con fines de evaluación y desarrollo. Puede cambiar en función de los comentarios y no se recomienda para su uso en producción. Al llamar a esta API, los autores de llamadas deben especificar true como valor para el parámetro betade consulta .

Esta API admite operaciones de larga duración (LRO).

Esta API se admite para varios tipos de elementos, busque los tipos de elementos admitidos e información sobre su estructura de definición en Información general de administración de elementos.

Permisos

El autor de la llamada debe tener permisos de lectura y escritura para el elemento.

Ámbitos delegados necesarios

Para las API de elementos, use estos tipos de ámbito:

Ámbito genérico: Item.ReadWrite.All
Ámbito específico: itemType. ReadWrite.All (por ejemplo: Notebook.ReadWrite.All)

para obtener más información sobre los ámbitos, vea: artículo ámbitos.

Microsoft Entra identidades admitidas

Esta API admite los Microsoft identities enumerados en esta sección.

Identidad	Apoyo
Usuario	Sí
Entidad de servicio e Identidades administradas	Cuando se admite el tipo de elemento en la llamada. Compruebe la API correspondiente para el tipo de elemento al que llama, para ver si se admite la llamada.

Interfaz

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
itemId	path	True	string (uuid)	Identificador del elemento.
workspaceId	path	True	string (uuid)	El identificador del área de trabajo.
beta	query	True	boolean	Este parámetro necesario debe establecerse en `true` para acceder a esta API, que se encuentra actualmente en versión beta.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
assignmentType	True	IdentityAssignmentEntityType	Tipo de asunto que realiza una solicitud de identidad associaste.

Respuestas

Nombre	Tipo	Description
200 OK	UpdateItemIdentityResponse	Solicitud completada correctamente.
202 Accepted		Solicitud aceptada, la asociación de identidad está en curso. Encabezados Location: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Se superó el límite de frecuencia de servicio. El servidor devuelve un `Retry-After` encabezado que indica, en segundos, cuánto tiempo debe esperar el cliente antes de enviar solicitudes adicionales. Encabezados Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de error comunes: ItemNotFound: no se encontró el elemento solicitado. InvalidRequest: solicitud de asociación no válida.

Ejemplos

Associate identity example

Solicitud de ejemplo

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"
}

Respuesta de muestra

status code:: 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."
      }
    }
  ]
}

status code:: 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

Definiciones

Nombre	Description
ErrorRelatedResource	Objeto de detalles del recurso relacionado con el error.
ErrorResponse	Respuesta de error.
ErrorResponseDetails	Detalles de la respuesta de error.
IdentityAssignmentEntityType	Tipo de asunto que realiza una solicitud de identidad associaste.
IdentityAssignmentStatusType	Estado de la asignación de identidad. Se puede agregar un estado adicional a lo largo del tiempo.
ItemAssignmentStatus	Estado de una asignación de identidad a un elemento.
UpdateItemIdentityRequest	Asociar carga de solicitud de identidad.
UpdateItemIdentityResponse	Asocie la respuesta de identidad.

ErrorRelatedResource

Objeto

Objeto de detalles del recurso relacionado con el error.

Nombre	Tipo	Description
resourceId	string	ID de recurso que está involucrado en el error.
resourceType	string	Tipo del recurso implicado en el error.

ErrorResponse

Objeto

Respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message	string	Representación comprensible para humanos del error.
moreDetails	ErrorResponseDetails[]	Lista de detalles de error adicionales.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.
requestId	string (uuid)	Identificador de la solicitud asociada al error.

ErrorResponseDetails

Objeto

Detalles de la respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message	string	Representación comprensible para humanos del error.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.

IdentityAssignmentEntityType

Enumeración

Tipo de asunto que realiza una solicitud de identidad associaste.

Valor	Description
Caller	Usuario o entidad de servicio que realiza la solicitud de identidad asociada.

IdentityAssignmentStatusType

Enumeración

Estado de la asignación de identidad. Se puede agregar un estado adicional a lo largo del tiempo.

Valor	Description
Succeeded	La identidad se asigna correctamente al elemento.
Failed	Error en la asignación de identidad.

ItemAssignmentStatus

Objeto

Estado de una asignación de identidad a un elemento.

Nombre	Tipo	Description
errorInfo	ErrorResponseDetails	Información de error si se produjo un error en la asignación de identidad.
itemId	string (uuid)	Identificador del elemento.
parentItemId	string (uuid)	Identificador del elemento primario.
status	IdentityAssignmentStatusType	Estado de la asignación de identidad. Se puede agregar un estado adicional a lo largo del tiempo.

UpdateItemIdentityRequest

Objeto

Asociar carga de solicitud de identidad.

Nombre	Tipo	Description
assignmentType	IdentityAssignmentEntityType	Tipo de asunto que realiza una solicitud de identidad associaste.

UpdateItemIdentityResponse

Objeto

Asocie la respuesta de identidad.

Nombre	Tipo	Description
assignmentStatus	ItemAssignmentStatus[]	La identidad asignada al elemento después de la actualización.