Sendio.ApiKeys (sendio v1.1.0)
Manage API keys in Sendio.
Summary
Functions
Creates a new API key.
Lists all API keys.
Removes an API key. Caution: This can't be undone!
Functions
Link to this function
create(client \\ Sendio.client(), opts)
@spec create(Sendio.Client.t(), Keyword.t()) :: Sendio.Client.response(Sendio.ApiKeys.ApiKey.t())
Creates a new API key.
Parameter options:
:name- The API key name (required):permission- Access scope to assign to this key, one of:["full_access", "sending_access"]:domain_id- Restrict sending to a specific domain. Only used when permission is set to"sending_access"
The :token field in the response struct is the only time you will see the token, keep it somewhere safe.
Link to this function
list(client \\ Sendio.client())
@spec list(Sendio.Client.t()) :: Sendio.Client.response(Sendio.List.t(Sendio.ApiKeys.ApiKey.t()))
Lists all API keys.
Link to this function
remove(client \\ Sendio.client(), api_key_id)
@spec remove(Sendio.Client.t(), String.t()) :: Sendio.Client.response(Sendio.Empty.t())
Removes an API key. Caution: This can't be undone!