LanguageValues and typesStandard typesSecurity
ApiKey
On this page
A key for an API: up to 512 characters with no spaces.
Use it for a key someone sends you or that you send to a service. Keep hash.sha256 of it, not the key. For a token after Bearer, use BearerToken.
Shape
One secret value, with no parts.
Example
ApiKey("example_key_0123456789abcdef")In a real app it arrives from outside, such as in a request, rather than as text you write in your code.
text.parse(raw, as: ApiKey) reads one from text that comes from outside. Text that isn't one at all fails malformed, such as example key or exämple_key.
Good to know
- It is never sent, logged, stored or shown.
==tells you whether two are the same.<andlist.sort_bydon't take it.
In JSON
A string when it arrives, and written redacted when it leaves, in a request, a response or json.write:
"<redacted ApiKey>"Details
Text form, storage, how it is shown, and operations
ApiKey is in the group Security, and has been in Jadpo since 0.1.0.
Text form
text.parse reads one from its text as it is typed. text.from and text.format don't take it, so nothing writes it.
How it is stored
It is never stored.
How it is shown to people
text.format doesn't take it: a ApiKey is never shown.
Operations
It also takes text.parse, json.read, json.write and ==. How every standard type behaves says how they work.
Markdown for agents: /docs/types/type-api-key.md.Built from Jadpo main at aee2e8f.