{ "opencollection": "1.0.0", "info": { "name": "APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Users API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "APIs.io Engineering Platform Get the authenticated user", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/user" }, "docs": "OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information." }, { "info": { "name": "APIs.io Engineering Platform Update the authenticated user", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/user", "body": { "type": "json", "data": "{}" } }, "docs": "**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." }, { "info": { "name": "APIs.io Engineering Platform List email addresses for the authenticated user", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/user/emails", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all of your email addresses, and specifies which one is visible\nto the public.\n\nOAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Add an email address for the authenticated user", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/user/emails", "body": { "type": "json", "data": "{}" } }, "docs": "OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Delete an email address for the authenticated user", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/user/emails", "body": { "type": "json", "data": "{}" } }, "docs": "OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform List followers of the authenticated user", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/user/followers", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the people following the authenticated user." }, { "info": { "name": "APIs.io Engineering Platform List the people the authenticated user follows", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/user/following", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the people who the authenticated user follows." }, { "info": { "name": "APIs.io Engineering Platform Check if a person is followed by the authenticated user", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/user/following/:username", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "APIs.io Engineering Platform Check if a person is followed by the authenticated user" }, { "info": { "name": "APIs.io Engineering Platform Follow a user", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/user/following/:username", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\nOAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Unfollow a user", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/user/following/:username", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform List GPG keys for the authenticated user", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/user/gpg_keys", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the current user's GPG keys.\n\nOAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Create a GPG key for the authenticated user", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/user/gpg_keys", "body": { "type": "json", "data": "{}" } }, "docs": "Adds a GPG key to the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Get a GPG key for the authenticated user", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/user/gpg_keys/:gpg_key_id", "params": [ { "name": "gpg_key_id", "value": "", "type": "path", "description": "The unique identifier of the GPG key." } ] }, "docs": "View extended details for a single GPG key.\n\nOAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Delete a GPG key for the authenticated user", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/user/gpg_keys/:gpg_key_id", "params": [ { "name": "gpg_key_id", "value": "", "type": "path", "description": "The unique identifier of the GPG key." } ] }, "docs": "Removes a GPG key from the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform List public SSH keys for the authenticated user", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/user/keys", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the public SSH keys for the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Create a public SSH key for the authenticated user", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/user/keys", "body": { "type": "json", "data": "{}" } }, "docs": "Adds a public SSH key to the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Get a public SSH key for the authenticated user", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/user/keys/:key_id", "params": [ { "name": "key_id", "value": "", "type": "path", "description": "The unique identifier of the key." } ] }, "docs": "View extended details for a single public SSH key.\n\nOAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Delete a public SSH key for the authenticated user", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/user/keys/:key_id", "params": [ { "name": "key_id", "value": "", "type": "path", "description": "The unique identifier of the key." } ] }, "docs": "Removes a public SSH key from the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform List public email addresses for the authenticated user", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/user/public_emails", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists your publicly visible email address, which you can set with the\n[Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@3.9/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user)\nendpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform List social accounts for the authenticated user", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/user/social_accounts", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all of your social accounts." }, { "info": { "name": "APIs.io Engineering Platform Add social accounts for the authenticated user", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/user/social_accounts", "body": { "type": "json", "data": "{}" } }, "docs": "Add one or more social accounts to the authenticated user's profile.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Delete social accounts for the authenticated user", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/user/social_accounts", "body": { "type": "json", "data": "{}" } }, "docs": "Deletes one or more social accounts from the authenticated user's profile.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform List SSH signing keys for the authenticated user", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/user/ssh_signing_keys", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the SSH signing keys for the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Create a SSH signing key for the authenticated user", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/user/ssh_signing_keys", "body": { "type": "json", "data": "{}" } }, "docs": "Creates an SSH signing key for the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Get an SSH signing key for the authenticated user", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/user/ssh_signing_keys/:ssh_signing_key_id", "params": [ { "name": "ssh_signing_key_id", "value": "", "type": "path", "description": "The unique identifier of the SSH signing key." } ] }, "docs": "Gets extended details for an SSH signing key.\n\nOAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Delete an SSH signing key for the authenticated user", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/user/ssh_signing_keys/:ssh_signing_key_id", "params": [ { "name": "ssh_signing_key_id", "value": "", "type": "path", "description": "The unique identifier of the SSH signing key." } ] }, "docs": "Deletes an SSH signing key from the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Get a user using their ID", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/user/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "account_id parameter" } ] }, "docs": "Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). 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 publi" }, { "info": { "name": "APIs.io Engineering Platform List users", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/users", "params": [ { "name": "since", "value": "", "type": "query", "description": "A user ID. Only return users with an ID greater than this ID." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users." }, { "info": { "name": "APIs.io Engineering Platform Get a user", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/users/:username", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "Provides publicly available information about someone with a GitHub account.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). 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 " }, { "info": { "name": "APIs.io Engineering Platform List followers of a user", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/users/:username/followers", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the people following the specified user." }, { "info": { "name": "APIs.io Engineering Platform List the people a user follows", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/users/:username/following", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the people who the specified user follows." }, { "info": { "name": "APIs.io Engineering Platform Check if a user follows another user", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/users/:username/following/:target_user", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." }, { "name": "target_user", "value": "", "type": "path" } ] }, "docs": "APIs.io Engineering Platform Check if a user follows another user" }, { "info": { "name": "APIs.io Engineering Platform List GPG keys for a user", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/users/:username/gpg_keys", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the GPG keys for a user. This information is accessible by anyone." }, { "info": { "name": "APIs.io Engineering Platform Get contextual information for a user", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/users/:username/hovercard", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." }, { "name": "subject_type", "value": "", "type": "query", "description": "Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`." }, { "name": "subject_id", "value": "", "type": "query", "description": "Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`." } ] }, "docs": "Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.\n\n 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 " }, { "info": { "name": "APIs.io Engineering Platform List public keys for a user", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/users/:username/keys", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the _verified_ public SSH keys for a user. This is accessible by anyone." }, { "info": { "name": "APIs.io Engineering Platform List social accounts for a user", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/users/:username/social_accounts", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists social media accounts for a user. This endpoint is accessible by anyone." }, { "info": { "name": "APIs.io Engineering Platform List SSH signing keys for a user", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/users/:username/ssh_signing_keys", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the SSH signing keys for a user. This operation is accessible by anyone." } ] } ], "bundled": true }