Noizu.Github.Api.Users (Noizu Labs: Github API v0.5.0)
GitHub users API.
Link to this section Summary
Functions
Add an email address for the authenticated user
Add social accounts for the authenticated user
Block a user
Check if a user is blocked by the authenticated user
Check if a user follows another user
Check if a person is followed by the authenticated user
Create a GPG key for the authenticated user
Create a public SSH key for the authenticated user
Create a SSH signing key for the authenticated user
Delete attestations in bulk
Delete attestations by ID
Delete attestations by subject digest
Delete an email address for the authenticated user
Delete a GPG key for the authenticated user
Delete a public SSH key for the authenticated user
Delete social accounts for the authenticated user
Delete an SSH signing key for the authenticated user
Follow a user
Get the authenticated user
Get a user using their ID
Get a user
Get contextual information for a user
Get a GPG key for the authenticated user
Get a public SSH key for the authenticated user
Get an SSH signing key for the authenticated user
List users
List attestations
List attestations by bulk subject digests
List users blocked by the authenticated user
List email addresses for the authenticated user
List the people the authenticated user follows
List followers of the authenticated user
List followers of a user
List the people a user follows
List GPG keys for the authenticated user
List GPG keys for a user
List public email addresses for the authenticated user
List public keys for a user
List public SSH keys for the authenticated user
List social accounts for the authenticated user
List social accounts for a user
List SSH signing keys for the authenticated user
List SSH signing keys for a user
Set primary email visibility for the authenticated user
Unblock a user
Unfollow a user
Update the authenticated user
Link to this section Functions
add_email_for_authenticated_user(body, options \\ nil)
Add an email address for the authenticated user
@see https://docs.github.com/rest/users/emails#add-an-email-address-for-the-authenticated-user
add_social_account_for_authenticated_user(body, options \\ nil)
Add social accounts for the authenticated user
@see https://docs.github.com/rest/users/social-accounts#add-social-accounts-for-the-authenticated-user
block(username, body, options \\ nil)
Block a user
@see https://docs.github.com/rest/users/blocking#block-a-user
check_blocked(username, options \\ nil)
Check if a user is blocked by the authenticated user
@see https://docs.github.com/rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user
check_following_for_user(username, target_user, options \\ nil)
Check if a user follows another user
@see https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user
check_person_is_followed_by_authenticated(username, options \\ nil)
Check if a person is followed by the authenticated user
@see https://docs.github.com/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user
create_gpg_key_for_authenticated_user(body, options \\ nil)
Create a GPG key for the authenticated user
@see https://docs.github.com/rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user
create_public_ssh_key_for_authenticated_user(body, options \\ nil)
Create a public SSH key for the authenticated user
@see https://docs.github.com/rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user
create_ssh_signing_key_for_authenticated_user(body, options \\ nil)
Create a SSH signing key for the authenticated user
delete_attestations_bulk(username, body, options \\ nil)
Delete attestations in bulk
@see https://docs.github.com/rest/users/attestations#delete-attestations-in-bulk
delete_attestations_by_id(username, attestation_id, options \\ nil)
Delete attestations by ID
@see https://docs.github.com/rest/users/attestations#delete-attestations-by-id
delete_attestations_by_subject_digest(username, subject_digest, options \\ nil)
Delete attestations by subject digest
@see https://docs.github.com/rest/users/attestations#delete-attestations-by-subject-digest
delete_email_for_authenticated_user(body, options \\ nil)
Delete an email address for the authenticated user
@see https://docs.github.com/rest/users/emails#delete-an-email-address-for-the-authenticated-user
delete_gpg_key_for_authenticated_user(gpg_key_id, options \\ nil)
Delete a GPG key for the authenticated user
@see https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user
delete_public_ssh_key_for_authenticated_user(key_id, options \\ nil)
Delete a public SSH key for the authenticated user
@see https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user
delete_social_account_for_authenticated_user(body, options \\ nil)
Delete social accounts for the authenticated user
@see https://docs.github.com/rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user
delete_ssh_signing_key_for_authenticated_user(ssh_signing_key_id, options \\ nil)
Delete an SSH signing key for the authenticated user
follow(username, body, options \\ nil)
Follow a user
@see https://docs.github.com/rest/users/followers#follow-a-user
get_authenticated(options \\ nil)
Get the authenticated user
@see https://docs.github.com/rest/users/users#get-the-authenticated-user
get_by_id(account_id, options \\ nil)
Get a user using their ID
@see https://docs.github.com/rest/users/users#get-a-user-using-their-id
get_by_username(username, options \\ nil)
Get a user
get_context_for_user(username, options \\ nil)
Get contextual information for a user
@see https://docs.github.com/rest/users/users#get-contextual-information-for-a-user
get_gpg_key_for_authenticated_user(gpg_key_id, options \\ nil)
Get a GPG key for the authenticated user
@see https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user
get_public_ssh_key_for_authenticated_user(key_id, options \\ nil)
Get a public SSH key for the authenticated user
@see https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user
get_ssh_signing_key_for_authenticated_user(ssh_signing_key_id, options \\ nil)
Get an SSH signing key for the authenticated user
list(options \\ nil)
List users
list_attestations(username, subject_digest, options \\ nil)
List attestations
@see https://docs.github.com/rest/users/attestations#list-attestations
list_attestations_bulk(username, body, options \\ nil)
List attestations by bulk subject digests
@see https://docs.github.com/rest/users/attestations#list-attestations-by-bulk-subject-digests
list_blocked_by_authenticated_user(options \\ nil)
List users blocked by the authenticated user
@see https://docs.github.com/rest/users/blocking#list-users-blocked-by-the-authenticated-user
list_emails_for_authenticated_user(options \\ nil)
List email addresses for the authenticated user
@see https://docs.github.com/rest/users/emails#list-email-addresses-for-the-authenticated-user
list_followed_by_authenticated_user(options \\ nil)
List the people the authenticated user follows
@see https://docs.github.com/rest/users/followers#list-the-people-the-authenticated-user-follows
list_followers_for_authenticated_user(options \\ nil)
List followers of the authenticated user
@see https://docs.github.com/rest/users/followers#list-followers-of-the-authenticated-user
list_followers_for_user(username, options \\ nil)
List followers of a user
@see https://docs.github.com/rest/users/followers#list-followers-of-a-user
list_following_for_user(username, options \\ nil)
List the people a user follows
@see https://docs.github.com/rest/users/followers#list-the-people-a-user-follows
list_gpg_keys_for_authenticated_user(options \\ nil)
List GPG keys for the authenticated user
@see https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user
list_gpg_keys_for_user(username, options \\ nil)
List GPG keys for a user
@see https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user
list_public_emails_for_authenticated_user(options \\ nil)
List public email addresses for the authenticated user
@see https://docs.github.com/rest/users/emails#list-public-email-addresses-for-the-authenticated-user
list_public_keys_for_user(username, options \\ nil)
List public keys for a user
@see https://docs.github.com/rest/users/keys#list-public-keys-for-a-user
list_public_ssh_keys_for_authenticated_user(options \\ nil)
List public SSH keys for the authenticated user
@see https://docs.github.com/rest/users/keys#list-public-ssh-keys-for-the-authenticated-user
list_social_accounts_for_authenticated_user(options \\ nil)
List social accounts for the authenticated user
@see https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-the-authenticated-user
list_social_accounts_for_user(username, options \\ nil)
List social accounts for a user
@see https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user
list_ssh_signing_keys_for_authenticated_user(options \\ nil)
List SSH signing keys for the authenticated user
@see https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user
list_ssh_signing_keys_for_user(username, options \\ nil)
List SSH signing keys for a user
@see https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user
set_primary_email_visibility_for_authenticated_user(body, options \\ nil)
Set primary email visibility for the authenticated user
@see https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user
unblock(username, options \\ nil)
Unblock a user
@see https://docs.github.com/rest/users/blocking#unblock-a-user
unfollow(username, options \\ nil)
Unfollow a user
@see https://docs.github.com/rest/users/followers#unfollow-a-user
update_authenticated(body, options \\ nil)
Update the authenticated user
@see https://docs.github.com/rest/users/users#update-the-authenticated-user