Module users_api

Source

Enums§

UsersSlashAddEmailForAuthenticatedUserError
struct for typed errors of method users_slash_add_email_for_authenticated_user
UsersSlashAddSocialAccountForAuthenticatedUserError
struct for typed errors of method users_slash_add_social_account_for_authenticated_user
UsersSlashBlockError
struct for typed errors of method users_slash_block
UsersSlashCheckBlockedError
struct for typed errors of method users_slash_check_blocked
UsersSlashCheckFollowingForUserError
struct for typed errors of method users_slash_check_following_for_user
UsersSlashCheckPersonIsFollowedByAuthenticatedError
struct for typed errors of method users_slash_check_person_is_followed_by_authenticated
UsersSlashCreateGpgKeyForAuthenticatedUserError
struct for typed errors of method users_slash_create_gpg_key_for_authenticated_user
UsersSlashCreatePublicSshKeyForAuthenticatedUserError
struct for typed errors of method users_slash_create_public_ssh_key_for_authenticated_user
UsersSlashCreateSshSigningKeyForAuthenticatedUserError
struct for typed errors of method users_slash_create_ssh_signing_key_for_authenticated_user
UsersSlashDeleteEmailForAuthenticatedUserError
struct for typed errors of method users_slash_delete_email_for_authenticated_user
UsersSlashDeleteGpgKeyForAuthenticatedUserError
struct for typed errors of method users_slash_delete_gpg_key_for_authenticated_user
UsersSlashDeletePublicSshKeyForAuthenticatedUserError
struct for typed errors of method users_slash_delete_public_ssh_key_for_authenticated_user
UsersSlashDeleteSocialAccountForAuthenticatedUserError
struct for typed errors of method users_slash_delete_social_account_for_authenticated_user
UsersSlashDeleteSshSigningKeyForAuthenticatedUserError
struct for typed errors of method users_slash_delete_ssh_signing_key_for_authenticated_user
UsersSlashFollowError
struct for typed errors of method users_slash_follow
UsersSlashGetAuthenticatedError
struct for typed errors of method users_slash_get_authenticated
UsersSlashGetByUsernameError
struct for typed errors of method users_slash_get_by_username
UsersSlashGetContextForUserError
struct for typed errors of method users_slash_get_context_for_user
UsersSlashGetGpgKeyForAuthenticatedUserError
struct for typed errors of method users_slash_get_gpg_key_for_authenticated_user
UsersSlashGetPublicSshKeyForAuthenticatedUserError
struct for typed errors of method users_slash_get_public_ssh_key_for_authenticated_user
UsersSlashGetSshSigningKeyForAuthenticatedUserError
struct for typed errors of method users_slash_get_ssh_signing_key_for_authenticated_user
UsersSlashListBlockedByAuthenticatedUserError
struct for typed errors of method users_slash_list_blocked_by_authenticated_user
UsersSlashListEmailsForAuthenticatedUserError
struct for typed errors of method users_slash_list_emails_for_authenticated_user
UsersSlashListError
struct for typed errors of method users_slash_list
UsersSlashListFollowedByAuthenticatedUserError
struct for typed errors of method users_slash_list_followed_by_authenticated_user
UsersSlashListFollowersForAuthenticatedUserError
struct for typed errors of method users_slash_list_followers_for_authenticated_user
UsersSlashListFollowersForUserError
struct for typed errors of method users_slash_list_followers_for_user
UsersSlashListFollowingForUserError
struct for typed errors of method users_slash_list_following_for_user
UsersSlashListGpgKeysForAuthenticatedUserError
struct for typed errors of method users_slash_list_gpg_keys_for_authenticated_user
UsersSlashListGpgKeysForUserError
struct for typed errors of method users_slash_list_gpg_keys_for_user
UsersSlashListPublicEmailsForAuthenticatedUserError
struct for typed errors of method users_slash_list_public_emails_for_authenticated_user
UsersSlashListPublicKeysForUserError
struct for typed errors of method users_slash_list_public_keys_for_user
UsersSlashListPublicSshKeysForAuthenticatedUserError
struct for typed errors of method users_slash_list_public_ssh_keys_for_authenticated_user
UsersSlashListSocialAccountsForAuthenticatedUserError
struct for typed errors of method users_slash_list_social_accounts_for_authenticated_user
UsersSlashListSocialAccountsForUserError
struct for typed errors of method users_slash_list_social_accounts_for_user
UsersSlashListSshSigningKeysForAuthenticatedUserError
struct for typed errors of method users_slash_list_ssh_signing_keys_for_authenticated_user
UsersSlashListSshSigningKeysForUserError
struct for typed errors of method users_slash_list_ssh_signing_keys_for_user
UsersSlashSetPrimaryEmailVisibilityForAuthenticatedUserError
struct for typed errors of method users_slash_set_primary_email_visibility_for_authenticated_user
UsersSlashUnblockError
struct for typed errors of method users_slash_unblock
UsersSlashUnfollowError
struct for typed errors of method users_slash_unfollow
UsersSlashUpdateAuthenticatedError
struct for typed errors of method users_slash_update_authenticated

Functions§

users_slash_add_email_for_authenticated_user
OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.
users_slash_add_social_account_for_authenticated_user
Add one or more social accounts to the authenticated user’s profile. OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.
users_slash_block
Blocks the given user and returns a 204. If the authenticated user cannot block the given user a 422 is returned.
users_slash_check_blocked
Returns a 204 if the given user is blocked by the authenticated user. Returns a 404 if the given user is not blocked by the authenticated user, or if the given user account has been identified as spam by GitHub.
users_slash_check_following_for_user
users_slash_check_person_is_followed_by_authenticated
users_slash_create_gpg_key_for_authenticated_user
Adds a GPG key to the authenticated user’s GitHub account. OAuth app tokens and personal access tokens (classic) need the write:gpg_key scope to use this endpoint.
users_slash_create_public_ssh_key_for_authenticated_user
Adds a public SSH key to the authenticated user’s GitHub account. OAuth app tokens and personal access tokens (classic) need the write:gpg_key scope to use this endpoint.
users_slash_create_ssh_signing_key_for_authenticated_user
Creates an SSH signing key for the authenticated user’s GitHub account. OAuth app tokens and personal access tokens (classic) need the write:ssh_signing_key scope to use this endpoint.
users_slash_delete_email_for_authenticated_user
OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.
users_slash_delete_gpg_key_for_authenticated_user
Removes a GPG key from the authenticated user’s GitHub account. OAuth app tokens and personal access tokens (classic) need the admin:gpg_key scope to use this endpoint.
users_slash_delete_public_ssh_key_for_authenticated_user
Removes a public SSH key from the authenticated user’s GitHub account. OAuth app tokens and personal access tokens (classic) need the admin:public_key scope to use this endpoint.
users_slash_delete_social_account_for_authenticated_user
Deletes one or more social accounts from the authenticated user’s profile. OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.
users_slash_delete_ssh_signing_key_for_authenticated_user
Deletes an SSH signing key from the authenticated user’s GitHub account. OAuth app tokens and personal access tokens (classic) need the admin:ssh_signing_key scope to use this endpoint.
users_slash_follow
Note that you’ll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs." OAuth app tokens and personal access tokens (classic) need the user:follow scope to use this endpoint.
users_slash_get_authenticated
OAuth app tokens and personal access tokens (classic) need the user scope in order for the response to include private profile information.
users_slash_get_by_username
Provides publicly available information about someone with a GitHub account. The email key in the following response is the publicly visible email address from your GitHub profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub. For more information, see Authentication. The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "Emails API".
users_slash_get_context_for_user
Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. The subject_type and subject_id parameters provide context for the person’s hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about octocat who owns the Spoon-Knife repository, you would use a subject_type value of repository and a subject_id value of 1300192 (the ID of the Spoon-Knife repository). OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
users_slash_get_gpg_key_for_authenticated_user
View extended details for a single GPG key. OAuth app tokens and personal access tokens (classic) need the read:gpg_key scope to use this endpoint.
users_slash_get_public_ssh_key_for_authenticated_user
View extended details for a single public SSH key. OAuth app tokens and personal access tokens (classic) need the read:public_key scope to use this endpoint.
users_slash_get_ssh_signing_key_for_authenticated_user
Gets extended details for an SSH signing key. OAuth app tokens and personal access tokens (classic) need the read:ssh_signing_key scope to use this endpoint.
users_slash_list
Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts. Note: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.
users_slash_list_blocked_by_authenticated_user
List the users you’ve blocked on your personal account.
users_slash_list_emails_for_authenticated_user
Lists all of your email addresses, and specifies which one is visible to the public. OAuth app tokens and personal access tokens (classic) need the user:email scope to use this endpoint.
users_slash_list_followed_by_authenticated_user
Lists the people who the authenticated user follows.
users_slash_list_followers_for_authenticated_user
Lists the people following the authenticated user.
users_slash_list_followers_for_user
Lists the people following the specified user.
users_slash_list_following_for_user
Lists the people who the specified user follows.
users_slash_list_gpg_keys_for_authenticated_user
Lists the current user’s GPG keys. OAuth app tokens and personal access tokens (classic) need the read:gpg_key scope to use this endpoint.
users_slash_list_gpg_keys_for_user
Lists the GPG keys for a user. This information is accessible by anyone.
users_slash_list_public_emails_for_authenticated_user
Lists your publicly visible email address, which you can set with the Set primary email visibility for the authenticated user endpoint. OAuth app tokens and personal access tokens (classic) need the user:email scope to use this endpoint.
users_slash_list_public_keys_for_user
Lists the verified public SSH keys for a user. This is accessible by anyone.
users_slash_list_public_ssh_keys_for_authenticated_user
Lists the public SSH keys for the authenticated user’s GitHub account. OAuth app tokens and personal access tokens (classic) need the read:public_key scope to use this endpoint.
users_slash_list_social_accounts_for_authenticated_user
Lists all of your social accounts.
users_slash_list_social_accounts_for_user
Lists social media accounts for a user. This endpoint is accessible by anyone.
users_slash_list_ssh_signing_keys_for_authenticated_user
Lists the SSH signing keys for the authenticated user’s GitHub account. OAuth app tokens and personal access tokens (classic) need the read:ssh_signing_key scope to use this endpoint.
users_slash_list_ssh_signing_keys_for_user
Lists the SSH signing keys for a user. This operation is accessible by anyone.
users_slash_set_primary_email_visibility_for_authenticated_user
Sets the visibility for your primary email addresses.
users_slash_unblock
Unblocks the given user and returns a 204.
users_slash_unfollow
OAuth app tokens and personal access tokens (classic) need the user:follow scope to use this endpoint.
users_slash_update_authenticated
Note: If your email is set to private and you send an email parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.