ATTRIBUTE TYPE REFERS TO DESCRIPTION
installation_id number Installation ID
app_id number App ID
created_at number Created time of the App in Unix Timestamp format
repository_selection string Repository access selection
read_permissions list<string> Read permissions granted upon app installation
write_permissions list<string> Write permissions granted upon app installation
webhook_events list<string> Subscribe to webhook events upon app installation
app_name string App name
app_slug string App URL-friendly name
updated_at number Updated time of the App in Unix Timestamp format
admin_permissions list<string> Admin permissions granted upon app installation
ATTRIBUTE TYPE REFERS TO DESCRIPTION
ATTRIBUTE TYPE REFERS TO DESCRIPTION
ATTRIBUTE TYPE REFERS TO DESCRIPTION
bypass_force_push_allowances list<object> List of users, teams, or apps that are allowed to force push to this branch even when force pushes are restricted, as defined in 'Allow specified actors to bypass branch protections' setting.
 name string Display name of the actor who can bypass force push restrictions. ex: Manoj S
 id string Unique identifier of the actor in GitHub's system. ex: U_kgDOCu4R6w
 __typename string Type of actor that can bypass force push restrictions (User, Team, or App). ex: User
 login string Username or login identifier of the actor. ex: ns-manojs
restricts_review_dismissals boolean Indicates whether only specific people can dismiss pull request reviews, as defined in 'Restrict who can dismiss pull request reviews' setting. ex: True
org string GitHub organization that owns the repository where this branch protection rule is applied.
requires_approving_reviews boolean Indicates whether pull requests require a specified number of approving reviews before merging, as defined in 'Require pull request reviews before merging' setting. ex: True
required_approving_review_count number The number of approving reviews required before a pull request can be merged. GitHub allows between 1-6 required reviewers. ex: 4
dismisses_stale_reviews boolean Indicates whether new commits pushed to a branch automatically dismiss previous pull request reviews, as defined in 'Dismiss stale pull request approvals when new commits are pushed' setting. ex: True
creator_login string GitHub username of the user who created the branch protection rule. ex: ns-manojs
required_status_check_contexts list<string> List of status checks that must pass before allowing merges, specified in 'Status checks that are required' setting. ex: ['security-scan']
requires_linear_history boolean Indicates whether merging pull requests with merge commits is blocked, as defined in 'Require linear history' setting. When true, only squash and rebase merges are allowed. ex: True
allows_deletions boolean Indicates whether branch deletion is allowed, as defined in 'Allow deletions' setting. When false (the default), branch deletion is blocked. ex: True
rule_pattern string The branch name pattern that this rule applies to (e.g., 'main', 'develop', 'release/*'). Can use wildcards. ex: develop
requires_strict_status_checks boolean Indicates whether branches must be up to date with the base branch before merging, as defined in 'Require branches to be up to date before merging' setting. ex: True
requires_commit_signatures boolean Indicates whether all commits must be signed with GPG or S/MIME, as defined in 'Require signed commits' setting. ex: True
requires_deployments boolean Indicates whether successful deployments to specific environments are required before merging pull requests, as defined in 'Require deployments to succeed before merging' setting. ex: False
full_name string Unique identifier for this branch protection rule and repo combo in this org. ex: server-module-29__develop
id string Unique identifier for the branch protection rule in GitHub. Used for API operations and tracking. ex: BPR_kwDOOKjAzM4D00Zs
requires_status_checks boolean Indicates whether status checks are required before merging pull requests, as defined in 'Require status checks to pass before merging' setting. ex: True
requires_code_owner_reviews boolean Indicates whether approval is required from code owners when a pull request modifies code that has a designated owner, as defined in 'Require review from Code Owners' setting. ex: True
allows_force_pushes boolean Indicates whether force pushes are allowed on this branch, as defined in 'Allow force pushes' setting. When false (the default), force pushes are blocked. ex: True
requires_conversation_resolution boolean Indicates whether all conversations must be resolved before a pull request can be merged, as defined in 'Require conversation resolution before merging' setting. ex: True
lock_branch boolean Indicates whether the branch is locked, as defined in 'Lock branch' setting. When true, the branch is read-only and no changes can be made to it except by users with specific permissions. ex: False
repository_name string Repository Name of the repository to which this branch protection rule applies. ex: server-module-29
is_admin_enforced boolean Indicates whether repository administrators must follow all branch protection rules, as defined in 'Do not allow bypassing the above settings' option. When false, admins can bypass restrictions. ex: True
lock_allows_fetch_and_merge boolean When branch is locked, indicates whether users can fork the repository and fetch updates from the locked branch, as defined in 'Allow fork syncing' setting. ex: False
required_deployment_environments list<string> List of environments that must have successful deployments before merging is allowed, as specified in 'Required deployments' setting. ex: []
matching_refs list<string> List of branch names that match this branch protection rule pattern. ex: ['develop']
review_dismissal_allowances list<object> List of users, teams, or apps that are allowed to dismiss pull request reviews, as defined in 'Restrict who can dismiss pull request reviews' setting. Only relevant when review dismissal restrictions are enabled.
 __typename string Type of actor that can dismiss reviews (User, Team, or App). ex: User
 login string Username or login identifier of the actor who can dismiss reviews. ex: ns-dmaurya
 name string Display name of the actor who can dismiss reviews. ex: Deepika Maurya
 id string Unique identifier of the actor in GitHub's system. ex: U_kgDOBo_Qlg
database_id number Internal database identifier for the branch protection rule in GitHub's system. ex: 64783499
bypass_pull_request_allowances list<object> List of users, teams, or apps that can bypass pull request requirements when merging, as defined in 'Allow specified actors to bypass pull request requirements' setting.
 name string Display name of the actor who can bypass pull request requirements. ex: Manoj S
 id string Unique identifier of the actor in GitHub's system. ex: U_kgDOCu4R6w
 __typename string Type of actor that can bypass pull request requirements (User, Team, or App). ex: User
 login string Username or login identifier of the actor. ex: ns-manojs
repository_id string Unique identifier for the repository to which this branch protection rule applies. ex: R_kgDOPGYl5A
restricts_pushes boolean Indicates whether pushes to the branch are restricted to specific people, teams, or apps, as defined in 'Restrict who can push to matching branches' setting. ex: True
push_allowances list<object> List of users, teams, or apps that are allowed to push to this branch when 'Restrict who can push to matching branches' is enabled.
 name string Display name of the actor with push permission. ex: Manoj S
 id string Unique identifier of the actor in GitHub's system. ex: U_kgDOCu4R6w
 __typename string Type of actor that has push permission (User, Team, or App). ex: User
 login string Username or login identifier of the actor. ex: ns-manojs
ATTRIBUTE TYPE REFERS TO DESCRIPTION
ATTRIBUTE TYPE REFERS TO DESCRIPTION
connectedAppName string Name of the Connected Application.
riskScore number The risk score associated with the Connected Application.
appID string The unique identifier of Connected Application
riskLevel string The risk level associated with the Connected Application.
permissionsMetadata list<object> Metadata for each permission associated with the Connected Application.
 firstSeenTime number Timestamp when the permission was first seen.
 removedTime number Timestamp when the permission was removed (0 if not removed).
 riskScore number Risk score of the permission. Not present when riskLevel is Unknown.
 name string Name of the permission.
 riskLevel string Risk level of the permission.
ATTRIBUTE TYPE REFERS TO DESCRIPTION
companyHTML string The user's public profile company as HTML
isSiteAdmin boolean Whether or not this user is a site administrator
viewerCanChangePinnedItems boolean Can the viewer pin repositories and gists to the profile?
monthlyEstimatedSponsorsIncomeInCents number The estimated monthly GitHub Sponsors income for this user in cents (USD)
databaseId number Identifies the primary key from the database
bio string The user's public profile bio
isFollowingViewer boolean Whether or not this user is following the viewer
isSponsoringViewer boolean Whether or not the viewer is sponsored by this user/organization
viewerIsFollowing boolean Whether or not this user is followed by the viewer
followers object A list of users the given user is followed by
 totalCount number Identifies the total count of the users who follow the current user
email string The user's publicly visible profile email
company string The user's public profile company
isBountyHunter boolean Whether or not this user is a participant in the GitHub Security Bug Bounty
isViewer boolean Whether or not this user is the viewing user
role string The role this user has in the organization
pinnedItemsRemaining number Returns how many more items this profile owner can pin to their profile
pronouns string The user's profile pronouns
updatedAt string Identifies the date and time when the user was last updated
twitterUsername string The user's Twitter username
repositories object A list of repositories that the user owns
 totalCount number Identifies the total count of the public repositories owned by the user
isDeveloperProgramMember boolean Whether or not this user is a GitHub Developer Program member
isEmployee boolean Whether or not this user is a GitHub employee
viewerCanCreateProjects boolean Can the current viewer create new projects on this owner?
projectsUrl string The HTTP URL listing user's projects
viewerIsSponsoring boolean Whether or not the viewer is sponsoring this user
recentProjects object Recent projects that this user has modified in the context of the owner
 totalCount number Identifies the total count of recentProjects associated with the user
repositoriesContributedTo object A list of repositories that the user recently contributed to
 totalCount number Identifies the total count of pullRequests associated with the user
 totalDiskUsage number The total size in kilobytes of all repositories associated with the user
following object A list of users the given user is following
 totalCount number Identifies the total count of the users the current user is following
id string ID of the user
avatarUrl string A URL pointing to the user's public avatar
createdAt string Identifies the date and time when the user was created
bioHTML string The user's public profile bio as HTML
isGitHubStar boolean Whether or not this user is a member of the GitHub Stars Program
isHireable boolean Whether or not the user has marked themselves as for hire
viewerCanFollow boolean Whether or not the viewer is able to follow the user
anyPinnableItems boolean Determine if this repository owner has any items that can be pinned to their profile
hasSponsorsListing boolean Whether or not this user has a GitHub Sponsors listing
location string The user's public profile location
login string The username used to login
name string The user's public profile name
resourcePath string The HTTP path for this user resource
url string The HTTP URL for this user
status object The user's description of what they're currently doing
 message string A brief message describing what the user is doing
 expiresAt string If set, the status will not be shown after this date
 updatedAt string Identifies the date and time when the object was last updated
 indicatesLimitedAvailability boolean Whether this status indicates the user is not fully available on GitHub
 createdAt string Identifies the date and time when the status was created
isCampusExpert boolean Whether or not this user is a participant in the GitHub Campus Experts Program
viewerCanSponsor boolean Whether or not the viewer is able to sponsor this user/organization
canReceiveOrganizationEmailsWhenNotificationsRestricted boolean Could this user receive email notifications, if the organization had notification restrictions enabled?
estimatedNextSponsorsPayoutInCents number The estimated next GitHub Sponsors payout for this user/organization in cents (USD)
websiteUrl string A URL pointing to the user's public website/blog
pullRequests object A list of pull requests associated with this user
 totalCount number Identifies the total count of pullRequests associated with the user
ATTRIBUTE TYPE REFERS TO DESCRIPTION
ATTRIBUTE TYPE REFERS TO DESCRIPTION
name string Organization name
public_gists_count number Number of Public Gists for an organization
two_factor_requirement_enabled boolean Whether the organization requires 2FA for all users
has_inactive_admin_users boolean Whether the organization has inactive admin users
has_inactive_users boolean Whether the organization has inactive users
default_repository_permission string Default permission level members have for organization repositories. * read - can pull, but not push to or administer this repository. * write - can pull and push, but not administer this repository. * admin - can pull, push, and administer this repository. * none - no permissions granted by default. Default: read
ATTRIBUTE TYPE REFERS TO DESCRIPTION
ATTRIBUTE TYPE REFERS TO DESCRIPTION
allow_update_branch boolean Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
auto_merge_allowed boolean Whether or not Auto-merge can be enabled on pull requests in this repository.
description string The description of the repository.
disk_usage number The number of kilobytes this repository occupies on disk.
is_archived boolean Indicates if the repository is unmaintained.
merge_commit_message string How the default commit message will be generated when merging a pull request.
merge_commit_title string How the default commit title will be generated when merging a pull request.
pushed_at number The last time a commit was pushed to a repository, in Unix Timestamp format
branch_protection_rule_bypass_admin_user boolean Whether any branch protection rule bypasses an admin user
has_wiki_enabled boolean Indicates if the repository has wiki feature enabled.
is_mirror boolean Identifies if the repository is a mirror.
viewer_default_merge_method string The last used merge method by the viewer or the default for the repository.
viewer_has_starred boolean Returns a boolean indicating whether the viewing user has starred this starrable.
visibility string Indicates the repository's visibility level.
has_outside_collaborators boolean Returns true if this repository has external collaborators.
has_discussions_enabled boolean Indicates if the repository has the Discussions feature enabled.
is_empty boolean Returns whether or not this repository is empty.
web_commit_signoff_required boolean Whether contributors are required to sign off on web-based commits in this repository.
created_at number Repository's creation time in Unix Timestamp format
is_blank_issues_enabled boolean Returns true if blank issue creation is allowed.
is_locked boolean Indicates if the repository has been locked or not.
merge_commit_allowed boolean Whether or not PRs are merged with a merge commit on this repository.
stargazer_count number Returns a count of how many stargazers there are on this object.
name string Repository name
archived_at number Identifies the date and time when the repository was archived.
is_fork boolean Identifies if the repository is a fork.
lock_reason string The reason the repository has been locked.
is_disabled boolean Returns whether or not this repository disabled.
is_user_configuration_repository boolean Is this repository a user configuration repository?
squash_merge_allowed boolean Whether or not squash-merging is enabled on this repository.
default_branch object The Repository's default branch
 protection_rule object Branch protection rule
 requires_approving_reviews boolean Are approving reviews required to update matching branches.
 requires_status_checks boolean Are status checks required to update matching branches.
 dismisses_stale_reviews boolean Will new commits pushed to matching branches dismiss pull request review approvals.
 allow_force_pushes boolean Allow force pushing to the branch
 allow_deletions boolean Allow branch deletions
 required_approving_review_count number Number of approving reviews required to update matching branches.
 name string Branch name
 has_gitignore_file boolean Whether the default branch has a .gitignore file.
 has_codeowners_file boolean Whether the default branch has a CODEOWNERS file.
 has_license_file boolean Whether the default branch has a LICENSE file.
has_issues_enabled boolean Indicates if the repository has issues feature enabled.
uses_custom_open_graph_image boolean Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.
viewer_permission string The users permission level on the repository. Will return null if authenticated as an GitHub App.
delete_branch_on_merge boolean Whether or not branches are automatically deleted when merged in this repository.
interaction_ability object The interaction ability settings for this repository.
 expiresAt string The time the currently active limit expires.
 limit string The current limit that is enabled on this object.
 origin string The origin of the currently active interaction limit.
squash_merge_commit_title string How the default commit title will be generated when squash merging a pull request.
viewer_can_subscribe boolean Check if the viewer is able to change their subscription status for the repository.
private boolean Whether a repository is private or not
is_security_policy_enabled boolean Returns true if this repository has a security policy.
forking_allowed boolean Whether this repository allows forks.
squash_merge_commit_message string How the default commit message will be generated when squash merging a pull request.
has_vulnerability_alerts_enabled boolean Whether vulnerability alerts are enabled for the repository.
has_projects_enabled boolean Indicates if the repository has the Projects feature enabled.
full_name string Repository full name
is_template boolean Identifies if the repository is a template that can be used to generate new repositories.
owner object The User owner of the repository.
 id string The Node ID of the RepositoryOwner object.
 login string The username used to login.
parent object The repository parent, if this is a fork.
 name string The name of the repository.
 id string The Node ID of the Repository object.
is_in_organization boolean Indicates if a repository is either owned by an organization, or is a private fork of an organization repository.
primary_language object The primary language of the repository's code.
 color string The color defined for the current language.
 id string The Node ID of the Language object.
 name string The name of the current language.
viewer_can_update_topics boolean Indicates whether the viewer can update the topics of this repository.
viewer_subscription string Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
branch_protection_enabled_for_all_branches boolean Whether branch protection is enabled for all branches
secret_scanning_enabled boolean Whether secret scanning is enabled
template_repository object The repository from which this repository was generated, if any.
 id string The Node ID of the Repository object.
 name string The name of the repository.
viewer_can_administer boolean Indicates whether the viewer has admin permissions on this repository.
fork_count number The number of forks of this repository
viewer_can_create_projects boolean Can the current viewer create new projects on this owner.
rebase_merge_allowed boolean Whether or not rebase-merging is enabled on this repository.
ATTRIBUTE TYPE REFERS TO DESCRIPTION