Items - Associate Identity (beta)

Служба:

Core

Версия API:

v1

Связывает удостоверение по умолчанию с элементом.

Замечание

Этот API является частью бета-версии и предоставляется только для оценки и разработки. Он может изменяться на основе отзывов и не рекомендуется для производственного использования. При вызове этого API вызывающие серверы должны указать true значение параметра betaзапроса.

Этот API поддерживает длительные операции (LRO).

Этот API поддерживается для ряда типов элементов, найдите поддерживаемые типы элементов и сведения о структуре их определения в обзоре управления элементами.

Разрешения

Вызывающий объект должен иметь разрешения на чтение и запись для элемента.

Обязательные делегированные области доступа

Для API элементов используются следующие типы областей:

• Универсальная область: Item.ReadWrite.All
• Конкретная область: itemType. ReadWrite.All (например: Notebook.ReadWrite.All)

Дополнительные сведения о областях см. в статье области.

поддерживаемые удостоверения Microsoft Entra

Этот API поддерживает Майкрософт identities, перечисленных в этом разделе.

Идентичность	Поддержка
User	Да
Представитель службы и управляемые удостоверения	Если тип элемента в вызове поддерживается. Проверьте соответствующий API для вызываемого типа элемента, чтобы узнать, поддерживается ли ваш вызов.

Интерфейс

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
itemId	path	True	string (uuid)	Идентификатор элемента.
workspaceId	path	True	string (uuid)	Идентификатор рабочей области.
beta	query	True	boolean	Этот обязательный параметр должен быть установлен для true доступа к этому API, который в настоящее время находится в бета-версии.

Текст запроса

Имя	Обязательно	Тип	Описание
assignmentType	True	IdentityAssignmentEntityType	Тип субъекта, который делает запрос удостоверения associaste.

Ответы

Имя	Тип	Описание
200 OK	UpdateItemIdentityResponse	Запрос успешно завершен.
202 Accepted		Запрос принят, сопоставление удостоверений выполняется. Заголовки Location: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий Retry-After в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов. Заголовки Retry-After: integer
Other Status Codes	ErrorResponse	Распространенные коды ошибок: ItemNotFound — запрошенный элемент не найден. InvalidRequest — недопустимый запрос на связь.

Примеры

Associate identity example

Образец запроса

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

Пример ответа

Код состояния:

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

Код состояния:

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

Определения

Имя	Описание
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
IdentityAssignmentEntityType	Тип субъекта, который делает запрос удостоверения associaste.
IdentityAssignmentStatusType	Состояние назначения удостоверения. С течением времени можно добавить дополнительное состояние.
ItemAssignmentStatus	Состояние назначения удостоверения элементу.
UpdateItemIdentityRequest	Связывание полезных данных запроса удостоверения.
UpdateItemIdentityResponse	Связывание ответа удостоверения.

ErrorRelatedResource

Объект

Объект сведений об ошибках, связанных с ресурсом.

Имя	Тип	Описание
resourceId	string	Идентификатор ресурса, участвующий в ошибке.
resourceType	string	Тип ресурса, который участвует в ошибке.

ErrorResponse

Объект

Ответ на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
moreDetails	ErrorResponseDetails[]	Список дополнительных сведений об ошибке.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.
requestId	string (uuid)	Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Объект

Сведения об ответе на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.

IdentityAssignmentEntityType

Перечисление

Тип субъекта, который делает запрос удостоверения associaste.

Значение	Описание
Caller	Пользователь или субъект-служба, который делает запрос на удостоверение связи.

IdentityAssignmentStatusType

Перечисление

Состояние назначения удостоверения. С течением времени можно добавить дополнительное состояние.

Значение	Описание
Succeeded	Удостоверение успешно назначено элементу.
Failed	Сбой назначения удостоверения.

ItemAssignmentStatus

Объект

Состояние назначения удостоверения элементу.

Имя	Тип	Описание
errorInfo	ErrorResponseDetails	Сведения об ошибке, если назначение удостоверения завершилось ошибкой.
itemId	string (uuid)	Идентификатор элемента.
parentItemId	string (uuid)	Идентификатор родительского элемента.
status	IdentityAssignmentStatusType	Состояние назначения удостоверения. С течением времени можно добавить дополнительное состояние.

UpdateItemIdentityRequest

Объект

Связывание полезных данных запроса удостоверения.

Имя	Тип	Описание
assignmentType	IdentityAssignmentEntityType	Тип субъекта, который делает запрос удостоверения associaste.

UpdateItemIdentityResponse

Объект

Связывание ответа удостоверения.

Имя	Тип	Описание
assignmentStatus	ItemAssignmentStatus[]	Удостоверение, назначенное элементу после обновления.