text stringlengths 12 91.7k | metadata dict |
|---|---|
About snapshots
A snapshot stores the state of a virtual machine (VM) at a point in time. highly recommends taking a hypervisor level snapshot before upgrading your VM so that if an upgrade fails, you can revert your VM back to the snapshot.
Types of snapshots
There are two types of snapshots:
VM snapshots save your... | {
"source": "github-docs/admin/upgrading-your-instance/preparing-to-upgrade/taking-a-snapshot.md",
"title": "Taking a snapshot"
} |
[!NOTE]
Upgrade packages are available at enterprise.github.com for supported versions. Verify the availability of the upgrade packages you will need to complete the upgrade. If a package is not available, visit and contact us for assistance.
If you're using Clustering, see AUTOTITLE in the Clustering Guide for ... | {
"source": "github-docs/admin/upgrading-your-instance/preparing-to-upgrade/upgrade-requirements.md",
"title": "Upgrade requirements"
} |
About known issues with upgrades
is aware of the following issues that could impact upgrades to new releases of . For more information, see "Known issues" in the release notes.
If you see the error The file provided is not a valid GitHub Enterprise Server package when attempting an upgrade, you may need to rotate th... | {
"source": "github-docs/admin/upgrading-your-instance/troubleshooting-upgrades/known-issues-with-upgrades-to-your-instance.md",
"title": "Known issues with upgrades to your instance"
} |
If an upgrade fails or is interrupted, you should revert your instance back to its previous state. The process for completing this depends on the type of upgrade.
If your instance is configured for high availability and your primary node upgrade fails, you can promote the (not upgraded) replica to be the primary. You w... | {
"source": "github-docs/admin/upgrading-your-instance/troubleshooting-upgrades/restoring-from-a-failed-upgrade.md",
"title": "Restoring from a failed upgrade"
} |
About upgrade package signing keys
upgrade packages are signed with a GPG key so that administrators can verify the packages come from . When you install an upgrade, the appliance checks the package signature against the GPG public key stored in its keyring.
Occasionally, may rotate this signing key. When that happen... | {
"source": "github-docs/admin/upgrading-your-instance/troubleshooting-upgrades/rotating-the-signing-key-for-upgrade-packages.md",
"title": "Rotating the signing key for upgrade packages"
} |
About
A is a type of integration that you can build to interact with and extend the functionality of . You can build a to provide flexibility and reduce friction in your processes, without needing to sign in a user or create a service account.
Common use cases for include:
Automating tasks or background processes
... | {
"source": "github-docs/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps.md",
"title": "About creating GitHub Apps"
} |
Select the minimum permissions required
When you register a , select the minimum permissions that your needs. If any keys or tokens for your app become compromised, this will limit the amount of damage that can occur. For more information about how to choose permissions, see AUTOTITLE.
When your creates an installati... | {
"source": "github-docs/apps/creating-github-apps/about-creating-github-apps/best-practices-for-creating-a-github-app.md",
"title": "Best practices for creating a GitHub App"
} |
Using a instead of an
In general, are preferred over .
Both and use OAuth 2.0.
can only act on behalf of a user while can either act on behalf of a user or independently of a user.
For more information, see AUTOTITLE.
For information on how to migrate an existing to a , see AUTOTITLE.
offer enhanced security
... | {
"source": "github-docs/apps/creating-github-apps/about-creating-github-apps/deciding-when-to-build-a-github-app.md",
"title": "Deciding when to build a GitHub App"
} |
You can use a to authenticate in a
workflow if the built in GITHUBTOKEN does not have sufficient permissions. For more information, see AUTOTITLE. | {
"source": "github-docs/apps/creating-github-apps/about-creating-github-apps/deciding-when-to-build-a-github-app.md",
"title": "Deciding when to build a GitHub App"
} |
Benefits of migrating from to
are the recommended way to integrate with . offer many advantages over , including:
Enhanced security features, like fine-grained permissions, choice over repository access, and short lived tokens
The ability to act independently of or on behalf of a user
Scalable rate limits
Built... | {
"source": "github-docs/apps/creating-github-apps/about-creating-github-apps/migrating-oauth-apps-to-github-apps.md",
"title": "Migrating OAuth apps to GitHub Apps"
} |
Authentication as a
To authenticate as itself, your app will use a JSON Web Token (JWT). Your app should authenticate as itself when it needs to generate an installation access token. An installation access token is required to authenticate as an app installation. Your app should also authenticate as itself when it ne... | {
"source": "github-docs/apps/creating-github-apps/authenticating-with-a-github-app/about-authentication-with-a-github-app.md",
"title": "About authentication with a GitHub App"
} |
About authentication as a installation
Once your is installed on an account, you can make it authenticate as an app installation for API requests. This allows the app to access resources owned by that installation, as long as the app was granted the necessary repository access and permissions. API requests made by an... | {
"source": "github-docs/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app-installation.md",
"title": "Authenticating as a GitHub App installation"
} |
About authentication as a
You must authenticate as a in order to make REST API requests as the application. For example, if you want to use the API to generate an installation access token for accessing organization or enterprise resources, list installations across accounts for your app, or suspend an app installati... | {
"source": "github-docs/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app.md",
"title": "Authenticating as a GitHub App"
} |
Your app can make API requests on behalf of a user. API requests made by an app on behalf of a user will be attributed to that user. For example, if your app posts a comment on behalf of a user, the UI will show the user's avatar photo along with the app's identicon badge as the author of the issue.
Similarly, if the ... | {
"source": "github-docs/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user.md",
"title": "Authenticating with a GitHub App on behalf of a user"
} |
About JSON Web Tokens (JWTs)
In order to authenticate as an app or generate an installation access token, you must generate a JSON Web Token (JWT). If a REST API endpoint requires a JWT, the documentation for that endpoint will indicate that you must use a JWT to access the endpoint.
Your JWT must be signed using the R... | {
"source": "github-docs/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-json-web-token-jwt-for-a-github-app.md",
"title": "Generating a JSON Web Token (JWT) for a GitHub App"
} |
Claim Meaning Details
---------
iat Issued At The time that the JWT was created. To protect against clock drift, we recommend that you set this 60 seconds in the past and ensure that your server's date and time is set accurately (for example, by using the Network Time Protocol).
exp Expires At The expiration time... | {
"source": "github-docs/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-json-web-token-jwt-for-a-github-app.md",
"title": "Generating a JSON Web Token (JWT) for a GitHub App"
} |
About user access tokens
[!NOTE]
A user access token is a type of OAuth token. Unlike a traditional OAuth token, the user access token does not use scopes. Instead, it uses fine-grained permissions. A user access token only has permissions that both the user and the app have. For example, if the app was granted permi... | {
"source": "github-docs/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app.md",
"title": "Generating a user access token for a GitHub App"
} |
About installation access tokens
In order to authenticate as an app installation, you must generate an installation access token. For more information about authenticating as an app installation, see Authenticating as a GitHub App installation.
[!NOTE]
Instead of generating an installation access token, you can use '... | {
"source": "github-docs/apps/creating-github-apps/authenticating-with-a-github-app/generating-an-installation-access-token-for-a-github-app.md",
"title": "Generating an installation access token for a GitHub App"
} |
About authentication
If you need to make authenticated API requests in a workflow or need to execute a custom action that requires a token, you should use the built-in GITHUBTOKEN if possible. However, the GITHUBTOKEN can only access resources within the workflow's repository. If you need to access additional resourc... | {
"source": "github-docs/apps/creating-github-apps/authenticating-with-a-github-app/making-authenticated-api-requests-with-a-github-app-in-a-github-actions-workflow.md",
"title": "Making authenticated API requests with a GitHub App in a GitHub Actions workflow"
} |
About private keys for
After you create a , you'll need to generate a private key in order to make requests to the API as the application itself. For example, you need a private key to sign a JSON Web Token (JWT) in order to request an installation access token. For more information, see AUTOTITLE
You can create up t... | {
"source": "github-docs/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps.md",
"title": "Managing private keys for GitHub Apps"
} |
About user access tokens that expire
[!NOTE]
User access tokens that expire are currently an optional feature and are subject to change. For more information, see Expiring user-to-server access tokens for GitHub Apps.
To enforce regular token rotation and reduce the impact of a compromised token, you can configure yo... | {
"source": "github-docs/apps/creating-github-apps/authenticating-with-a-github-app/refreshing-user-access-tokens.md",
"title": "Refreshing user access tokens"
} |
When you register a , you can specify a setup URL. When users install your , they are redirected to the setup URL. If additional setup is required after installation, you can use this URL to tell users what steps to take next.
If you specify a setup URL, you can also select Redirect on update to specify that users shou... | {
"source": "github-docs/apps/creating-github-apps/registering-a-github-app/about-the-setup-url.md",
"title": "About the setup URL"
} |
When you register a , you can specify a callback URL. When you use the web application flow to generate a user access token in order to act on behalf of a user, users will be redirected to the callback URL after they authorize the .
You can specify up to 10 callback URLs. If you specify multiple callback URLs, you can ... | {
"source": "github-docs/apps/creating-github-apps/registering-a-github-app/about-the-user-authorization-callback-url.md",
"title": "About the user authorization callback URL"
} |
About permissions
don't have any permissions by default. When you register a , you can select permissions for the app. The permissions that you select determine what the app can do with 's APIs and what webhooks the app can subscribe to. You should select the minimum permissions required for the app.
Although don't ... | {
"source": "github-docs/apps/creating-github-apps/registering-a-github-app/choosing-permissions-for-a-github-app.md",
"title": "Choosing permissions for a GitHub App"
} |
About badges
Every has a badge. A badge is a square image inside a circular background.
By default, a new GitHub App will use an automatically generated identicon as a badge. An identicon badge looks something like this:
After you register a GitHub App, you can customize your app's badge by uploading a logo and select... | {
"source": "github-docs/apps/creating-github-apps/registering-a-github-app/creating-a-custom-badge-for-your-github-app.md",
"title": "Creating a custom badge for your GitHub App"
} |
About visibility for
A can be public or privatepublic, private, or internal. If you set your registration to public, any user on can install it and authorize it. If you set your registration to private, it can only be installed on the account that owns the app. Only members of the organization that owns it can aut... | {
"source": "github-docs/apps/creating-github-apps/registering-a-github-app/making-a-github-app-public-or-private.md",
"title": "Making a GitHub App public or private"
} |
API rate limits are disabled by default for . Contact your site administrator to confirm the rate limits for your instance.
If you are a site administrator, you can set rate limits for your instance. For more information, see AUTOTITLE.
If you are developing an app for users or organizations outside of your instance, t... | {
"source": "github-docs/apps/creating-github-apps/registering-a-github-app/rate-limits-for-github-apps.md",
"title": "Rate limits for GitHub Apps"
} |
About registering
You can register a in a few different ways.
Under your personal account.
Under an organization you own.
Under an organization that has granted you permission to manage all its apps. See AUTOTITLE.
Under your enterprise, but it can only be installed on that enterprise and organizations within the... | {
"source": "github-docs/apps/creating-github-apps/registering-a-github-app/registering-a-github-app.md",
"title": "Registering a GitHub App"
} |
About webhooks and
Webhooks enable your to receive real-time notifications when events happen on , such as when someone pushes a commit or opens a pull request in a repository that your app can access. For more information about webhooks, see AUTOTITLE. For a tutorial that demonstrates how to use webhooks with a , se... | {
"source": "github-docs/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps.md",
"title": "Using webhooks with GitHub Apps"
} |
Prerequisites
Before you write code for a , you should register a . When you register a , you select permissions for the app. These permissions dictate what the can do. When you register an app, you also specify other settings, including which webhook events your should receive. You can always change the settings for... | {
"source": "github-docs/apps/creating-github-apps/writing-code-for-a-github-app/about-writing-code-for-a-github-app.md",
"title": "About writing code for a GitHub App"
} |
Introduction
This tutorial demonstrates how to build a command line interface (CLI) backed by a , and how to use the device flow to generate a user access token for the app.
The CLI will have three commands:
help: Outputs the usage instructions.
login: Generates a user access token that the app can use to make API re... | {
"source": "github-docs/apps/creating-github-apps/writing-code-for-a-github-app/building-a-cli-with-a-github-app.md",
"title": "Building a CLI with a GitHub App"
} |
Introduction
This tutorial demonstrates how to write code to create a that makes an API request in response to a webhook event. Specifically, when a pull request is opened in a repository that the app was granted access to, the app will receive a pull request webhook event. Then, the app will use 's API to add a comme... | {
"source": "github-docs/apps/creating-github-apps/writing-code-for-a-github-app/building-a-github-app-that-responds-to-webhook-events.md",
"title": "Building a GitHub App that responds to webhook events"
} |
Introduction
This tutorial demonstrates how to build a "Login with " button for a website. The website will use a to generate a user access token via the web application flow. Then, the website uses the user access token to make API requests on behalf of the authenticated user.
This tutorial uses Ruby, but you can use... | {
"source": "github-docs/apps/creating-github-apps/writing-code-for-a-github-app/building-a-login-with-github-button-with-a-github-app.md",
"title": "Building a \"Login with GitHub\" button with a GitHub App"
} |
Introduction
This tutorial demonstrates how to build a continuous integration (CI) server that runs tests on new code that's pushed to a repository. The tutorial shows how to build and configure a to act as a server that receives and responds to checkrun and checksuite webhook events using 's REST API.
In this tutoria... | {
"source": "github-docs/apps/creating-github-apps/writing-code-for-a-github-app/building-ci-checks-with-a-github-app.md",
"title": "Building CI checks with a GitHub App"
} |
Introduction
let you automate processes or integrate other platforms with . For more info, see AUTOTITLE.
This quickstart describes how to quickly create a . When a pull request is opened in a repository that the app was granted access to, the app will add a comment to the pull request.
This quickstart uses pre-writte... | {
"source": "github-docs/apps/creating-github-apps/writing-code-for-a-github-app/quickstart.md",
"title": "Quickstart for building GitHub Apps"
} |
[!NOTE]
The authentication metadata documents described in this article are in and subject to change.
While the endpoints may be present on and some versions of , they contain incorrect information.
publishes two metadata documents used in the OAuth 2.0 and OpenID Connect protocols:
OAuth 2.0 Authorization Serve... | {
"source": "github-docs/apps/github-authentication-discovery-endpoints.md",
"title": "GitHub authentication discovery endpoints"
} |
If you follow these best practices it will help you to provide a good customer experience.
Customer communication
Marketing materials for the app should accurately represent the app's behavior.
Apps should include links to user-facing documentation that describe how to set up and use the app.
Customers should be ab... | {
"source": "github-docs/apps/github-marketplace/creating-apps-for-github-marketplace/customer-experience-best-practices-for-apps.md",
"title": "Customer experience best practices for apps"
} |
<!--UI-LINK: Displayed as a link on the https://github.com/marketplace/new page.--
The requirements for listing an app on vary according to whether you want to offer a free or a paid app.
Requirements for all listings
All listings on should be for tools that provide value to the community. When you submit your lis... | {
"source": "github-docs/apps/github-marketplace/creating-apps-for-github-marketplace/requirements-for-listing-an-app.md",
"title": "Requirements for listing an app"
} |
Before listing an app on , you should follow the best practices for the type of app that you are listing:
AUTOTITLE
AUTOTITLE
Additionally, you should have the capability to notify within 24 hours of a confirmed security incident.
In addition to following security best practices, you should also follow customer expe... | {
"source": "github-docs/apps/github-marketplace/creating-apps-for-github-marketplace/security-best-practices-for-apps-on-github-marketplace.md",
"title": "Security best practices for apps on GitHub Marketplace"
} |
You can view metrics for the past day (24 hours), week, month, or for the entire duration of time that your has been listed.
[!NOTE]
Because it takes time to aggregate data, you'll notice a slight delay in the dates shown. When you select a time period, you can see exact dates for the metrics at the top of the page.... | {
"source": "github-docs/apps/github-marketplace/creating-apps-for-github-marketplace/viewing-metrics-for-your-listing.md",
"title": "Viewing metrics for your listing"
} |
[!NOTE]
Because it takes time to aggregate data, you'll notice a slight delay in the dates shown. When you select a time period, you can see exact dates for the metrics at the top of the page.
You can view or download the transaction data to keep track of your subscription activity. Click the Export CSV button to down... | {
"source": "github-docs/apps/github-marketplace/creating-apps-for-github-marketplace/viewing-transactions-for-your-listing.md",
"title": "Viewing transactions for your listing"
} |
connects you to developers who want to extend and improve their workflows. You can list free and paid tools for developers to use in . offers developers two types of tools: and Apps, and each tool requires different steps for adding it to .
GitHub Actions
To learn about publishing in , see AUTOTITLE.
Apps
Anyone ... | {
"source": "github-docs/apps/github-marketplace/github-marketplace-overview/about-github-marketplace-for-apps.md",
"title": "About GitHub Marketplace for apps"
} |
Certain apps on the have the badge and a tooltip that says "Publisher domain and email verified". This means that the app is owned by an organization that has:
Verified ownership of their domain and has a verified badge on their profile
Confirmed their email address so Support can reach the organization
Required ... | {
"source": "github-docs/apps/github-marketplace/github-marketplace-overview/about-marketplace-badges.md",
"title": "About marketplace badges"
} |
Publisher verification ensures that has a way to contact you, that you've enabled two-factor authentication for your organization, and that your organization's domain has been verified.
Once your organization has been verified, you can publish paid plans for your app. For information, see AUTOTITLE.
To offer paid plan... | {
"source": "github-docs/apps/github-marketplace/github-marketplace-overview/applying-for-publisher-verification-for-your-organization.md",
"title": "Applying for publisher verification for your organization"
} |
The event webhook can only be set up from your application's listing page. You can configure all other events from your application's developer settings page. If you haven't created a listing, read AUTOTITLE to learn how.
Creating a webhook
To create a webhook for your listing, click Webhook in the left sidebar of... | {
"source": "github-docs/apps/github-marketplace/listing-an-app-on-github-marketplace/configuring-a-webhook-to-notify-you-of-plan-changes.md",
"title": "Configuring a webhook to notify you of plan changes"
} |
You can follow these steps to remove your app from . The listing will be removed from immediately. Existing subscriptions will be canceled at the end of the current billing cycle. Although the app will be removed from , you will not be able to delete your app until the current billing cycle ends.
1. In the left sideba... | {
"source": "github-docs/apps/github-marketplace/listing-an-app-on-github-marketplace/deleting-your-app-listing-from-github-marketplace.md",
"title": "Deleting your app listing from GitHub Marketplace"
} |
Create a new draft listing
You can only create draft listings for apps that are public. Before creating your draft listing, you can read the following guidelines for writing and configuring settings in your listing:
Writing listing descriptions
AUTOTITLE
Configuring the Webhook
To create a listing:
1. In the le... | {
"source": "github-docs/apps/github-marketplace/listing-an-app-on-github-marketplace/drafting-a-listing-for-your-app.md",
"title": "Drafting a listing for your app"
} |
About setting pricing plans
offers several different types of pricing plans. For detailed information, see AUTOTITLE.
To offer a paid plan for your app, your app must be owned by an organization that has completed the publisher verification process and met certain criteria. For more information, see AUTOTITLE and AUTO... | {
"source": "github-docs/apps/github-marketplace/listing-an-app-on-github-marketplace/setting-pricing-plans-for-your-listing.md",
"title": "Setting pricing plans for your listing"
} |
Once your app listing meets the requirements, you can submit your app. For an overview of the app listing requirements, see AUTOTITLE.
1. In the left sidebar on the app listing page, click Overview. For information on finding your app listing page, see AUTOTITLE.
!Screenshot of the left sidebar on the app listing p... | {
"source": "github-docs/apps/github-marketplace/listing-an-app-on-github-marketplace/submitting-your-listing-for-publication.md",
"title": "Submitting your listing for publication"
} |
Here are guidelines about the fields you'll need to fill out in the Listing description section of your draft listing.
Naming and links
Listing name
Your listing's name will appear on the homepage. The name is limited to 255 characters and can be different from your app's name. Your listing cannot have the same name... | {
"source": "github-docs/apps/github-marketplace/listing-an-app-on-github-marketplace/writing-a-listing-description-for-your-app.md",
"title": "Writing a listing description for your app"
} |
Required URLs
Customer support URL: The URL of a web page that your customers will go to when they have technical support, product, or account inquiries.
Privacy policy URL: The web page that displays your app's privacy policy.
Installation URL: This field is shown for only. ( don't use this URL because they use th... | {
"source": "github-docs/apps/github-marketplace/listing-an-app-on-github-marketplace/writing-a-listing-description-for-your-app.md",
"title": "Writing a listing description for your app"
} |
Optional URLs
Company URL: A link to your company's website.
Status URL: A link to a web page that displays the status of your app. Status pages can include current and historical incident reports, web application uptime status, and scheduled maintenance.
Documentation URL: A link to documentation that teaches custo... | {
"source": "github-docs/apps/github-marketplace/listing-an-app-on-github-marketplace/writing-a-listing-description-for-your-app.md",
"title": "Writing a listing description for your app"
} |
Understanding the billing cycle
Customers can choose a monthly or yearly billing cycle when they purchase your app. All changes customers make to the billing cycle and plan selection will trigger a marketplacepurchase event. You can refer to the marketplacepurchase webhook payload to see which billing cycle a customer ... | {
"source": "github-docs/apps/github-marketplace/selling-your-app-on-github-marketplace/billing-customers.md",
"title": "Billing customers"
} |
pricing plans can be free, flat rate, or per-unit. Prices are set, displayed, and processed in US dollars. Paid plans are restricted to apps published by verified publishers. For more information about becoming a verified publisher, see AUTOTITLE.
Customers purchase your app using a payment method attached to their acc... | {
"source": "github-docs/apps/github-marketplace/selling-your-app-on-github-marketplace/pricing-plans-for-github-marketplace-apps.md",
"title": "Pricing plans for GitHub Marketplace apps"
} |
After your listing for an app with a paid plan is created and approved, you'll provide payment details to as part of the financial onboarding process.
Once your revenue reaches a minimum of 500 US dollars for the month, you'll receive an electronic payment from at the end of the following month. This will be the inc... | {
"source": "github-docs/apps/github-marketplace/selling-your-app-on-github-marketplace/receiving-payment-for-app-purchases.md",
"title": "Receiving payment for app purchases"
} |
[!WARNING]
If you offer a in , your app must identify users following the OAuth authorization flow. You don't need to set up a separate to support this flow. See AUTOTITLE for more information.
Step 1. Initial purchase and webhook event
Before a customer purchases your app, they select a listing plan. They also ch... | {
"source": "github-docs/apps/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-new-purchases-and-free-trials.md",
"title": "Handling new purchases and free trials"
} |
For more information about cancelling as it relates to billing, see AUTOTITLE.
Step 1. Cancellation event
If a customer chooses to cancel a order, GitHub sends a marketplacepurchase webhook with the action cancelled to your app when the cancellation takes effect. If the customer cancels during a free trial, your app ... | {
"source": "github-docs/apps/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-plan-cancellations.md",
"title": "Handling plan cancellations"
} |
For more information about upgrading and downgrading as it relates to billing, see AUTOTITLE.
Step 1. Pricing plan change event
GitHub send the marketplacepurchase webhook with the changed action to your app, when a customer makes any of these changes to their order:
Upgrades to a more expensive pricing plan or down... | {
"source": "github-docs/apps/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-plan-changes.md",
"title": "Handling plan changes"
} |
Here are some useful endpoints available for Marketplace listings:
List plans
List accounts for a plan
Get a subscription plan for an account
List subscriptions for the authenticated user
See these pages for details on how to authenticate when using the API:
Authorization options for
Authentication options for ... | {
"source": "github-docs/apps/github-marketplace/using-the-github-marketplace-api-in-your-app/rest-endpoints-for-the-github-marketplace-api.md",
"title": "REST endpoints for the GitHub Marketplace API"
} |
Testing apps
You can use a draft listing to simulate each of the billing flows. A listing in the draft state means that it has not been submitted for approval. Any purchases you make using a draft listing will not create real transactions, and GitHub will not charge your credit card. Note that you can only simulate p... | {
"source": "github-docs/apps/github-marketplace/using-the-github-marketplace-api-in-your-app/testing-your-app.md",
"title": "Testing your app"
} |
For more information about the webhook payload, see AUTOTITLE.
Webhooks POST requests have special headers. See AUTOTITLE for more details. GitHub doesn't resend failed delivery attempts. Ensure your app can receive all webhook payloads sent by GitHub. For information about how to create and disable webhooks, see AUT... | {
"source": "github-docs/apps/github-marketplace/using-the-github-marketplace-api-in-your-app/webhook-events-for-the-github-marketplace-api.md",
"title": "Webhook events for the GitHub Marketplace API"
} |
For more information about how to designate someone as a manager in an organization, see AUTOTITLE. For more information about how to designate someone as a manager in an enterprise, see AUTOTITLE. | {
"source": "github-docs/apps/maintaining-github-apps/about-github-app-managers.md",
"title": "About GitHub App managers"
} |
[!WARNING]
Optional features are subject to change.
Activating optional features for
1. Click Edit next to the you want to enable an optional feature for.
Further reading
AUTOTITLE | {
"source": "github-docs/apps/maintaining-github-apps/activating-optional-features-for-github-apps.md",
"title": "Activating optional features for GitHub Apps"
} |
[!NOTE]
If you want to remove a that you use but do not own, see AUTOTITLE instead.
About deleting
If you own a or are an app manager for a , you can delete the registration. For more information about managers, see AUTOTITLE.
When you delete a registration, the app will be uninstalled from all accounts that th... | {
"source": "github-docs/apps/maintaining-github-apps/deleting-a-github-app.md",
"title": "Deleting a GitHub App"
} |
About IP address allow lists for
Enterprise and organization owners can restrict access to assets by configuring an IP address allow list. This list specifies the IP addresses that actors can use to access their resources. For more information, see AUTOTITLE.
When an organization or enterprise has an allow list, third... | {
"source": "github-docs/apps/maintaining-github-apps/managing-allowed-ip-addresses-for-a-github-app.md",
"title": "Managing allowed IP addresses for a GitHub App"
} |
About modifications
You can modify your registration to change any of the settings that were selected when the app was initially registered. For more information about the settings you can select while registering a , see AUTOTITLE.
For example, you can change the name and description of your app, the permissions gra... | {
"source": "github-docs/apps/maintaining-github-apps/modifying-a-github-app-registration.md",
"title": "Modifying a GitHub App registration"
} |
[!NOTE]
If you want to suspend a that you use but do not own, see AUTOTITLE instead.
When a is suspended for an installation, the cannot access resources owned by that installation account. For example, you might want to suspend your if you are worried that your app's credentials were leaked.
The owner of a and d... | {
"source": "github-docs/apps/maintaining-github-apps/suspending-a-github-app-installation.md",
"title": "Suspending a GitHub App installation"
} |
About transferring
The owner of a registration can transfer ownership of the registration to another account. App managers can also transfer ownership of the registration. For more information about app managers, see AUTOTITLE.
You can transfer apps from a user or organization to another account. You cannot transfe... | {
"source": "github-docs/apps/maintaining-github-apps/transferring-ownership-of-a-github-app.md",
"title": "Transferring ownership of a GitHub App"
} |
In this section, we're going to focus on the basics of authentication. Specifically,
we're going to create a Ruby server (using Sinatra) that implements
the web flow of an application in several different ways.
[!TIP]
You can download the complete source code for this project from the platform-samples repo.
Register... | {
"source": "github-docs/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app.md",
"title": "Authenticating to the REST API with an OAuth app"
} |
What if we could circumvent the entire
"click here" process, and just remember that, as long as the user's logged into
, they should be able to access this application? Hold on to your hat,
because that's exactly what we're going to do.
Our little server above is rather simple. In order to wedge in some intelligent
aut... | {
"source": "github-docs/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app.md",
"title": "Authenticating to the REST API with an OAuth app"
} |
[!NOTE]
Consider building a instead of an .
Both and use OAuth 2.0.
can act on behalf of a user, similar to an , or as themselves, which is beneficial for automations that do not require user input. Additionally, use fine-grained permissions, give the user more control over which repositories the app can access... | {
"source": "github-docs/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps.md",
"title": "Authorizing OAuth apps"
} |
Parameter name Type Description
-------------------------
clientid string Required. The client ID you received from for your app.
scope string A space-delimited list of the scopes that your app is requesting access to. For more information, see AUTOTITLE.
By default, the response takes the following form:
device... | {
"source": "github-docs/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps.md",
"title": "Authorizing OAuth apps"
} |
Parameter name Type Description
-------------------------
devicecode string The device verification code is 40 characters and used to verify the device.
usercode string The user verification code is displayed on the device so the user can enter the code in a browser. This code is 8 characters with a hyphen in the... | {
"source": "github-docs/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps.md",
"title": "Authorizing OAuth apps"
} |
Parameter name Type Description
-------------------------
clientid string Required. The client ID you received from for your .
devicecode string Required. The devicecode you received from the POST /login/device/code request.
granttype string Required. The grant type must be urn:ietf:params:oauth:grant-type:dev... | {
"source": "github-docs/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps.md",
"title": "Authorizing OAuth apps"
} |
Use a instead
If possible, consider using a instead of an . In general, are preferred over . use fine-grained permissions, give the user more control over which repositories the app can access, and use short-lived tokens. These properties can harden the security of your app by limiting the damage that could be done... | {
"source": "github-docs/apps/oauth-apps/building-oauth-apps/best-practices-for-creating-an-oauth-app.md",
"title": "Best practices for creating an OAuth app"
} |
By default, a new will have an automatically generated identicon.
An identicon badge looks something like this:
After you create an , you can customize the app's badge by uploading a logo and selecting a background color. A badge is a square logo image inside of a circular badge. You can choose a background color for ... | {
"source": "github-docs/apps/oauth-apps/building-oauth-apps/creating-a-custom-badge-for-your-oauth-app.md",
"title": "Creating a custom badge for your OAuth app"
} |
[!NOTE]
Consider building a instead of an .
Both and use OAuth 2.0.
can only act on behalf of a user while can either act on behalf of a user or independently of a user.
use fine-grained permissions, give the user more control over which repositories the app can access, and use short-lived tokens.
For more i... | {
"source": "github-docs/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app.md",
"title": "Creating an OAuth app"
} |
About and
In general, are preferred over . use fine-grained permissions, give the user more control over which repositories the app can access, and use short-lived tokens. These properties can harden the security of your app by limiting the damage that could be done if your app's credentials were leaked.
Similar to... | {
"source": "github-docs/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps.md",
"title": "Differences between GitHub Apps and OAuth apps"
} |
[!NOTE]
Consider building a instead of an . The rate limit for using an installation access token scales with the number of repositories and number of organization users. Conversely, have lower rate limits and do not scale. For more information, see AUTOTITLE and AUTOTITLE.
[!WARNING]
are subject to a rate limit... | {
"source": "github-docs/apps/oauth-apps/building-oauth-apps/rate-limits-for-oauth-apps.md",
"title": "Rate limits for OAuth apps"
} |
[!NOTE]
Consider building a instead of an . use fine-grained permissions instead of scopes, which give you more control over what your app can do. For more information, see AUTOTITLE and AUTOTITLE.
When setting up an on GitHub, requested scopes are displayed to the user on the authorization form.
[!NOTE]
If you'r... | {
"source": "github-docs/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps.md",
"title": "Scopes for OAuth apps"
} |
Name Description
----------------
(no scope) Grants read-only access to public information (including user profile info, repository info, and gists)
siteadmin Grants site administrators access to Administration API endpoints.
repo Grants full access to public, internal, and private repositories including read and ... | {
"source": "github-docs/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps.md",
"title": "Scopes for OAuth apps"
} |
[!WARNING]
Optional features are subject to change.
Activating optional features for
1. Select the you want to enable an optional feature for. | {
"source": "github-docs/apps/oauth-apps/maintaining-oauth-apps/activating-optional-features-for-oauth-apps.md",
"title": "Activating optional features for OAuth apps"
} |
1. Select the you want to modify.
1. In the left sidebar, click Advanced.
1. Click Delete application.
1. Click Delete this OAuth Application. | {
"source": "github-docs/apps/oauth-apps/maintaining-oauth-apps/deleting-an-oauth-app.md",
"title": "Deleting an OAuth app"
} |
1. Modify the information that you'd like to change. | {
"source": "github-docs/apps/oauth-apps/maintaining-oauth-apps/modifying-an-oauth-app.md",
"title": "Modifying an OAuth app"
} |
1. Select the you want to modify.
1. Click Transfer ownership.
1. To confirm the transfer, in the text field, type the name of the you want to transfer.
1. Under "New owner's username or organization name," type the name of the user or organization you want to transfer the to.
1. Click Transfer this application.
On... | {
"source": "github-docs/apps/oauth-apps/maintaining-oauth-apps/transferring-ownership-of-an-oauth-app.md",
"title": "Transferring ownership of an OAuth app"
} |
Application suspended
If the you set up has been suspended (due to reported abuse, spam, or a mis-use of the API), GitHub will redirect to the registered callback URL using the following parameters to summarize the error:
http://your-application.com/callback?error=applicationsuspended
&errordescription=Your+... | {
"source": "github-docs/apps/oauth-apps/maintaining-oauth-apps/troubleshooting-authorization-request-errors.md",
"title": "Troubleshooting authorization request errors"
} |
[!NOTE]
These examples only show JSON responses.
Incorrect client credentials
If the client\id and or client\secret you pass are incorrect you will
receive this error response.
{
"error": "incorrect_client_credentials",
"error_description": "The client_id and/or client_secret passed are incorrect.",
"error_uri"... | {
"source": "github-docs/apps/oauth-apps/maintaining-oauth-apps/troubleshooting-oauth-app-access-token-request-errors.md",
"title": "Troubleshooting OAuth app access token request errors"
} |
When an wants to identify you by your account on , you'll see a page with the app's developer contact information and a list of the specific data that's being requested.
[!TIP]
You must verify your email address before you can authorize an .
access
can have read or write access to your data.
Read access only al... | {
"source": "github-docs/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps.md",
"title": "Authorizing OAuth apps"
} |
When a third-party application wants to identify you by your login, you'll see a page with the developer contact information and a list of the specific data that's being requested.
Contacting the application developer
Because an application is developed by a third-party who isn't , we don't know exactly how an applic... | {
"source": "github-docs/apps/oauth-apps/using-oauth-apps/connecting-with-third-party-applications.md",
"title": "Connecting with third-party applications"
} |
About installing in your organization
If you choose a paid plan, you'll pay for your app subscription on your organization's current billing date using your organization's existing payment method.
For more information about installing a , see AUTOTITLE.
Installing an in your organization
1. Review the information ab... | {
"source": "github-docs/apps/oauth-apps/using-oauth-apps/installing-an-oauth-app-in-your-organization.md",
"title": "Installing an OAuth app in your organization"
} |
About installing in your personal account
If you choose a paid plan, you'll pay for your app subscription on your personal account's current billing date using your existing payment method.
For more information about installing a , see AUTOTITLE.
Installing an in your personal account
1. Review the information about... | {
"source": "github-docs/apps/oauth-apps/using-oauth-apps/installing-an-oauth-app-in-your-personal-account.md",
"title": "Installing an OAuth app in your personal account"
} |
Some are privileged apps. These apps are owned by and are granted special capabilities. For example, even if an organization owner has restricted access by to the organization's data, users can still authorize these apps and use them to access data from the organization.
Some of these privileged apps are automatical... | {
"source": "github-docs/apps/oauth-apps/using-oauth-apps/privileged-oauth-apps.md",
"title": "Privileged OAuth apps"
} |
Further reading
AUTOTITLE
AUTOTITLE
AUTOTITLE | {
"source": "github-docs/apps/oauth-apps/using-oauth-apps/reviewing-your-authorized-oauth-apps.md",
"title": "Reviewing your authorized OAuth apps"
} |
About
are tools that extend 's functionality. can do things on like open issues, comment on pull requests, and manage projects. They can also do things outside of based on events that happen on . For example, a can post on Slack when an issue is opened on .
For more information about using , see AUTOTITLE.
For mo... | {
"source": "github-docs/apps/overview.md",
"title": "GitHub Apps overview"
} |
About developing for
If you want your to be available to organizations in a instance that you are not part of, you must take the following steps.
These steps are not required if your will only be used by organizations in a instance that you are part of. For more information, see AUTOTITLE.
If access is important... | {
"source": "github-docs/apps/sharing-github-apps/making-your-github-app-available-for-github-enterprise-server.md",
"title": "Making your GitHub App available for GitHub Enterprise Server"
} |
About Manifests
[!NOTE] Manifests are not available for enterprise-owned . They do not support enterprise permissions at this time.
When someone registers a from a manifest, they only need to follow a URL and name the app. The manifest includes the permissions, events, and webhook URL needed to automatically registe... | {
"source": "github-docs/apps/sharing-github-apps/registering-a-github-app-from-a-manifest.md",
"title": "Registering a GitHub App from a manifest"
} |
Name Type Description
------------------------
url string Required. The URL of the server that will receive the webhook POST requests.
active boolean Deliver event details when this hook is triggered, defaults to true.
Parameters
Name Type Description
------------------------
state string
Examples
This exa... | {
"source": "github-docs/apps/sharing-github-apps/registering-a-github-app-from-a-manifest.md",
"title": "Registering a GitHub App from a manifest"
} |
About URL parameters for registering
You can use URL parameters to preselect the configuration settings of a new registration and share a custom link with other people. The link will take people to a registration page, where the app settings will be pre-filled according to the URL parameters you included in the URL.... | {
"source": "github-docs/apps/sharing-github-apps/registering-a-github-app-using-url-parameters.md",
"title": "Registering a GitHub App using URL parameters"
} |
Parameter name Type Description
------------------------
name string The name of the . Give your app a clear and succinct name. Your app cannot have the same name as an existing user, unless it is your own user or organization name. A slugged version of your app's name will be shown in the user interface when your... | {
"source": "github-docs/apps/sharing-github-apps/registering-a-github-app-using-url-parameters.md",
"title": "Registering a GitHub App using URL parameters"
} |
Sharing your on
If your is public, you can choose to publish it to . For more information, see AUTOTITLE.
If you are an , then you cannot share your app on .
For more information about how users can install your app from , see AUTOTITLE and AUTOTITLE.
Sharing your via an install link
If your is public, other user... | {
"source": "github-docs/apps/sharing-github-apps/sharing-your-github-app.md",
"title": "Sharing your GitHub App"
} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.