v1

latestSwagger 2.02026-07-134026156.7 KB
Data Requests

Update a submission data request

Updates authentication details for a data request. Use this when a user logs in to record their authentication method, provider, session information, and hashed identifiers. Updates metadata and tracks authentication state changes for auditing and compliance.

put/data_requests/{data_request_id}

Path parameters

data_request_idstring required

Request body

auth_phone_number_hashstring nullable
auth_providerstring nullable
auth_second_factor_type'none' | 'phone_number' | 'totp' | 'mobile_push' | 'security_key' | 'fingerprint' | '' nullable
auth_session_id_hashstring nullable
auth_session_started_atstring nullable
auth_type'none' | 'password' | 'oauth' | 'email_link' | 'phone_number' | 'ldap' | 'saml'
auth_user_id_hashstring nullable
auth_username_hashstring nullable
emailstring nullable
fieldsstring[]
metadataobject
namestring nullable
orderinteger

Example request

{
  "metadata": {
    "user_id": 123
  },
  "auth_type": "oauth",
  "auth_provider": "google",
  "auth_session_started_at": "2018-10-23 09:00:00 -0400",
  "auth_session_id_hash": "8d969eef6ecad3c29a3a629280e686cf0c3f5d5a86aff3ca12020c923adc6c92"
}

Response

submission data request updated

status'success' | 'error' required
errorsstring[]