Inttegro.Keys.SecretKeyUsageRequest (inttegro v0.2.0)

Copy Markdown View Source

Parameters for Secret Key Usage Request in the Keys API.

Build this struct with new!/1 and pass it to the corresponding function on Inttegro.Keys. Required keys are enforced immediately; optional values left as nil are omitted from the request sent to Inttegro.

Creates, rotates, inspects, and destroys application secret keys.

A newly generated token is returned once. Store it immediately in a secret manager and never expose it to browser or mobile code. Lookup and usage operations return metadata, not the original token.

Summary

Types

t()

A validated secret key usage request request.

Functions

Builds a Inttegro.Keys.SecretKeyUsageRequest and raises KeyError when a required field is missing.

Types

t()

@type t() :: %Inttegro.Keys.SecretKeyUsageRequest{
  number: integer() | nil,
  page: integer() | nil,
  secret_key_id: String.t(),
  size: integer() | nil
}

A validated secret key usage request request.

Functions

new!(attrs \\ %{})

@spec new!(map() | keyword()) :: t()

Builds a Inttegro.Keys.SecretKeyUsageRequest and raises KeyError when a required field is missing.