Inttegro.Keys.SecretKey (inttegro v0.2.0)

Represents Secret Key data in the Keys API.

Inttegro decodes API responses into this struct. Required fields are always present; optional fields are nil when they do not apply or were not returned. Follow the linked types in t/0 for nested domain values.

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()

The decoded secret key value.

Functions

new!(attrs \\ %{})

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

Types

t()

@type t() :: %Inttegro.Keys.SecretKey{
  active: boolean(),
  expires_at: String.t() | nil,
  id: String.t(),
  issued_at: String.t(),
  label: String.t() | nil,
  last_used_at: String.t() | nil,
  revoked_at: String.t() | nil,
  status: Inttegro.Keys.SecretKeyStatus.t(),
  token_type: Inttegro.Keys.SecretKeyTokenType.t(),
  updated_at: String.t() | nil,
  usage_count: integer() | nil
}

The decoded secret key value.

Functions

new!(attrs \\ %{})

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

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