Saltar al contenido principal

Endpoint

POST /v1/analyses/{profileId}/analyze

Request

curl -X POST "http://client-omni-api.argosidentity.com/v1/analyses/{profileId}/analyze" \
  -H "x-api-key: su-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "targetItems": [
      { "itemId": "item_abc123" },
      { "itemId": "item_def456" }
    ]
  }'

Request Body

targetItems
array
requerido
Lista de items que se incluirán en el análisis
targetItems[].itemId
string
requerido
Item ID (item_). Debe pertenecer al profile y estar en ACTIVE

Response

{
  "id": "analysis_xyz789"
}
id
string
requerido
Analysis ID único (analysis_)

Notas importantes

El análisis se ejecuta asíncronamente. Use GET /analyses/:analysisId para consultar estado y resultados.
Se conservan como máximo 5 analyses por profile. Si se supera este límite, el más antiguo se elimina automáticamente.
  • Todos los target items deben estar en estado ACTIVE. Los items en otros estados serán rechazados.
  • Solo puede ejecutarse un análisis a la vez por profile. Intentar iniciar un segundo análisis mientras hay uno en progreso devolverá un error 409.

Códigos de error

StatusCodeDescripción
400INVALID_ITEM_IDSUno o más items no existen o no pertenecen al profile especificado
404PROFILE_NOT_FOUNDEl profile especificado no fue encontrado
409ANALYSIS_IN_PROGRESSYa hay un análisis en ejecución para este profile