Get a human-user enrollment
GET /v1/users/{userId}/enrollments/{enrollmentId}: Returns non-secret metadata for one current or historical enrollment.
Returns non-secret metadata for one current or historical enrollment. The target user is resolved before the enrollment, and MANAGE_USER_ENROLLMENT with ANY or EXACT authority on that user is required. Raw enrollment tokens are never returned.
ApiKeyAuthx-api-key<token>userId*stringHuman-user UUID
enrollmentId*stringEnrollment UUID
GoodMem-Timeout-Ms?integerOptional waiting budget in milliseconds, measured from REST servlet ingress and shared across all internal gRPC calls. Supply one decimal integer from 1 to 86400000. Omission adds no deadline. Existing shorter deadlines still apply. Expiry returns HTTP 504 before streaming starts; after streaming starts, no successful completion event is sent. Use SSE or opt into GoodMem-Stream-Terminal for an explicit terminal outcome. Retrieval work is cooperatively cancelled. An accepted mutation may still commit after timeout or disconnect; a failed response does not imply rollback.
int641 <= value <= 86400000Enrollment metadata returned
application/json- response
Non-secret lifecycle metadata for a human user's one-time enrollment credential.
enrollmentId*stringOUTPUT_ONLY; immutable enrollment UUID.
uuid"0198b9f4-c42f-7ae3-8c56-44d827ea03bd"userId*stringOUTPUT_ONLY; UUID of the human user invited to enroll.
uuid"70e025f6-76ca-4cbe-b8fc-7dab8e84590a"credentialPrefix*stringOUTPUT_ONLY; non-secret prefix that identifies the enrollment credential safely.
^gme_[a-z2-7]{6}$10 <= length <= 10"gme_mzxw6y"status*stringOUTPUT_ONLY; current derived enrollment lifecycle state.
"PENDING""PENDING""EXPIRED""CONSUMED""REVOKED"expiresAt*integerOUTPUT_ONLY; exclusive completion deadline in milliseconds since epoch.
int641786752000000consumedApiKeyId?|OUTPUT_ONLY; initial API-key UUID, present after consumption.
uuid"550e8400-e29b-41d4-a716-446655440000"createdAt*integerOUTPUT_ONLY; enrollment issuance time in milliseconds since epoch.
int641786665600000consumedAt?|OUTPUT_ONLY; first-completion time, absent before consumption.
int641786669200000revokedAt?|OUTPUT_ONLY; permanent revocation time, absent while unrevoked.
int641786669200000createdById*stringOUTPUT_ONLY; exact principal or API-key actor that issued the enrollment.
uuid"b3303d0a-1a4a-493f-b9bf-38e37153b5a2"revokedById?|OUTPUT_ONLY; exact revoking actor UUID, absent while unrevoked.
uuid"b3303d0a-1a4a-493f-b9bf-38e37153b5a2"curl -X GET 'https://your-goodmem-server.example.com/v1/users/70e025f6-76ca-4cbe-b8fc-7dab8e84590a/enrollments/0198b9f4-c42f-7ae3-8c56-44d827ea03bd' \ -H 'GoodMem-Timeout-Ms: 30000'{ "enrollmentId": "0198b9f4-c42f-7ae3-8c56-44d827ea03bd", "userId": "70e025f6-76ca-4cbe-b8fc-7dab8e84590a", "credentialPrefix": "gme_mzxw6y", "status": "PENDING", "expiresAt": 1786752000000, "consumedApiKeyId": "550e8400-e29b-41d4-a716-446655440000", "createdAt": 1786665600000, "consumedAt": 1786669200000, "revokedAt": 1786669200000, "createdById": "b3303d0a-1a4a-493f-b9bf-38e37153b5a2", "revokedById": "b3303d0a-1a4a-493f-b9bf-38e37153b5a2"}Get user by username
GET /v1/users/username/{username}: Returns a user selected by exact username after applying READ_USER authority.
List a human user's enrollments
GET /v1/users/{userId}/enrollments: Returns one newest-first page containing pending, expired, consumed, and revoked enrollment metadata.