Select Primary Face Sample

PUT /api/v1/face-identities/{identityId}/samples/{sampleId}/primary

Access

Authentication options declared in the contract include user cookie session or bearer service token.

The shared authentication policy requires identities:manage. Resource access also depends on the caller’s role, organization, camera grants, and the operation’s validation.

User-session writes require recent authentication.

Authentication and permissions explains tokens, cookies, CSRF, and workspace context.

Parameters

Name	Location	Required	Type	Description and constraints
identityId	path	Yes	string (uuid)
sampleId	path	Yes	string (uuid)
If-Match	header	Yes	integer	minimum 1
X-EyesOnIt-Session-Id	header	No	string (uuid)	The sessionId the caller expects. Required when switching workspaces and for cookie requests after workspace rotation. A mismatched value returns 409 with X-EyesOnIt-Workspace-Changed: 1. Bootstrap with getCurrentPrincipal; never replay a mutation automatically after changing context. Bearer clients do not use this header.
X-CSRF-Token	header	No	string	Required for unsafe requests authenticated by CookieSession; ignored for bearer clients. minimum length 32. maximum length 256

cURL request template

Set the connection variables described in Get started. Replace each additional EOI_… variable with the parameter value for this request. This template sends the request when run.

curl --fail-with-body --silent --show-error \
  --request PUT \
  --header "Authorization: Bearer ${EOI_SERVICE_TOKEN}" \
  --header "If-Match: ${EOI_IF_MATCH}" \
  "${EOI_API_BASE_URL}/face-identities/${EOI_IDENTITYID}/samples/${EOI_SAMPLEID}/primary"

Contract responses

The table records responses declared by the OpenAPI contract. See Errors and status codes for the runtime error envelope and shared failures.

Status	Description	Media type	Body
200	Successful Response	application/json	FaceIdentityResponse
422	Validation Error	application/json	HTTPValidationError

Operation identifier selectPrimaryFaceSample. Browse Identities and samples.