Support API

Use these endpoints from backend/support services to manage a specific user by KRN.

Authentication

Required headers:

• Authorization: Bearer <s2s-token>

• X-Consumer-Id: <consumer-id>

Base URL and common headers

• Base URL: See Base Domains

• Header: Content-Type: application/json (for JSON request bodies)

Endpoint overview

Method	Path	Purpose
GET	/idp/support/users/{user_id}	Read support-level user details and enrollments
PATCH	/idp/support/users/{user_id}	Update user profile data
DELETE	/idp/support/users/{user_id}	Delete and unenroll a user
POST	/idp/support/users/{user_id}/enroll	Enroll user based on SRTs
POST	/idp/support/users/{user_id}/enrollment-sync	Trigger best-effort enrollment synchronization

Endpoint Reference

GET /idp/support/users/{user_id}

• Description: get support-level user details and enrollment status

• Authentication: server-to-server token + X-Consumer-Id

• Request body: none

Path parameter:

• user_id (string): user KRN

Responses on success:

• 200 OK

{
  "array_user_details": {
    "arrayUserId": "45ac7b00-46ab-4b89-bc72-4617b2c55340",
    "authAttempts": 0,
    "authenticated": false,
    "lastAuthAttempt": null,
    "phoneNumberConfigured": false,
    "remainingAuthAttempts": 3,
    "ssnConfigured": false,
    "twoFactorEnabled": true
  },
  "enrollments": [
    {
      "active": true,
      "enrollmentCode": "exp1bStandardMonitoring",
      "enrollmentDate": "2024-11-26T15:44:16.731Z",
      "cancellationDate": "0001-01-01T00:00:00Z"
    }
  ],
  "user_status_response": {
    "kape_user_id": "krn::iam::xvpn:user:515296f8-75d8-415e-b9f1-093a4a0c238f"
  }
}

---

PATCH /idp/support/users/{user_id}

• Description: update user profile data

• Authentication: server-to-server token + X-Consumer-Id

Path parameter:

• user_id (string): user KRN

Request body:

Field	Type	Required	Notes
ssn	string	yes	support schema requires it
emailAddress	string	no
phoneNumber	string	no	digits only
dob	string	no	YYYY-MM-DD
address	object	no	street, city, state, zip

Example request:

{
  "ssn": "123456789",
  "phoneNumber": "2125550123",
  "address": {
    "street": "123 Main St",
    "city": "New York",
    "state": "NY",
    "zip": "10001"
  }
}

Responses on success:

• 200 OK

---

DELETE /idp/support/users/{user_id}

• Description: delete and unenroll user

• Authentication: server-to-server token + X-Consumer-Id

• Request body: none

Path parameter:

• user_id (string): user KRN

Responses on success:

• 200 OK

• Same response shape as GET /idp/support/users/{user_id}

---

POST /idp/support/users/{user_id}/enroll

• Description: enroll a user based on subscription receipt tokens

• Authentication: server-to-server token + X-Consumer-Id

Path parameter:

• user_id (string): user KRN

Request body:

{
  "srts": ["<subscription-receipt-token-1>", "<subscription-receipt-token-2>"]
}

Responses on success:

• 200 OK

---

POST /idp/support/users/{user_id}/enrollment-sync

• Description: trigger best-effort enrollment synchronization

• Authentication: server-to-server token + X-Consumer-Id

• Request body: none

Path parameter:

• user_id (string): user KRN

Optional query parameter:

• version (integer): 0 or 1

Responses on success:

• 200 OK

{
  "message": "OK"
}