Tentacat v0.2.1 → Overview → Tentacat → Users → Keys

Tentacat.Users.Keys

Summary

create(title, key, client)

Create a public key on the authorized user
find(id, client)

Get a single public key of the authorized user
list(user, client \\ %Tentacat.Client{})

List public keys for a user
list_mine(client)

List public keys for the authenticated user
remove(id, client)

Delete a public from the authorized user
update(id, title, key, client)

Update a public key from the authorized user

Functions

create(title, key, client)
(function) # ↑

Specs:

Create a public key on the authorized user

Example

Tentacat.Users.Keys.create("title", "ssh-rsa AAA...", client)

More info at:http://developer.github.com/v3/users/keys/#create-a-public-key

find(id, client)
(function) # ↑

Specs:

Get a single public key of the authorized user

Example

Tentacat.Users.Keys.find 1, client

More info at: http://developer.github.com/v3/users/keys/#get-a-single-public-key

list(user, client \\ %Tentacat.Client{})
(function) # ↑

Specs:

List public keys for a user

Example

Tentacat.Users.Keys.list "bastos", client
Tentacat.Users.Keys.list "bastos"

More info at: http://developer.github.com/v3/users/keys/#list-public-keys-for-a-user and http://developer.github.com/v3/users/keys/#list-your-public-keys

list_mine(client)
(function) # ↑

Specs:

List public keys for the authenticated user

Example

Tentacat.Users.Keys.list_mine client

More info at: http://developer.github.com/v3/users/keys/#list-public-keys-for-a-user and http://developer.github.com/v3/users/keys/#list-your-public-keys

remove(id, client)
(function) # ↑

Specs:

Delete a public from the authorized user

Example

Tentacat.Users.Keys.remove 123, client

More info at: http://developer.github.com/v3/users/keys/#delete-a-public-key

update(id, title, key, client)
(function) # ↑

Specs:

Update a public key from the authorized user

Example

Tentacat.Users.Keys.update(123, "title", "ssh-rsa ...", client)

More info at: http://developer.github.com/v3/users/keys/#update-a-public-key