Hexoku.API.Account.Keys

Keys represent public SSH keys associated with an account and are used to authorize accounts as they are performing git operations.

Attributes

id
unique identifier of item generated by Heroku
comment
comment on the key
email
deprecated. Please refer to ‘comment’ instead
fingerprint
a unique identifying string based on contents
public_key
full public_key as uploaded
created_at
when item was created
updated_at
when item was last modified

For more info read the Heroku API Reference

Source

Summary

create(client, public_key)

Create a new key

delete(client, key_id_or_fingerprint)

Delete an existing key

info(client, key_id_or_fingerprint)

Info for existing key

list(client)

List existing keys

Functions

create(client, public_key)

Specs:

  • create(Hexoku.Client.t, binary) :: Map.t

Create a new key.

Examples

client |> Hexoku.API.Account.Keys.create("ssh-rsa AAAAB3NzaC1ycVc/../839Uv username@example.com")
Source
delete(client, key_id_or_fingerprint)

Specs:

  • delete(Hexoku.Client.t, binary) :: Map.t

Delete an existing key.

Examples

client |> Hexoku.API.Account.Keys.delete("01234567-89ab-cdef-0123-456789abcdef")
Source
info(client, key_id_or_fingerprint)

Specs:

  • info(Hexoku.Client.t, binary) :: Map.t

Info for existing key.

Examples

client |> Hexoku.API.Account.Keys.info("01234567-89ab-cdef-0123-456789abcdef")
Source
list(client)

Specs:

  • list(Hexoku.Client.t) :: [Map.t]

List existing keys.

Examples

client |> Hexoku.API.Account.Keys.list()
Source