The identity and technical contract details declared by the specification.
simple-user
object
A GitHub user.
21 properties
18 required
installation
object
Installation
20 properties
17 required
nullable-simple-user
objectnull
A GitHub user.
21 properties
18 required
enterprise
object
An enterprise on GitHub.
10 properties
8 required
app-permissions
object
The permissions granted to the user access token.
45 properties
code-scanning-ref
string
The Git reference, formatted as refs/pull/ /merge, refs/pull/ /head, refs/heads/ or simply .
code-scanning-alert-instance
object
10 properties
dependabot-public-key
object
The public key used for setting Dependabot Secrets.
2 properties
2 required
code-scanning-analysis-tool-guid
stringnull
The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data.
dependabot-alert-package
object
Details for the vulnerable package.
2 properties
2 required
code-scanning-analysis-tool-name
string
The name of the tool used to generate the code scanning analysis.
alert-instances-url
string
The REST API URL for fetching the list of instances for an alert.
package
object
A software package
11 properties
9 required
allowed-actions
string
The permissions policy that controls the actions that are allowed to run.
actions-organization-permissions
object
4 properties
1 required
selected-actions
object
2 properties
2 required
runner
object
A self hosted runner
7 properties
6 required
runner-label
object
A label for a self hosted runner
3 properties
1 required
alert-dismissed-at
stringnull
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
dependabot-alert-security-advisory
object
Details for the GitHub Security Advisory.
13 properties
13 required
code-scanning-alert-location
object
Describe a region within a file for the alert.
5 properties
audit-log-event
object
43 properties
issue
object
Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
34 properties
21 required
org-pre-receive-hook
object
5 properties
organization-custom-repository-role
object
Custom repository roles created by organization owners
8 properties
7 required
code-scanning-alert-classification
stringnull
A classification of the file. For example to identify it as generated.
actions-cache-usage-by-repository
object
GitHub Actions Cache Usage by repository.
3 properties
3 required
org-hook
object
Org Hook
11 properties
10 required
webhook-config-url
string
The URL to which the payloads will be delivered.
code-scanning-alert-environment
string
Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language tha…
announcement-message
stringnull
The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "[Basic writing and formatting syntax](https://docs…
code-scanning-analysis-analysis-key
string
Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
secret-scanning-alert-resolution
stringnull
Required when the state is resolved. The reason for resolving the alert.
alert-created-at
string
The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
authentication-token
object
Authentication Token
6 properties
2 required
secret-scanning-alert-state
string
Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
runner-groups-org
object
12 properties
7 required
scim-error
object
Scim Error
6 properties
code-scanning-alert-state-query
string
State of a code scanning alert.
package-version
object
A version of a software package
11 properties
6 required
actions-can-approve-pull-request-reviews
boolean
Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.
organization-actions-variable
object
Organization variable for GitHub Actions.
6 properties
5 required
validation-error
object
Validation Error
3 properties
2 required
webhook-config-secret
string
If provided, the secret will be used as the key to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-serve…
simple-repository
object
A GitHub repository.
46 properties
46 required
dependabot-alert-security-vulnerability
object
Details pertaining to one vulnerable version range for the advisory.
4 properties
4 required
code-scanning-organization-alert-items
object
16 properties
13 required
code-scanning-analysis-tool-version
stringnull
The version of the tool used to generate the code scanning analysis.
project
object
Projects are a way to organize columns and cards of work.
15 properties
13 required
hook-delivery
object
Delivery made by a webhook.
14 properties
13 required
empty-object
object
An object without any properties.
code-scanning-analysis-tool
object
3 properties
code-scanning-alert-dismissed-comment
stringnull
The dismissal comment associated with the dismissal of the alert.
event
object
Event
8 properties
7 required
advanced-security-active-committers
object
3 properties
1 required
alert-url
string
The REST API URL of the alert resource.
organization-dependabot-secret
object
Secrets for GitHub Dependabot for an organization.
5 properties
4 required
nullable-license-simple
objectnull
License Simple
6 properties
5 required
webhook-config
object
Configuration object of the webhook
4 properties
actions-set-default-workflow-permissions
object
2 properties
actions-public-key
object
The public key used for setting Actions Secrets.
6 properties
2 required
nullable-repository
objectnull
A repository on GitHub.
95 properties
73 required
actions-get-default-workflow-permissions
object
2 properties
2 required
code-scanning-alert-state
string
State of a code scanning alert.
announcement-banner
object
Announcement at either the repository, organization, or enterprise level
3 properties
3 required
announcement
object
Enterprise global announcement
2 properties
1 required
minimal-repository
object
Minimal Repository
87 properties
46 required
code-of-conduct
object
Code Of Conduct
5 properties
4 required
code-scanning-alert-severity
string
Severity of a code scanning alert.
alert-updated-at
string
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
security-and-analysis
objectnull
3 properties
announcement-expiration
stringnull
The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO8601) format: YYYY-MM-DDTHH:MM:SSZ. To set an an…
actions-default-workflow-permissions
string
The default workflow permissions granted to the GITHUBTOKEN when running workflows.
organization-simple
object
A GitHub organization.
12 properties
12 required
nullable-alert-updated-at
stringnull
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
webhook-config-insecure-ssl
dependabot-alert-with-repository
object
A Dependabot alert.
16 properties
15 required
repository-fine-grained-permission
object
A fine-grained permission that protects repository resources.
2 properties
2 required
external-groups
object
A list of external groups available to be connected to a team
1 property
enabled-repositories
string
The policy that controls the repositories in the organization that are allowed to run GitHub Actions.
actor
object
Actor
6 properties
5 required
reaction-rollup
object
10 properties
10 required
actions-cache-usage-org-enterprise
object
2 properties
2 required
runner-application
object
Runner Application
6 properties
4 required
code-scanning-alert-dismissed-reason
stringnull
Required when the state is dismissed. The reason for dismissing or closing the alert.
author-association
string
How the author is associated with the repository.
advanced-security-active-committers-user
object
2 properties
2 required
nullable-milestone
objectnull
A collection of related issues and pull requests.
16 properties
16 required
validation-error-simple
object
Validation Error Simple
3 properties
2 required
organization-actions-secret
object
Secrets for GitHub Actions for an organization.
5 properties
4 required
alert-html-url
string
The GitHub URL of the alert resource.
issue-comment
object
Comments provide a way for people to collaborate on an issue.
14 properties
9 required
nullable-minimal-repository
objectnull
Minimal Repository
87 properties
46 required
announcement-user-dismissible
booleannull
Whether an announcement can be dismissed by the user.
code-scanning-alert-rule-summary
object
6 properties
webhook-config-content-type
string
The media type used to serialize the payloads. Supported values include json and form. The default is form.
organization-secret-scanning-alert
object
18 properties
nullable-integration
objectnull
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They…
17 properties
11 required
repository
object
A repository on GitHub.
95 properties
73 required
alert-auto-dismissed-at
stringnull
The time that the alert was auto-dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
code-scanning-analysis-category
string
Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed o…
basic-error
object
Basic Error
4 properties
alert-number
integer
The security alert number.
selected-actions-url
string
The API URL to use to get or set the actions that are allowed to run, when allowedactions is set to selected.
alert-fixed-at
stringnull
The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
organization-full
object
Organization Full
56 properties
23 required
hook-delivery-item
object
Delivery made by a webhook, without request and response information.
11 properties
11 required
oidc-custom-sub
object
Actions OIDC Subject customization
1 property
1 required
migration
object
A migration.
18 properties
16 required
code-of-conduct-simple
object
Code of Conduct Simple
4 properties
4 required
full-repository
object
Full Repository
102 properties
75 required
org-membership
object
Org Membership
7 properties
6 required
advanced-security-active-committers-repository
object
3 properties
3 required
actions-variable
object
4 properties
4 required
actions-secret
object
Set secrets for GitHub Actions.
3 properties
3 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs GitHub publishes across the network.