Saltar al contenido

Update an access review item

Módulo Settings

PATCH/access-review-items/{id}accessReviewItems.update

One membership role to confirm or remove. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

  • Requiere la capacidad org.access_reviews.manage.
  • Alcances de OAuth: org.
  • Envía If-Match con el ETag que leíste. Una etiqueta desactualizada devuelve 412; si falta, devuelve 428.
  • Estados de error: 400, 401, 404, 412, 422, 428, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

accessReviewItems.update: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the access review item.

Cuerpo de la solicitud: AccessReviewItemUpdate

accessReviewItems.update: AccessReviewItemUpdate
CampoTipoObligatorioDescripción
decision"Confirmed" | "Removed" | nullNoConfirmed keeps the role; Removed ends it at once. Null while unreviewed; final once set.
{
  "decision": "Confirmed"
}

Respuesta 200: AccessReviewItem

accessReviewItems.update: AccessReviewItem
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the access review item.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
access_review_campaign_idstring (uuid)SíIdentifier of the campaign.
membership_role_idstring (uuid)SíIdentifier of the membership role.
decision"Confirmed" | "Removed" | nullSíConfirmed keeps the role; Removed ends it at once. Null while unreviewed; final once set.
decided_bystring (uuid) | nullSíIdentifier of the reviewer; null for an automatic removal.
decided_atstring (date-time) | nullSíWhen the decision was recorded.
flagged_atstring (date-time) | nullSíWhen the item was flagged as unreviewed after the grace period.
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "access_review_campaign_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "membership_role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "decision": "Confirmed",
  "decided_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "decided_at": "2026-10-08T14:30:00Z",
  "flagged_at": "2026-10-08T14:30:00Z"
}

Ejemplos de código

curl -X PATCH "$XOS_BASE_URL/access-review-items/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"decision":"Confirmed"}'
const { data, etag } = await xos.accessReviewItems.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "decision": "Confirmed"
  }, { ifMatch: etag });
response = xos.access_review_items.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"decision": "Confirmed"}, if_match=etag)
xos access-review-items update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"decision":"Confirmed"}' --if-match auto