User Enrollments

One-time human-user enrollment completion.

Namespace: Goodmem.Client.Api · Class: UserEnrollmentsApi

Reach this surface as client.UserEnrollments on a GoodmemClient. Every network method is asynchronous — it returns a Task<T> (or an IAsyncEnumerable<T> for pagination and streaming) and accepts a CancellationToken; the Async suffix marks the standard .NET Task-based async pattern.

Methods

CompleteAsync

Exchanges a one-time enrollment credential for the human's initial self-owned API key. This endpoint does not use ordinary API-key authentication. Omit both optional key fields for server generation; a fresh response discloses the raw key exactly once and cannot be safely retried after an ambiguous outcome. Supply and retain both fields for client mode, where only an exact tuple retry is safe and raw material is never echoed. Status precedence is request-shape errors (400), then the same generic authentication failure for every nonblank unusable enrollment (401); key conflicts or concurrent lifecycle winners return 409, rate limits return 429, and unexpected failures return 500.

Declaration

public Task<CompleteUserEnrollmentResponse> CompleteAsync(CompleteUserEnrollmentRequest request, CancellationToken ct = default)

HTTP — POST /v1/user-enrollments:complete

Parameters

Returns

Task<CompleteUserEnrollmentResponse> — an awaitable that resolves to CompleteUserEnrollmentResponse.

Exceptions

Example

var completedEnrollment = await client.UserEnrollments.CompleteAsync(
    new CompleteUserEnrollmentRequest { EnrollmentToken = "gme_..." }
);
// Server-generated raw API keys are disclosed only on fresh completion.
Console.WriteLine(completedEnrollment.RawApiKey);

Data Models

Types in the Goodmem.Client.Models namespace. Each row lists the C# property, its type, the JSON wire name, and a description.

CompleteUserEnrollmentRequest

Exchanges one enrollment credential for the target human's initial API key. Omit both apiKeyId and rawApiKey for server-generated key material, or supply both for exact-retry-safe client-generated completion; supplying only one is invalid.

CompleteUserEnrollmentResponse

Initial API-key metadata, exact-retry classification, and one-time raw key material only for a fresh server-generated completion. Client-supplied keys are never echoed.