Aura.Model.HexAPIKey (Aura v0.9.0)
View SourceA struct describing an API key record coming from a Hex-compliant API.
Summary
Types
A human-readable name for this API key (e.g "my_computer"
)
A permission realm that this API key has.
❓ Sorry, documentation from the hex specification is lacking here. ❓
UTC DateTime
when this key became invalid
The API key payload - it is only provided once, upon creation; always nil
after
Type describing an API key coming from a Hex-compliant API.
Types
@type api_key_name() :: String.t()
A human-readable name for this API key (e.g "my_computer"
)
A permission realm that this API key has.
🏷️ Keys
- domain :: A domain for which this API key is valid
- (e.g
"api"
,"repository"
,"repositories"
,"package"
)
- (e.g
- resource :: What kind of operations this API key can do within its domain
- (e.g
"read"
,"write"
)
- (e.g
@type authing_key() :: boolean()
❓ Sorry, documentation from the hex specification is lacking here. ❓
@type revoked_date_time() :: DateTime.t() | nil
UTC DateTime
when this key became invalid
@type secret() :: String.t() | nil
The API key payload - it is only provided once, upon creation; always nil
after
@type t() :: %Aura.Model.HexAPIKey{ authing_key: authing_key(), inserted_at: Aura.Model.Common.inserted_at(), name: api_key_name(), permissions: [api_permission()], revoked_at: revoked_date_time(), secret: secret(), updated_at: Aura.Model.Common.updated_at(), url: Aura.Model.Common.url() }
Type describing an API key coming from a Hex-compliant API.
🏷️ Keys
- authing_key ::
authing_key/0
- secret ::
secret/0
- inserted_at ::
Aura.Model.Common.inserted_at/0
- name ::
api_key_name/0
- permissions :: [
api_permission/0
] - revoked_date_time ::
revoked_date_time/0
- updated_at ::
Aura.Model.Common.updated_at/0
- url ::
Aura.Model.Common.url/0