GoodMemGoodMem
ReferenceClient SDKsRust

UserEnrollments

Rust user_enrollments API reference: typed methods, request options, return values, and resource models.

goodmem::api::UserEnrollments

Access this service with client.user_enrollments().

pub struct UserEnrollments<'a> {
    /* private fields */
}

Methods

MethodHTTPPath
completePOST/v1/user-enrollments:complete

Errors and cancellation

Calls return Result<T>. See Error for validation, HTTP, transport, decoding, and timeout failures. Stream items can also return errors after the call succeeds.

Pagination helpers fetch pages when polled. Drop a page or event stream to cancel further work.

Implementations

impl UserEnrollments<'_>

complete

pub async fn complete( &self, body: &CompleteUserEnrollmentRequest, ) -> Result<CompleteUserEnrollmentResponse>

Complete human-user enrollment

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.

Errors include local validation, HTTP failures, and malformed responses.

HTTP: POST /v1/user-enrollments:complete

Types

Trait implementations

  • Clone (derived)
  • Copy (derived)
  • Debug (derived)

On this page