About objects
Objects in GraphQL represent the resources you can access. An object can contain a list of fields, which are specifically typed.
For example, the Repository
object has a field called name
, which is a String
.
For more information, see "Introduction to GraphQL."
AddedToProjectEvent
Represents aadded_to_project
event on a given issue or pull request.
Implements
Fields
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| Project referenced by event. Preview notice
|
| Project card referenced by this project event. Preview notice
|
| Column name referenced by this project event. Preview notice
|
App
A GitHub App.
Implements
Fields
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| The description of the app. |
| The IP addresses of the app. Arguments
|
| The hex color code, without the leading '#', for the logo background. |
| A URL pointing to the app's logo. Arguments
|
| The name of the app. |
| A slug based on the name of the app for use in URLs. |
| Identifies the date and time when the object was last updated. |
| The URL to the app's homepage. |
AssignedEvent
Represents anassigned
event on any assignable object.
Implements
Fields
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the assignable associated with the event. |
| Identifies the user or mannequin that was assigned. |
| Identifies the date and time when the object was created. |
| Identifies the user who was assigned. Deprecation notice
Assignees can now be mannequins. Use the |
AutoMergeDisabledEvent
Represents aauto_merge_disabled
event on a given pull request.
Implements
Fields
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The user who disabled auto-merge for this Pull Request. |
| PullRequest referenced by event. |
| The reason auto-merge was disabled. |
| The reason_code relating to why auto-merge was disabled. |
AutoMergeEnabledEvent
Represents aauto_merge_enabled
event on a given pull request.
Implements
Fields
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The user who enabled auto-merge for this Pull Request. |
| PullRequest referenced by event. |
AutoMergeRequest
Represents an auto-merge request for a pull request.
Fields
Name | Description |
---|---|
| The email address of the author of this auto-merge request. |
| The commit message of the auto-merge request. |
| The commit title of the auto-merge request. |
| When was this auto-merge request was enabled. |
| The actor who created the auto-merge request. |
| The merge method of the auto-merge request. |
| The pull request that this auto-merge request is set against. |
AutoRebaseEnabledEvent
Represents aauto_rebase_enabled
event on a given pull request.
Implements
Fields
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The user who enabled auto-merge (rebase) for this Pull Request. |
| PullRequest referenced by event. |
AutoSquashEnabledEvent
Represents aauto_squash_enabled
event on a given pull request.
Implements
Fields
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The user who enabled auto-merge (squash) for this Pull Request. |
| PullRequest referenced by event. |
AutomaticBaseChangeFailedEvent
Represents aautomatic_base_change_failed
event on a given pull request.
Implements
Fields
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The new base for this PR. |
| The old base for this PR. |
| PullRequest referenced by event. |
AutomaticBaseChangeSucceededEvent
Represents aautomatic_base_change_succeeded
event on a given pull request.
Implements
Fields
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The new base for this PR. |
| The old base for this PR. |
| PullRequest referenced by event. |
BaseRefChangedEvent
Represents abase_ref_changed
event on a given issue or pull request.
Implements
Fields
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| Identifies the name of the base ref for the pull request after it was changed. |
| Identifies the primary key from the database. |
| Identifies the name of the base ref for the pull request before it was changed. |
| PullRequest referenced by event. |
BaseRefDeletedEvent
Represents abase_ref_deleted
event on a given pull request.
Implements
Fields
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the name of the Ref associated with the |
| Identifies the date and time when the object was created. |
| PullRequest referenced by event. |
BaseRefForcePushedEvent
Represents abase_ref_force_pushed
event on a given pull request.
Implements
Fields
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the after commit SHA for the |
| Identifies the before commit SHA for the |
| Identifies the date and time when the object was created. |
| PullRequest referenced by event. |
| Identifies the fully qualified ref name for the |
Blame
Represents a Git blame.
Fields
Name | Description |
---|---|
| The list of ranges from a Git blame. |
BlameRange
Represents a range of information from a Git blame.
Fields
Name | Description |
---|---|
| Identifies the recency of the change, from 1 (new) to 10 (old). This is calculated as a 2-quantile and determines the length of distance between the median age of all the changes in the file and the recency of the current range's change. |
| Identifies the line author. |
| The ending line for the range. |
| The starting line for the range. |
Blob
Represents a Git blob.
Implements
Fields
Name | Description |
---|---|
| An abbreviated version of the Git object ID. |
| Byte size of Blob object. |
| The HTTP path for this Git object. |
| The HTTP URL for this Git object. |
| Indicates whether the Blob is binary or text. Returns null if unable to determine the encoding. |
| Indicates whether the contents is truncated. |
| The Git object ID. |
| The Repository the Git object belongs to. |
| UTF8 text data or null if the Blob is binary. |
Bot
A special type of user which takes actions on behalf of GitHub Apps.
Implements
Fields
Name | Description |
---|---|
| A URL pointing to the GitHub App's public avatar. Arguments
|
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| The username of the actor. |
| The HTTP path for this bot. |
| Identifies the date and time when the object was last updated. |
| The HTTP URL for this bot. |
BranchProtectionRule
A branch protection rule.
Implements
Fields
Name | Description |
---|---|
| Can this branch be deleted. |
| Are force pushes allowed on this branch. |
| A list of conflicts matching branches protection rule and other branch protection rules. |
| The actor who created this branch protection rule. |
| Identifies the primary key from the database. |
| Will new commits pushed to matching branches dismiss pull request review approvals. |
| Can admins overwrite branch protection. |
| Repository refs that are protected by this rule. Arguments
|
| Identifies the protection rule pattern. |
| A list push allowances for this branch protection rule. |
| The repository associated with this branch protection rule. |
| Number of approving reviews required to update matching branches. |
| List of required status check contexts that must pass for commits to be accepted to matching branches. |
| Are approving reviews required to update matching branches. |
| Are reviews from code owners required to update matching branches. |
| Are commits required to be signed. |
| Are conversations required to be resolved before merging. |
| Are merge commits prohibited from being pushed to this branch. |
| Are status checks required to update matching branches. |
| Are branches required to be up to date before merging. |
| Is pushing to matching branches restricted. |
| Is dismissal of pull request reviews restricted. |
| A list review dismissal allowances for this branch protection rule. |
BranchProtectionRuleConflict
A conflict between two branch protection rules.
Fields
Name | Description |
---|---|
| Identifies the branch protection rule. |
| Identifies the conflicting branch protection rule. |
| Identifies the branch ref that has conflicting rules. |
BranchProtectionRuleConflictConnection
The connection type for BranchProtectionRuleConflict.
Fields
Name | Description |
---|---|
A list of edges. | |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
BranchProtectionRuleConflictEdge
An edge in a connection.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
BranchProtectionRuleConnection
The connection type for BranchProtectionRule.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
BranchProtectionRuleEdge
An edge in a connection.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
CheckAnnotation
A single check annotation.
Fields
Name | Description |
---|---|
| The annotation's severity level. |
| The path to the file that this annotation was made on. |
| Identifies the primary key from the database. |
| The position of this annotation. |
| The annotation's message. |
| The path that this annotation was made on. |
| Additional information about the annotation. |
| The annotation's title. |
CheckAnnotationConnection
The connection type for CheckAnnotation.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
CheckAnnotationEdge
An edge in a connection.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
CheckAnnotationSpan
An inclusive pair of positions for a check annotation.
Fields
Name | Description |
---|---|
| End position (inclusive). |
| Start position (inclusive). |
CheckRun
A check run.
Implements
Fields
Name | Description |
---|---|
| The check run's annotations. |
| The check suite that this run is a part of. |
| Identifies the date and time when the check run was completed. |
| The conclusion of the check run. |
| Identifies the primary key from the database. |
| The corresponding deployment for this job, if any. |
| The URL from which to find full details of the check run on the integrator's site. |
| A reference for the check run on the integrator's system. |
| Whether this is required to pass before merging for a specific pull request. |
| The name of the check for this check run. |
| Information about a pending deployment, if any, in this check run. |
| The permalink to the check run summary. |
| The repository associated with this check run. |
| The HTTP path for this check run. |
| Identifies the date and time when the check run was started. |
| The current status of the check run. |
| The check run's steps. Arguments
|
| A string representing the check run's summary. |
| A string representing the check run's text. |
| A string representing the check run. |
| The HTTP URL for this check run. |
CheckRunConnection
The connection type for CheckRun.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
CheckStep
A single check step.
Fields
Name | Description |
---|---|
| Identifies the date and time when the check step was completed. |
| The conclusion of the check step. |
| A reference for the check step on the integrator's system. |
| The step's name. |
| The index of the step in the list of steps of the parent check run. |
| Number of seconds to completion. |
| Identifies the date and time when the check step was started. |
| The current status of the check step. |
CheckStepConnection
The connection type for CheckStep.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
CheckSuite
A check suite.
Implements
Fields
Name | Description |
---|---|
| The GitHub App which created this check suite. |
| The name of the branch for this check suite. |
| The check runs associated with a check suite. Arguments
|
| The commit for this check suite. |
| The conclusion of this check suite. |
| Identifies the date and time when the object was created. |
| The user who triggered the check suite. |
| Identifies the primary key from the database. |
| A list of open pull requests matching the check suite. Arguments
|
| The push that triggered this check suite. |
| The repository associated with this check suite. |
| The HTTP path for this check suite. |
| The status of this check suite. |
| Identifies the date and time when the object was last updated. |
| The HTTP URL for this check suite. |
| The workflow run associated with this check suite. |
CheckSuiteConnection
The connection type for CheckSuite.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
CheckSuiteEdge
An edge in a connection.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
ClosedEvent
Represents aclosed
event on any Closable
.
Implements
Fields
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Object that was closed. |
| Object which triggered the creation of this event. |
| Identifies the date and time when the object was created. |
| The HTTP path for this closed event. |
| The HTTP URL for this closed event. |
CommentDeletedEvent
Represents acomment_deleted
event on a given issue or pull request.
Commit
Represents a Git commit.
Implements
Fields
Name | Description |
---|---|
| An abbreviated version of the Git object ID. |
| The number of additions in this commit. |
| The merged Pull Request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open Pull Requests associated with the commit. Arguments
|
| Authorship details of the commit. |
| Check if the committer and the author match. |
| The datetime when this commit was authored. |
| The list of authors for this commit based on the git author and the Co-authored-by message trailer. The git author will always be first. |
| Fetches Arguments
|
| The number of changed files in this commit. |
| The check suites associated with a commit. Arguments
|
| Comments made on the commit. |
| The HTTP path for this Git object. |
| The HTTP URL for this Git object. |
| The datetime when this commit was committed. |
| Check if committed via GitHub web UI. |
| Committer details of the commit. |
| The number of deletions in this commit. |
| The deployments associated with a commit. Arguments
|
| The tree entry representing the file located at the given path. Arguments
|
| The linear commit history starting from (and including) this commit, in the same order as Arguments
|
| The Git commit message. |
| The Git commit message body. |
| The commit message body rendered to HTML. |
| The Git commit message headline. |
| The commit message headline rendered to HTML. |
| The Git object ID. |
| The organization this commit was made on behalf of. |
| The parents of a commit. |
| The datetime when this commit was pushed. |
| The Repository this commit belongs to. |
| The HTTP path for this commit. |
| Commit signing information, if present. |
| Status information for this commit. |
| Check and Status rollup information for this commit. |
| Returns a list of all submodules in this repository as of this Commit parsed from the .gitmodules file. |
| Returns a URL to download a tarball archive for a repository. Note: For private repositories, these links are temporary and expire after five minutes. |
| Commit's root Tree. |
| The HTTP path for the tree of this commit. |
| The HTTP URL for the tree of this commit. |
| The HTTP URL for this commit. |
| Check if the viewer is able to change their subscription status for the repository. |
| Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. |
| Returns a URL to download a zipball archive for a repository. Note: For private repositories, these links are temporary and expire after five minutes. |
CommitComment
Represents a comment on a given Commit.
Implements
Fields
Name | Description |
---|---|
| The actor who authored the comment. |
| Author's association with the subject of the comment. |
| Identifies the comment body. |
| The body rendered to HTML. |
| The body rendered to text. |
| Identifies the commit associated with the comment, if the commit exists. |
| Identifies the date and time when the object was created. |
| Check if this comment was created via an email reply. |
| Identifies the primary key from the database. |
| The actor who edited the comment. |
| Check if this comment was edited and includes an edit with the creation data. |
| Returns whether or not a comment has been minimized. |
| The moment the editor made the last edit. |
| Returns why the comment was minimized. |
| Identifies the file path associated with the comment. |
| Identifies the line position associated with the comment. |
| Identifies when the comment was published at. |
| A list of reactions grouped by content left on the subject. |
| A list of Reactions left on the Issue. Arguments
|
| The repository associated with this node. |
| The HTTP path permalink for this commit comment. |
| Identifies the date and time when the object was last updated. |
| The HTTP URL permalink for this commit comment. |
| A list of edits to this content. |
| Check if the current viewer can delete this object. |
| Check if the current viewer can minimize this object. |
| Can user react to this subject. |
| Check if the current viewer can update this object. |
| Reasons why the current viewer can not update this comment. |
| Did the viewer author this comment. |
CommitCommentConnection
The connection type for CommitComment.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
CommitCommentEdge
An edge in a connection.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
CommitCommentThread
A thread of comments on a commit.
Implements
Fields
Name | Description |
---|---|
| The comments that exist in this thread. |
| The commit the comments were made on. |
| The file the comments were made on. |
| The position in the diff for the commit that the comment was made on. |
| The repository associated with this node. |
CommitConnection
The connection type for Commit.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
CommitContributionsByRepository
This aggregates commits made by a user within one repository.
Fields
Name | Description |
---|---|
| The commit contributions, each representing a day. Arguments
|
| The repository in which the commits were made. |
| The HTTP path for the user's commits to the repository in this time range. |
| The HTTP URL for the user's commits to the repository in this time range. |
CommitHistoryConnection
The connection type for Commit.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
ConnectedEvent
Represents aconnected
event on a given issue or pull request.
Implements
Fields
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| Reference originated in a different repository. |
| Issue or pull request that made the reference. |
| Issue or pull request which was connected. |
ContentAttachment
A content attachment.
Fields
Name | Description |
---|---|
| The body text of the content attachment. This parameter supports markdown. |
| The content reference that the content attachment is attached to. |
| Identifies the primary key from the database. |
| The title of the content attachment. |
ContributionCalendar
A calendar of contributions made on GitHub by a user.
Fields
Name | Description |
---|---|
| A list of hex color codes used in this calendar. The darker the color, the more contributions it represents. |
| Determine if the color set was chosen because it's currently Halloween. |
| A list of the months of contributions in this calendar. |
| The count of total contributions in the calendar. |
| A list of the weeks of contributions in this calendar. |
ContributionCalendarDay
Represents a single day of contributions on GitHub by a user.
Fields
Name | Description |
---|---|
| The hex color code that represents how many contributions were made on this day compared to others in the calendar. |
| How many contributions were made by the user on this day. |
| Indication of contributions, relative to other days. Can be used to indicate which color to represent this day on a calendar. |
| The day this square represents. |
| A number representing which day of the week this square represents, e.g., 1 is Monday. |
ContributionCalendarWeek
A week of contributions in a user's contribution graph.
Fields
Name | Description |
---|---|
| The days of contributions in this week. |
| The date of the earliest square in this week. |
ContributionsCollection
A contributions collection aggregates contributions such as opened issues and commits created by a user.
Fields
Name | Description |
---|---|
| Commit contributions made by the user, grouped by repository. Arguments
|
| A calendar of this user's contributions on GitHub. |
| The years the user has been making contributions with the most recent year first. |
| Determine if this collection's time span ends in the current month. |
| The date of the first restricted contribution the user made in this time period. Can only be non-null when the user has enabled private contribution counts. |
| The ending date and time of this collection. |
| The first issue the user opened on GitHub. This will be null if that issue was opened outside the collection's time range and ignoreTimeRange is false. If the issue is not visible but the user has opted to show private contributions, a RestrictedContribution will be returned. |
| The first pull request the user opened on GitHub. This will be null if that pull request was opened outside the collection's time range and ignoreTimeRange is not true. If the pull request is not visible but the user has opted to show private contributions, a RestrictedContribution will be returned. |
| The first repository the user created on GitHub. This will be null if that first repository was created outside the collection's time range and ignoreTimeRange is false. If the repository is not visible, then a RestrictedContribution is returned. |
| Does the user have any more activity in the timeline that occurred prior to the collection's time range?. |
| Determine if there are any contributions in this collection. |
| Determine if the user made any contributions in this time frame whose details are not visible because they were made in a private repository. Can only be true if the user enabled private contribution counts. |
| Whether or not the collector's time span is all within the same day. |
| A list of issues the user opened. Arguments
|
| Issue contributions made by the user, grouped by repository. Arguments
|
| When the user signed up for GitHub. This will be null if that sign up date falls outside the collection's time range and ignoreTimeRange is false. |
| The date of the most recent restricted contribution the user made in this time period. Can only be non-null when the user has enabled private contribution counts. |
| When this collection's time range does not include any activity from the user, use this to get a different collection from an earlier time range that does have activity. |
| Returns a different contributions collection from an earlier time range than this one that does not have any contributions. |
| The issue the user opened on GitHub that received the most comments in the specified time frame. |
| The pull request the user opened on GitHub that received the most comments in the specified time frame. |
| Pull request contributions made by the user. Arguments
|
| Pull request contributions made by the user, grouped by repository. Arguments
|
| Pull request review contributions made by the user. Arguments
|
| Pull request review contributions made by the user, grouped by repository. Arguments
|
| A list of repositories owned by the user that the user created in this time range. Arguments
|
| A count of contributions made by the user that the viewer cannot access. Only non-zero when the user has chosen to share their private contribution counts. |
| The beginning date and time of this collection. |
| How many commits were made by the user in this time span. |
| How many issues the user opened. |
| How many pull requests the user opened. |
| How many pull request reviews the user left. |
| How many different repositories the user committed to. |
| How many different repositories the user opened issues in. |
| How many different repositories the user left pull request reviews in. |
| How many different repositories the user opened pull requests in. |
| How many repositories the user created. Arguments
|
| The user who made the contributions in this collection. |
ConvertToDraftEvent
Represents aconvert_to_draft
event on a given pull request.
Implements
Fields
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| PullRequest referenced by event. |
| The HTTP path for this convert to draft event. |
| The HTTP URL for this convert to draft event. |
ConvertedNoteToIssueEvent
Represents aconverted_note_to_issue
event on a given issue or pull request.
Implements
Fields
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| Project referenced by event. Preview notice
|
| Project card referenced by this project event. Preview notice
|
| Column name referenced by this project event. Preview notice
|
CreatedCommitContribution
Represents the contribution a user made by committing to a repository.
Implements
Fields
Name | Description |
---|---|
| How many commits were made on this day to this repository by the user. |
| Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access. |
| When this contribution was made. |
| The repository the user made a commit in. |
| The HTTP path for this contribution. |
| The HTTP URL for this contribution. |
| The user who made this contribution. |
CreatedCommitContributionConnection
The connection type for CreatedCommitContribution.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of commits across days and repositories in the connection. |
CreatedCommitContributionEdge
An edge in a connection.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
CreatedIssueContribution
Represents the contribution a user made on GitHub by opening an issue.
Implements
Fields
Name | Description |
---|---|
| Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access. |
| The issue that was opened. |
| When this contribution was made. |
| The HTTP path for this contribution. |
| The HTTP URL for this contribution. |
| The user who made this contribution. |
CreatedIssueContributionConnection
The connection type for CreatedIssueContribution.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
CreatedIssueContributionEdge
An edge in a connection.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
CreatedPullRequestContribution
Represents the contribution a user made on GitHub by opening a pull request.
Implements
Fields
Name | Description |
---|---|
| Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access. |
| When this contribution was made. |
| The pull request that was opened. |
| The HTTP path for this contribution. |
| The HTTP URL for this contribution. |
| The user who made this contribution. |
CreatedPullRequestContributionConnection
The connection type for CreatedPullRequestContribution.
Fields
Name | Description |
---|---|
A list of edges. | |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
CreatedPullRequestContributionEdge
An edge in a connection.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
The item at the end of the edge. |
CreatedPullRequestReviewContribution
Represents the contribution a user made by leaving a review on a pull request.
Implements
Fields
Name | Description |
---|---|
| Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access. |
| When this contribution was made. |
| The pull request the user reviewed. |
| The review the user left on the pull request. |
| The repository containing the pull request that the user reviewed. |
| The HTTP path for this contribution. |
| The HTTP URL for this contribution. |
| The user who made this contribution. |
CreatedPullRequestReviewContributionConnection
The connection type for CreatedPullRequestReviewContribution.
CreatedPullRequestReviewContributionEdge
An edge in a connection.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
The item at the end of the edge. |
CreatedRepositoryContribution
Represents the contribution a user made on GitHub by creating a repository.
Implements
Fields
Name | Description |
---|---|
| Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access. |
| When this contribution was made. |
| The repository that was created. |
| The HTTP path for this contribution. |
| The HTTP URL for this contribution. |
| The user who made this contribution. |
CreatedRepositoryContributionConnection
The connection type for CreatedRepositoryContribution.
Fields
Name | Description |
---|---|
A list of edges. | |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
CreatedRepositoryContributionEdge
An edge in a connection.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
The item at the end of the edge. |
CrossReferencedEvent
Represents a mention made by one issue or pull request to another.
Implements
Fields
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| Reference originated in a different repository. |
| Identifies when the reference was made. |
| The HTTP path for this pull request. |
| Issue or pull request that made the reference. |
| Issue or pull request to which the reference was made. |
| The HTTP URL for this pull request. |
| Checks if the target will be closed when the source is merged. |
DemilestonedEvent
Represents ademilestoned
event on a given issue or pull request.
Implements
Fields
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| Identifies the milestone title associated with the |
| Object referenced by event. |
DeployKey
A repository deploy key.
Implements
Fields
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
| The deploy key. |
| Whether or not the deploy key is read only. |
| The deploy key title. |
| Whether or not the deploy key has been verified. |
DeployKeyConnection
The connection type for DeployKey.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
DeployedEvent
Represents adeployed
event on a given pull request.
Implements
Fields
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| The deployment associated with the |
| PullRequest referenced by event. |
| The ref associated with the |
Deployment
Represents triggered deployment instance.
Implements
Fields
Name | Description |
---|---|
| Identifies the commit sha of the deployment. |
| Identifies the oid of the deployment commit, even if the commit has been deleted. |
| Identifies the date and time when the object was created. |
| Identifies the actor who triggered the deployment. |
| Identifies the primary key from the database. |
| The deployment description. |
| The latest environment to which this deployment was made. |
| The latest environment to which this deployment was made. |
| The latest status of this deployment. |
| The original environment to which this deployment was made. |
| Extra information that a deployment system might need. |
| Identifies the Ref of the deployment, if the deployment was created by ref. |
| Identifies the repository associated with the deployment. |
| The current state of the deployment. |
| A list of statuses associated with the deployment. |
| The deployment task. |
| Identifies the date and time when the object was last updated. |
DeploymentConnection
The connection type for Deployment.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
DeploymentEdge
An edge in a connection.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
DeploymentEnvironmentChangedEvent
Represents adeployment_environment_changed
event on a given pull request.
Implements
Fields
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The deployment status that updated the deployment environment. |
| PullRequest referenced by event. |
DeploymentProtectionRule
A protection rule.
Implements
Fields
Name | Description |
---|---|
| Identifies the primary key from the database. |
| The teams or users that can review the deployment. |
| The timeout in minutes for this protection rule. |
The type of protection rule. |
DeploymentProtectionRuleConnection
The connection type for DeploymentProtectionRule.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
DeploymentProtectionRuleEdge
An edge in a connection.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
DeploymentRequest
A request to deploy a workflow run to an environment.
Fields
Name | Description |
---|---|
| Whether or not the current user can approve the deployment. |
| The target environment of the deployment. |
| The teams or users that can review the deployment. |
| The wait timer in minutes configured in the environment. |
| The wait timer in minutes configured in the environment. |
DeploymentRequestConnection
The connection type for DeploymentRequest.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
DeploymentRequestEdge
An edge in a connection.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
DeploymentReview
A deployment review.
Implements
Fields
Name | Description |
---|---|
| The comment the user left. |
| Identifies the primary key from the database. |
| The environments approved or rejected. |
| The decision of the user. |
| The user that reviewed the deployment. |
DeploymentReviewConnection
The connection type for DeploymentReview.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
DeploymentReviewEdge
An edge in a connection.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
DeploymentReviewerConnection
The connection type for DeploymentReviewer.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
DeploymentReviewerEdge
An edge in a connection.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
DeploymentStatus
Describes the status of a given deployment attempt.
Implements
Fields
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
| Identifies the actor who triggered the deployment. |
| Identifies the deployment associated with status. |
| Identifies the description of the deployment. |
| Identifies the environment of the deployment at the time of this deployment status. Preview notice
|
| Identifies the environment URL of the deployment. |
| Identifies the log URL of the deployment. |
| Identifies the current state of the deployment. |
| Identifies the date and time when the object was last updated. |
DeploymentStatusConnection
The connection type for DeploymentStatus.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
DeploymentStatusEdge
An edge in a connection.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
DisconnectedEvent
Represents adisconnected
event on a given issue or pull request.
Implements
Fields
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| Reference originated in a different repository. |
| Issue or pull request from which the issue was disconnected. |
| Issue or pull request which was disconnected. |
Discussion
A discussion in a repository.
Implements
Fields
Name | Description |
---|---|
| Reason that the conversation was locked. |
| The comment chosen as this discussion's answer, if any. |
| The time when a user chose this discussion's answer, if answered. |
| The user who chose this discussion's answer, if answered. |
| The actor who authored the comment. |
| Author's association with the subject of the comment. |
| The main text of the discussion post. |
| The body rendered to HTML. |
| The body rendered to text. |
| The category for this discussion. |
| The replies to the discussion. |
| Identifies the date and time when the object was created. |
| Check if this comment was created via an email reply. |
| Identifies the primary key from the database. |
| The actor who edited the comment. |
| Check if this comment was edited and includes an edit with the creation data. |
| A list of labels associated with the object. Arguments
|
| The moment the editor made the last edit. |
|
|
| The number identifying this discussion within the repository. |
| Identifies when the comment was published at. |
| A list of reactions grouped by content left on the subject. |
| A list of Reactions left on the Issue. Arguments
|
| The repository associated with this node. |
| The path for this discussion. |
| The title of this discussion. |
| Identifies the date and time when the object was last updated. |
| Number of upvotes that this subject has received. |
| The URL for this discussion. |
| A list of edits to this content. |
| Check if the current viewer can delete this object. |
| Can user react to this subject. |
| Check if the viewer is able to change their subscription status for the repository. |
| Check if the current viewer can update this object. |
| Whether or not the current user can add or remove an upvote on this subject. |
| Did the viewer author this comment. |
| Whether or not the current user has already upvoted this subject. |
| Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. |
DiscussionCategory
A category for discussions in a repository.
Implements
Fields
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
| A description of this category. |
| An emoji representing this category. |
| This category's emoji rendered as HTML. |
| Whether or not discussions in this category support choosing an answer with the markDiscussionCommentAsAnswer mutation. |
| The name of this category. |
| The repository associated with this node. |
| Identifies the date and time when the object was last updated. |
DiscussionCategoryConnection
The connection type for DiscussionCategory.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
DiscussionCategoryEdge
An edge in a connection.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
DiscussionComment
A comment on a discussion.
Implements
Fields
Name | Description |
---|---|
| The actor who authored the comment. |
| Author's association with the subject of the comment. |
| The body as Markdown. |
| The body rendered to HTML. |
| The body rendered to text. |
| Identifies the date and time when the object was created. |
| Check if this comment was created via an email reply. |
| Identifies the primary key from the database. |
| The time when this replied-to comment was deleted. |
| The discussion this comment was created in. |
| The actor who edited the comment. |
| Check if this comment was edited and includes an edit with the creation data. |
| Has this comment been chosen as the answer of its discussion?. |
| Returns whether or not a comment has been minimized. |
| The moment the editor made the last edit. |
| Returns why the comment was minimized. |
| Identifies when the comment was published at. |
| A list of reactions grouped by content left on the subject. |
| A list of Reactions left on the Issue. Arguments
|
| The threaded replies to this comment. |
| The discussion comment this comment is a reply to. |
| The path for this discussion comment. |
| Identifies the date and time when the object was last updated. |
| Number of upvotes that this subject has received. |
| The URL for this discussion comment. |
| A list of edits to this content. |
| Check if the current viewer can delete this object. |
| Can the current user mark this comment as an answer?. |
| Check if the current viewer can minimize this object. |
| Can user react to this subject. |
| Can the current user unmark this comment as an answer?. |
| Check if the current viewer can update this object. |
| Whether or not the current user can add or remove an upvote on this subject. |
| Reasons why the current viewer can not update this comment. |
| Did the viewer author this comment. |
| Whether or not the current user has already upvoted this subject. |
DiscussionCommentConnection
The connection type for DiscussionComment.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
DiscussionCommentEdge
An edge in a connection.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
DiscussionConnection
The connection type for Discussion.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
DiscussionEdge
An edge in a connection.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
Enterprise
An account to manage multiple organizations with consolidated policy and billing.
Implements
Fields
Name | Description |
---|---|
| A URL pointing to the enterprise's public avatar. Arguments
|
| Enterprise billing information� visible to enterprise billing managers. |
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| The description of the enterprise. |
| The description of the enterprise as HTML. |
| The location of the enterprise. |
| A list of users who are members of this enterprise. Arguments
|
| The name of the enterprise. |
| A list of organizations that belong to this enterprise. Arguments
|
| Enterprise information only visible to enterprise owners. |
| The HTTP path for this enterprise. |
| The URL-friendly identifier for the enterprise. |
| The HTTP URL for this enterprise. |
| A list of user accounts on this enterprise. |
| Is the current viewer an admin of this enterprise?. |
| The URL of the enterprise website. |
EnterpriseAdministratorConnection
The connection type for User.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
EnterpriseAdministratorEdge
A User who is an administrator of an enterprise.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
| The role of the administrator. |
EnterpriseAdministratorInvitation
An invitation for a user to become an owner or billing manager of an enterprise.
Implements
Fields
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
| The email of the person who was invited to the enterprise. |
| The enterprise the invitation is for. |
| The user who was invited to the enterprise. |
| The user who created the invitation. |
| The invitee's pending role in the enterprise (owner or billing_manager). |
EnterpriseAdministratorInvitationConnection
The connection type for EnterpriseAdministratorInvitation.
EnterpriseAdministratorInvitationEdge
An edge in a connection.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
The item at the end of the edge. |
EnterpriseBillingInfo
Enterprise billing information visible to enterprise billing managers and owners.
Fields
Name | Description |
---|---|
| The number of licenseable users/emails across the enterprise. |
| The number of data packs used by all organizations owned by the enterprise. |
| The number of available seats across all owned organizations based on the unique number of billable users. Deprecation notice
|
| The bandwidth quota in GB for all organizations owned by the enterprise. |
| The bandwidth usage in GB for all organizations owned by the enterprise. |
| The bandwidth usage as a percentage of the bandwidth quota. |
| The total seats across all organizations owned by the enterprise. Deprecation notice
|
| The storage quota in GB for all organizations owned by the enterprise. |
| The storage usage in GB for all organizations owned by the enterprise. |
| The storage usage as a percentage of the storage quota. |
| The number of available licenses across all owned organizations based on the unique number of billable users. |
| The total number of licenses allocated. |
EnterpriseIdentityProvider
An identity provider configured to provision identities for an enterprise.
Implements
Fields
Name | Description |
---|---|
| The digest algorithm used to sign SAML requests for the identity provider. |
| The enterprise this identity provider belongs to. |
| ExternalIdentities provisioned by this identity provider. Arguments
|
| The x509 certificate used by the identity provider to sign assertions and responses. |
| The Issuer Entity ID for the SAML identity provider. |
| Recovery codes that can be used by admins to access the enterprise if the identity provider is unavailable. |
| The signature algorithm used to sign SAML requests for the identity provider. |
| The URL endpoint for the identity provider's SAML SSO. |
EnterpriseMemberConnection
The connection type for EnterpriseMember.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
EnterpriseMemberEdge
A User who is a member of an enterprise through one or more organizations.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
| Whether the user does not have a license for the enterprise. Deprecation notice
All members consume a license Removal on 2021-01-01 UTC. |
| The item at the end of the edge. |
EnterpriseOrganizationMembershipConnection
The connection type for Organization.
Fields
Name | Description |
---|---|
A list of edges. | |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
EnterpriseOrganizationMembershipEdge
An enterprise organization that a user is a member of.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
The role of the user in the enterprise membership. |
EnterpriseOutsideCollaboratorConnection
The connection type for User.
EnterpriseOutsideCollaboratorEdge
A User who is an outside collaborator of an enterprise through one or more organizations.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
| Whether the outside collaborator does not have a license for the enterprise. Deprecation notice
All outside collaborators consume a license Removal on 2021-01-01 UTC. |
| The item at the end of the edge. |
| The enterprise organization repositories this user is a member of. Arguments
|
EnterpriseOwnerInfo
Enterprise information only visible to enterprise owners.
Fields
Name | Description |
---|---|
| A list of all of the administrators for this enterprise. Arguments
|
| A list of users in the enterprise who currently have two-factor authentication disabled. |
| Whether or not affiliated users with two-factor authentication disabled exist in the enterprise. |
| The setting value for whether private repository forking is enabled for repositories in organizations in this enterprise. |
| A list of enterprise organizations configured with the provided private repository forking setting value. Arguments
|
| The setting value for base repository permissions for organizations in this enterprise. |
| A list of enterprise organizations configured with the provided default repository permission. Arguments
|
| A list of domains owned by the enterprise. Arguments
|
| The setting value for whether the enterprise has an IP allow list enabled. |
| The IP addresses that are allowed to access resources owned by the enterprise. Arguments
|
| The setting value for whether the enterprise has IP allow list configuration for installed GitHub Apps enabled. |
| Whether or not the default repository permission is currently being updated. |
| Whether the two-factor authentication requirement is currently being enforced. |
| The setting value for whether organization members with admin permissions on a repository can change repository visibility. |
| A list of enterprise organizations configured with the provided can change repository visibility setting value. Arguments
|
| The setting value for whether members of organizations in the enterprise can create internal repositories. |
| The setting value for whether members of organizations in the enterprise can create private repositories. |
| The setting value for whether members of organizations in the enterprise can create public repositories. |
| The setting value for whether members of organizations in the enterprise can create repositories. |
| A list of enterprise organizations configured with the provided repository creation setting value. Arguments
|
| The setting value for whether members with admin permissions for repositories can delete issues. |
| A list of enterprise organizations configured with the provided members can delete issues setting value. Arguments
|
| The setting value for whether members with admin permissions for repositories can delete or transfer repositories. |
| A list of enterprise organizations configured with the provided members can delete repositories setting value. Arguments
|
| The setting value for whether members of organizations in the enterprise can invite outside collaborators. |
| A list of enterprise organizations configured with the provided members can invite collaborators setting value. Arguments
|
| Indicates whether members of this enterprise's organizations can purchase additional services for those organizations. |
| The setting value for whether members with admin permissions for repositories can update protected branches. |
| A list of enterprise organizations configured with the provided members can update protected branches setting value. Arguments
|
| The setting value for whether members can view dependency insights. |
| A list of enterprise organizations configured with the provided members can view dependency insights setting value. Arguments
|
| Indicates if email notification delivery for this enterprise is restricted to verified or approved domains. |
| The setting value for whether organization projects are enabled for organizations in this enterprise. |
| A list of enterprise organizations configured with the provided organization projects setting value. Arguments
|
| A list of outside collaborators across the repositories in the enterprise. Arguments
|
| A list of pending administrator invitations for the enterprise. Arguments
|
| A list of pending collaborator invitations across the repositories in the enterprise. Arguments
|
| A list of pending collaborators across the repositories in the enterprise. Deprecation notice
Repository invitations can now be associated with an email, not only an invitee. Use the Arguments
|
| A list of pending member invitations for organizations in the enterprise. Arguments
|
| The setting value for whether repository projects are enabled in this enterprise. |
| A list of enterprise organizations configured with the provided repository projects setting value. Arguments
|
| The SAML Identity Provider for the enterprise. |
| A list of enterprise organizations configured with the SAML single sign-on setting value. Arguments
|
| The setting value for whether team discussions are enabled for organizations in this enterprise. |
| A list of enterprise organizations configured with the provided team discussions setting value. Arguments
|
| The setting value for whether the enterprise requires two-factor authentication for its organizations and users. |
| A list of enterprise organizations configured with the two-factor authentication setting value. Arguments
|
EnterprisePendingCollaboratorConnection
The connection type for User.
EnterprisePendingCollaboratorEdge
A user with an invitation to be a collaborator on a repository owned by an organization in an enterprise.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
| Whether the invited collaborator does not have a license for the enterprise. Deprecation notice
All pending collaborators consume a license Removal on 2021-01-01 UTC. |
| The item at the end of the edge. |
| The enterprise organization repositories this user is a member of. Arguments
|
EnterprisePendingMemberInvitationConnection
The connection type for OrganizationInvitation.
Fields
Name | Description |
---|---|
A list of edges. | |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
| Identifies the total count of unique users in the connection. |
EnterprisePendingMemberInvitationEdge
An invitation to be a member in an enterprise organization.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
| Whether the invitation has a license for the enterprise. Deprecation notice
All pending members consume a license Removal on 2020-07-01 UTC. |
| The item at the end of the edge. |
EnterpriseRepositoryInfoConnection
The connection type for EnterpriseRepositoryInfo.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
EnterpriseRepositoryInfoEdge
An edge in a connection.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
EnterpriseServerInstallation
An Enterprise Server installation.
Implements
Fields
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
| The customer name to which the Enterprise Server installation belongs. |
| The host name of the Enterprise Server installation. |
| Whether or not the installation is connected to an Enterprise Server installation via GitHub Connect. |
| Identifies the date and time when the object was last updated. |
| User accounts on this Enterprise Server installation. Arguments
|
| User accounts uploads for the Enterprise Server installation. Arguments
|
EnterpriseServerUserAccount
A user account on an Enterprise Server installation.
Implements
Fields
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
User emails belonging to this user account. Arguments
| |
| The Enterprise Server installation on which this user account exists. |
| Whether the user account is a site administrator on the Enterprise Server installation. |
| The login of the user account on the Enterprise Server installation. |
| The profile name of the user account on the Enterprise Server installation. |
| The date and time when the user account was created on the Enterprise Server installation. |
| The ID of the user account on the Enterprise Server installation. |
| Identifies the date and time when the object was last updated. |
EnterpriseServerUserAccountConnection
The connection type for EnterpriseServerUserAccount.
Fields
Name | Description |
---|---|
A list of edges. | |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
EnterpriseServerUserAccountEdge
An edge in a connection.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
EnterpriseServerUserAccountEmail
An email belonging to a user account on an Enterprise Server installation.
Implements
Fields
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
| The email address. |
| Indicates whether this is the primary email of the associated user account. |
| Identifies the date and time when the object was last updated. |
| The user account to which the email belongs. |
EnterpriseServerUserAccountEmailConnection
The connection type for EnterpriseServerUserAccountEmail.
EnterpriseServerUserAccountEmailEdge
An edge in a connection.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
The item at the end of the edge. |
EnterpriseServerUserAccountsUpload
A user accounts upload from an Enterprise Server installation.
Implements
Fields
Name | Description |
---|---|
| Identifies the date and time when the object was created. |
| The enterprise to which this upload belongs. |
| The Enterprise Server installation for which this upload was generated. |
| The name of the file uploaded. |
| The synchronization state of the upload. |
| Identifies the date and time when the object was last updated. |
EnterpriseServerUserAccountsUploadConnection
The connection type for EnterpriseServerUserAccountsUpload.
EnterpriseServerUserAccountsUploadEdge
An edge in a connection.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
The item at the end of the edge. |
EnterpriseUserAccount
An account for a user who is an admin of an enterprise or a member of an enterprise through one or more organizations.
Implements
Fields
Name | Description |
---|---|
| A URL pointing to the enterprise user account's public avatar. Arguments
|
| Identifies the date and time when the object was created. |
| The enterprise in which this user account exists. |
| An identifier for the enterprise user account, a login or email address. |
| The name of the enterprise user account. |
| A list of enterprise organizations this user is a member of. Arguments
|
| The HTTP path for this user. |
| Identifies the date and time when the object was last updated. |
| The HTTP URL for this user. |
| The user within the enterprise. |
EnterpriseUserAccountConnection
The connection type for EnterpriseUserAccount.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
EnterpriseUserAccountEdge
An edge in a connection.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
Environment
An environment.
Implements
Fields
Name | Description |
---|---|
| Identifies the primary key from the database. |
| The name of the environment. |
| The protection rules defined for this environment. |
EnvironmentConnection
The connection type for Environment.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
EnvironmentEdge
An edge in a connection.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
ExternalIdentity
An external identity provisioned by SAML SSO or SCIM.
Implements
Fields
Name | Description |
---|---|
| The GUID for this identity. |
| Organization invitation for this SCIM-provisioned external identity. |
| SAML Identity attributes. |
| SCIM Identity attributes. |
| User linked to this external identity. Will be NULL if this identity has not been claimed by an organization member. |
ExternalIdentityConnection
The connection type for ExternalIdentity.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
ExternalIdentityEdge
An edge in a connection.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
ExternalIdentitySamlAttributes
SAML attributes for the External Identity.
Fields
Name | Description |
---|---|
| The emails associated with the SAML identity. |
| Family name of the SAML identity. |
| Given name of the SAML identity. |
| The groups linked to this identity in IDP. |
| The NameID of the SAML identity. |
| The userName of the SAML identity. |
ExternalIdentityScimAttributes
SCIM attributes for the External Identity.
Fields
Name | Description |
---|---|
| The emails associated with the SCIM identity. |
| Family name of the SCIM identity. |
| Given name of the SCIM identity. |
| The groups linked to this identity in IDP. |
| The userName of the SCIM identity. |
FollowerConnection
The connection type for User.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
FollowingConnection
The connection type for User.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
GenericHovercardContext
A generic hovercard context with a message and icon.
Gist
A Gist.
Implements
Fields
Name | Description |
---|---|
| A list of comments associated with the gist. |
| Identifies the date and time when the object was created. |
| The gist description. |
| The files in this gist. Arguments
|
| A list of forks associated with the gist. Arguments
|
| Identifies if the gist is a fork. |
| Whether the gist is public or not. |
| The gist name. |
| The gist owner. |
| Identifies when the gist was last pushed to. |
| The HTML path to this resource. |
| Returns a count of how many stargazers there are on this object. |
| A list of users who have starred this starrable. Arguments
|
| Identifies the date and time when the object was last updated. |
| The HTTP URL for this Gist. |
| Returns a boolean indicating whether the viewing user has starred this starrable. |
GistComment
Represents a comment on an Gist.
Implements
Fields
Name | Description |
---|---|
| The actor who authored the comment. |
| Author's association with the gist. |
| Identifies the comment body. |
| The body rendered to HTML. |
| The body rendered to text. |
| Identifies the date and time when the object was created. |
| Check if this comment was created via an email reply. |
| Identifies the primary key from the database. |
| The actor who edited the comment. |
| The associated gist. |
| Check if this comment was edited and includes an edit with the creation data. |
| Returns whether or not a comment has been minimized. |
| The moment the editor made the last edit. |
| Returns why the comment was minimized. |
| Identifies when the comment was published at. |
| Identifies the date and time when the object was last updated. |
| A list of edits to this content. |
| Check if the current viewer can delete this object. |
| Check if the current viewer can minimize this object. |
| Check if the current viewer can update this object. |
| Reasons why the current viewer can not update this comment. |
| Did the viewer author this comment. |
GistCommentConnection
The connection type for GistComment.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
GistCommentEdge
An edge in a connection.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
GistConnection
The connection type for Gist.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
GistFile
A file in a gist.
Fields
Name | Description |
---|---|
| The file name encoded to remove characters that are invalid in URL paths. |
| The gist file encoding. |
| The file extension from the file name. |
| Indicates if this file is an image. |
| Whether the file's contents were truncated. |
| The programming language this file is written in. |
| The gist file name. |
| The gist file size in bytes. |
| UTF8 text data or null if the file is binary. Arguments
|
GitActor
Represents an actor in a Git commit (ie. an author or committer).
Fields
Name | Description |
---|---|
| A URL pointing to the author's public avatar. Arguments
|
| The timestamp of the Git action (authoring or committing). |
| The email in the Git commit. |
| The name in the Git commit. |
| The GitHub user corresponding to the email field. Null if no such user exists. |
GitActorConnection
The connection type for GitActor.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
GitHubMetadata
Represents information about the GitHub instance.
Fields
Name | Description |
---|---|
| Returns a String that's a SHA of |
| Whether or not users are verified. |
GpgSignature
Represents a GPG signature on a Commit or Tag.
Implements
Fields
Name | Description |
---|---|
| Email used to sign this object. |
| True if the signature is valid and verified by GitHub. |
| Hex-encoded ID of the key that signed this object. |
| Payload for GPG signing object. Raw ODB object without the signature header. |
| ASCII-armored signature header from object. |
| GitHub user corresponding to the email signing this commit. |
| The state of this signature. |
| True if the signature was made with GitHub's signing key. |
HeadRefDeletedEvent
Represents ahead_ref_deleted
event on a given pull request.
Implements
Fields
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| Identifies the Ref associated with the |
| Identifies the name of the Ref associated with the |
| PullRequest referenced by event. |
HeadRefForcePushedEvent
Represents ahead_ref_force_pushed
event on a given pull request.
Implements
Fields
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the after commit SHA for the |
| Identifies the before commit SHA for the |
| Identifies the date and time when the object was created. |
| PullRequest referenced by event. |
| Identifies the fully qualified ref name for the |
HeadRefRestoredEvent
Represents ahead_ref_restored
event on a given pull request.
Implements
Fields
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| PullRequest referenced by event. |
Hovercard
Detail needed to display a hovercard for a user.
Fields
Name | Description |
---|---|
| Each of the contexts for this hovercard. |
IpAllowListEntry
An IP address or range of addresses that is allowed to access an owner's resources.
Implements
Fields
Name | Description |
---|---|
| A single IP address or range of IP addresses in CIDR notation. |
| Identifies the date and time when the object was created. |
| Whether the entry is currently active. |
| The name of the IP allow list entry. |
| The owner of the IP allow list entry. |
| Identifies the date and time when the object was last updated. |
IpAllowListEntryConnection
The connection type for IpAllowListEntry.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
IpAllowListEntryEdge
An edge in a connection.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
Issue
An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project.
Implements
Assignable
Closable
Comment
Labelable
Lockable
Node
Reactable
RepositoryNode
Subscribable
UniformResourceLocatable
Updatable
UpdatableComment
Fields
Name | Description |
---|---|
| Reason that the conversation was locked. |
| A list of Users assigned to this object. |
| The actor who authored the comment. |
| Author's association with the subject of the comment. |
| Identifies the body of the issue. |
| The body rendered to HTML. |
| The http path for this issue body. |
| Identifies the body of the issue rendered to text. |
| The http URL for this issue body. |
|
|
| Identifies the date and time when the object was closed. |
| A list of comments associated with the Issue. Arguments
|
| Identifies the date and time when the object was created. |
| Check if this comment was created via an email reply. |
| Identifies the primary key from the database. |
| The actor who edited the comment. |
| The hovercard information for this issue. Arguments
|
| Check if this comment was edited and includes an edit with the creation data. |
| Indicates whether or not this issue is currently pinned to the repository issues list. |
| Is this issue read by the viewer. |
| A list of labels associated with the object. Arguments
|
| The moment the editor made the last edit. |
|
|
| Identifies the milestone associated with the issue. |
| Identifies the issue number. |
| A list of Users that are participating in the Issue conversation. |
| List of project cards associated with this issue. Arguments
|
| Identifies when the comment was published at. |
| A list of reactions grouped by content left on the subject. |
| A list of Reactions left on the Issue. Arguments
|
| The repository associated with this node. |
| The HTTP path for this issue. |
| Identifies the state of the issue. |
| A list of events, comments, commits, etc. associated with the issue. Deprecation notice
Arguments
|
| A list of events, comments, commits, etc. associated with the issue. Arguments
|
| Identifies the issue title. |
| Identifies the issue title rendered to HTML. |
| Identifies the date and time when the object was last updated. |
| The HTTP URL for this issue. |
| A list of edits to this content. |
| Can user react to this subject. |
| Check if the viewer is able to change their subscription status for the repository. |
| Check if the current viewer can update this object. |
| Reasons why the current viewer can not update this comment. |
| Did the viewer author this comment. |
| Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. |
IssueComment
Represents a comment on an Issue.
Implements
Fields
Name | Description |
---|---|
| The actor who authored the comment. |
| Author's association with the subject of the comment. |
| The body as Markdown. |
| The body rendered to HTML. |
| The body rendered to text. |
| Identifies the date and time when the object was created. |
| Check if this comment was created via an email reply. |
| Identifies the primary key from the database. |
| The actor who edited the comment. |
| Check if this comment was edited and includes an edit with the creation data. |
| Returns whether or not a comment has been minimized. |
| Identifies the issue associated with the comment. |
| The moment the editor made the last edit. |
| Returns why the comment was minimized. |
| Identifies when the comment was published at. |
| Returns the pull request associated with the comment, if this comment was made on a pull request. |
| A list of reactions grouped by content left on the subject. |
| A list of Reactions left on the Issue. Arguments
|
| The repository associated with this node. |
| The HTTP path for this issue comment. |
| Identifies the date and time when the object was last updated. |
| The HTTP URL for this issue comment. |
| A list of edits to this content. |
| Check if the current viewer can delete this object. |
| Check if the current viewer can minimize this object. |
| Can user react to this subject. |
| Check if the current viewer can update this object. |
| Reasons why the current viewer can not update this comment. |
| Did the viewer author this comment. |
IssueCommentConnection
The connection type for IssueComment.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
IssueCommentEdge
An edge in a connection.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
IssueConnection
The connection type for Issue.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
IssueContributionsByRepository
This aggregates issues opened by a user within one repository.
Fields
Name | Description |
---|---|
| The issue contributions. Arguments
|
| The repository in which the issues were opened. |
IssueTimelineConnection
The connection type for IssueTimelineItem.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
IssueTimelineItemEdge
An edge in a connection.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
IssueTimelineItemsConnection
The connection type for IssueTimelineItems.
Fields
Name | Description |
---|---|
| A list of edges. |
| Identifies the count of items after applying |
| A list of nodes. |
| Identifies the count of items after applying |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
| Identifies the date and time when the timeline was last updated. |
IssueTimelineItemsEdge
An edge in a connection.
Fields
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
JoinedGitHubContribution
Represents a user signing up for a GitHub account.
Implements
Fields
Name | Description |
---|---|
| Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access. |
| When this contribution was made. |
| The HTTP path for this contribution. |
| The HTTP URL for this contribution. |
| The user who made this contribution. |
Label
A label for categorizing Issues, Pull Requests, Milestones, or Discussions with a given Repository.
Implements
Fields
Name | Description |
---|---|
| Identifies the label color. |
| Identifies the date and time when the label was created. |
| A brief description of this label. |
| Indicates whether or not this is a default label. |
| A list of issues associated with this label. Arguments
|
| Identifies the label name. |
| A list of pull requests associated with this label. Arguments
|
| The repository associated with this label. |
| The HTTP path for this label. |
| Identifies the date and time when the label was last updated. |
| The HTTP URL for this label. |
LabelConnection
The connection type for Label.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
LabeledEvent
Represents alabeled
event on a given issue or pull request.
Implements
Fields
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| Identifies the label associated with the |
| Identifies the |
LanguageConnection
A list of languages associated with the parent.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
| The total size in bytes of files written in that language. |
LanguageEdge
Represents the language of a repository.
Fields
Name | Description |
---|---|
| The number of bytes of code written in the language. |
License
A repository's open source license.
Implements
Fields
Name | Description |
---|---|
| The full text of the license. |
| The conditions set by the license. |
| A human-readable description of the license. |
| Whether the license should be featured. |
| Whether the license should be displayed in license pickers. |
| Instructions on how to implement the license. |
| The lowercased SPDX ID of the license. |
| The limitations set by the license. |
| The license full name specified by https://spdx.org/licenses. |
| Customary short name if applicable (e.g, GPLv3). |
| The permissions set by the license. |
| Whether the license is a pseudo-license placeholder (e.g., other, no-license). |
| Short identifier specified by https://spdx.org/licenses. |
| URL to the license on https://choosealicense.com. |
LockedEvent
Represents alocked
event on a given issue or pull request.
Implements
Fields
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| Reason that the conversation was locked (optional). |
| Object that was locked. |
Mannequin
A placeholder user for attribution of imported data on GitHub.
Implements
Fields
Name | Description |
---|---|
| A URL pointing to the GitHub App's public avatar. Arguments
|
| The user that has claimed the data attributed to this mannequin. |
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| The mannequin's email on the source instance. |
| The username of the actor. |
| The HTML path to this resource. |
| Identifies the date and time when the object was last updated. |
| The URL to this resource. |
MarkedAsDuplicateEvent
Represents amarked_as_duplicate
event on a given issue or pull request.
Implements
Fields
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| The authoritative issue or pull request which has been duplicated by another. |
| Identifies the date and time when the object was created. |
| The issue or pull request which has been marked as a duplicate of another. |
| Canonical and duplicate belong to different repositories. |
MembersCanDeleteReposClearAuditEntry
Audit log entry for a members_can_delete_repos.clear event.
Implements
Fields
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The HTTP path for this enterprise. |
| The slug of the enterprise. |
| The HTTP URL for this enterprise. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
MembersCanDeleteReposDisableAuditEntry
Audit log entry for a members_can_delete_repos.disable event.
Implements
Fields
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The HTTP path for this enterprise. |
| The slug of the enterprise. |
| The HTTP URL for this enterprise. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
MembersCanDeleteReposEnableAuditEntry
Audit log entry for a members_can_delete_repos.enable event.
Implements
Fields
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The HTTP path for this enterprise. |
| The slug of the enterprise. |
| The HTTP URL for this enterprise. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
MergedEvent
Represents amerged
event on a given pull request.
Implements
Fields
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the commit associated with the |
| Identifies the date and time when the object was created. |
| Identifies the Ref associated with the |
| Identifies the name of the Ref associated with the |
| PullRequest referenced by event. |
| The HTTP path for this merged event. |
| The HTTP URL for this merged event. |
Milestone
Represents a Milestone object on a given repository.
Implements
Fields
Name | Description |
---|---|
|
|
| Identifies the date and time when the object was closed. |
| Identifies the date and time when the object was created. |
| Identifies the actor who created the milestone. |
| Identifies the description of the milestone. |
| Identifies the due date of the milestone. |
| A list of issues associated with the milestone. Arguments
|
| Identifies the number of the milestone. |
| Identifies the percentage complete for the milestone. |
| A list of pull requests associated with the milestone. Arguments
|
| The repository associated with this milestone. |
| The HTTP path for this milestone. |
| Identifies the state of the milestone. |
| Identifies the title of the milestone. |
| Identifies the date and time when the object was last updated. |
| The HTTP URL for this milestone. |
MilestoneConnection
The connection type for Milestone.
Fields
Name | Description |
---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
MilestonedEvent
Represents amilestoned
event on a given issue or pull request.
Implements
Fields
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| Identifies the milestone title associated with the |
| Object referenced by event. |
MovedColumnsInProjectEvent
Represents amoved_columns_in_project
event on a given issue or pull request.
Implements
Fields
Name | Description |
---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| Column name the issue or pull request was moved from. Preview notice
|
| Project referenced by event. Preview notice
|
| Project card referenced by this project event. Preview notice
|
| Column name the issue or pull request was moved to. Preview notice
|
OauthApplicationCreateAuditEntry
Audit log entry for a oauth_application.create event.
Implements
Fields
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The application URL of the OAuth Application. |
| The callback URL of the OAuth Application. |
| The time the action was initiated. |
| The name of the OAuth Application. |
| The HTTP path for the OAuth Application. |
| The HTTP URL for the OAuth Application. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The rate limit of the OAuth Application. |
The state of the OAuth Application. | |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgAddBillingManagerAuditEntry
Audit log entry for a org.add_billing_manager.
Implements
Fields
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The email address used to invite a billing manager for the organization. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgAddMemberAuditEntry
Audit log entry for a org.add_member.
Implements
Fields
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The permission level of the member added to the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgBlockUserAuditEntry
Audit log entry for a org.block_user.
Implements
Fields
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The blocked user. |
| The username of the blocked user. |
| The HTTP path for the blocked user. |
| The HTTP URL for the blocked user. |
| The time the action was initiated. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgConfigDisableCollaboratorsOnlyAuditEntry
Audit log entry for a org.config.disable_collaborators_only event.
Implements
Fields
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgConfigEnableCollaboratorsOnlyAuditEntry
Audit log entry for a org.config.enable_collaborators_only event.
Implements
Fields
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgCreateAuditEntry
Audit log entry for a org.create event.
Implements
Fields
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The billing plan for the Organization. |
| The time the action was initiated. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgDisableOauthAppRestrictionsAuditEntry
Audit log entry for a org.disable_oauth_app_restrictions event.
Implements
Fields
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgDisableSamlAuditEntry
Audit log entry for a org.disable_saml event.
Implements
Fields
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The SAML provider's digest algorithm URL. |
| The SAML provider's issuer URL. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The SAML provider's signature algorithm URL. |
| The SAML provider's single sign-on URL. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgDisableTwoFactorRequirementAuditEntry
Audit log entry for a org.disable_two_factor_requirement event.
Implements
Fields
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgEnableOauthAppRestrictionsAuditEntry
Audit log entry for a org.enable_oauth_app_restrictions event.
Implements
Fields
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgEnableSamlAuditEntry
Audit log entry for a org.enable_saml event.
Implements
Fields
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The SAML provider's digest algorithm URL. |
| The SAML provider's issuer URL. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The SAML provider's signature algorithm URL. |
| The SAML provider's single sign-on URL. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgEnableTwoFactorRequirementAuditEntry
Audit log entry for a org.enable_two_factor_requirement event.
Implements
Fields
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgInviteMemberAuditEntry
Audit log entry for a org.invite_member event.
Implements
Fields
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The email address of the organization invitation. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The organization invitation. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgInviteToBusinessAuditEntry
Audit log entry for a org.invite_to_business event.
Implements
Fields
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The HTTP path for this enterprise. |
| The slug of the enterprise. |
| The HTTP URL for this enterprise. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgOauthAppAccessApprovedAuditEntry
Audit log entry for a org.oauth_app_access_approved event.
Implements
Fields
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The name of the OAuth Application. |
| The HTTP path for the OAuth Application. |
| The HTTP URL for the OAuth Application. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgOauthAppAccessDeniedAuditEntry
Audit log entry for a org.oauth_app_access_denied event.
Implements
Fields
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The name of the OAuth Application. |
| The HTTP path for the OAuth Application. |
| The HTTP URL for the OAuth Application. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgOauthAppAccessRequestedAuditEntry
Audit log entry for a org.oauth_app_access_requested event.
Implements
Fields
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The name of the OAuth Application. |
| The HTTP path for the OAuth Application. |
| The HTTP URL for the OAuth Application. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgRemoveBillingManagerAuditEntry
Audit log entry for a org.remove_billing_manager event.
Implements
Fields
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
The reason for the billing manager being removed. | |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgRemoveMemberAuditEntry
Audit log entry for a org.remove_member event.
Implements
Fields
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The types of membership the member has with the organization. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The reason for the member being removed. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgRemoveOutsideCollaboratorAuditEntry
Audit log entry for a org.remove_outside_collaborator event.
Implements
Fields
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The types of membership the outside collaborator has with the organization. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
The reason for the outside collaborator being removed from the Organization. | |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgRestoreMemberAuditEntry
Audit log entry for a org.restore_member event.
Implements
Fields
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The number of custom email routings for the restored member. |
| The number of issue assignments for the restored member. |
| Restored organization membership objects. |
| The number of restored memberships. |
| The number of repositories of the restored member. |
| The number of starred repositories for the restored member. |
| The number of watched repositories for the restored member. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgRestoreMemberMembershipOrganizationAuditEntryData
Metadata for an organization membership for org.restore_member actions.
Implements
Fields
Name | Description |
---|---|
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
OrgRestoreMemberMembershipRepositoryAuditEntryData
Metadata for a repository membership for org.restore_member actions.
Implements
Fields
Name | Description |
---|---|
| The repository associated with the action. |
| The name of the repository. |
| The HTTP path for the repository. |
| The HTTP URL for the repository. |
OrgRestoreMemberMembershipTeamAuditEntryData
Metadata for a team membership for org.restore_member actions.
OrgUnblockUserAuditEntry
Audit log entry for a org.unblock_user.
Implements
Fields
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The user being unblocked by the organization. |
| The username of the blocked user. |
| The HTTP path for the blocked user. |
| The HTTP URL for the blocked user. |
| The time the action was initiated. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgUpdateDefaultRepositoryPermissionAuditEntry
Audit log entry for a org.update_default_repository_permission.
Implements
Fields
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
| The HTTP URL for the actor. |
| The time the action was initiated. |
| The corresponding operation type for the action. |
| The Organization associated with the Audit Entry. |
| The name of the Organization. |
| The HTTP path for the organization. |
| The HTTP URL for the organization. |
| The new default repository permission level for the organization. |
| The former default repository permission level for the organization. |
| The user affected by the action. |
| For actions involving two users, the actor is the initiator and the user is the affected user. |
| The HTTP path for the user. |
| The HTTP URL for the user. |
OrgUpdateMemberAuditEntry
Audit log entry for a org.update_member event.
Implements
Fields
Name | Description |
---|---|
| The action name. |
| The user who initiated the action. |
| The IP address of the actor. |
| A readable representation of the actor's location. |
| The username of the user who initiated the action. |
| The HTTP path for the actor. |
|