GoodMemGoodMem
ReferenceSdkRustTypes

CompleteUserEnrollmentRequest

Rust struct goodmem::models::CompleteUserEnrollmentRequest: declaration, fields or variants, and implementations.

All types

Struct CompleteUserEnrollmentRequest

goodmem::models::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.

pub struct CompleteUserEnrollmentRequest {
    pub enrollment_token: String,
    pub api_key_id: Option<String>,
    pub raw_api_key: Option<String>,
}

Fields

enrollment_token

pub enrollment_token: String

Required one-time enrollment credential. Never log or persist it. Wire name: enrollmentToken.

api_key_id

pub api_key_id: Option<String>

Optional client-generated API-key UUID retained for exact retries. Must be supplied together with rawApiKey, or both fields must be omitted. Wire name: apiKeyId.

raw_api_key

pub raw_api_key: Option<String>

Optional canonical client-generated API key. Must be supplied together with apiKeyId, never logged, and retained for exact retries; omit both fields for server generation. Wire name: rawApiKey.

Implementations

validate

pub fn validate(&self) -> crate::Result<()>

Validate the request before sending, without making an HTTP call.

Trait implementations

  • Clone (derived)
  • Default (derived)
  • PartialEq (derived)
  • Serialize (derived)
  • impl<'de> Deserialize<'de> for CompleteUserEnrollmentRequest
  • impl std::fmt::Debug for CompleteUserEnrollmentRequest

On this page