Skip to main content

Enums

In this article

Enums represent possible sets of values for a field.

About enums

Enums represent possible sets of values for a field.

For example, the Issue object has a field called state. The state is an enum (specifically, of type IssueState) because it may be OPEN or CLOSED.

For more information, see "Introduction to GraphQL."

ActorType

The actor's type.

Values for ActorType

TEAM

Indicates a team actor.

USER

Indicates a user actor.

AuditLogOrderField

Properties by which Audit Log connections can be ordered.

Values for AuditLogOrderField

CREATED_AT

Order audit log entries by timestamp.

CheckAnnotationLevel

Represents an annotation's information level.

Values for CheckAnnotationLevel

FAILURE

An annotation indicating an inescapable error.

NOTICE

An annotation indicating some information.

WARNING

An annotation indicating an ignorable error.

CheckConclusionState

The possible states for a check suite or run conclusion.

Values for CheckConclusionState

ACTION_REQUIRED

The check suite or run requires action.

CANCELLED

The check suite or run has been cancelled.

FAILURE

The check suite or run has failed.

NEUTRAL

The check suite or run was neutral.

SKIPPED

The check suite or run was skipped.

STALE

The check suite or run was marked stale by GitHub. Only GitHub can use this conclusion.

STARTUP_FAILURE

The check suite or run has failed at startup.

SUCCESS

The check suite or run has succeeded.

TIMED_OUT

The check suite or run has timed out.

CheckRunState

The possible states of a check run in a status rollup.

Values for CheckRunState

ACTION_REQUIRED

The check run requires action.

CANCELLED

The check run has been cancelled.

COMPLETED

The check run has been completed.

FAILURE

The check run has failed.

IN_PROGRESS

The check run is in progress.

NEUTRAL

The check run was neutral.

PENDING

The check run is in pending state.

QUEUED

The check run has been queued.

SKIPPED

The check run was skipped.

STALE

The check run was marked stale by GitHub. Only GitHub can use this conclusion.

STARTUP_FAILURE

The check run has failed at startup.

SUCCESS

The check run has succeeded.

TIMED_OUT

The check run has timed out.

WAITING

The check run is in waiting state.

CheckRunType

The possible types of check runs.

Values for CheckRunType

ALL

Every check run available.

LATEST

The latest check run.

CheckStatusState

The possible states for a check suite or run status.

Values for CheckStatusState

COMPLETED

The check suite or run has been completed.

IN_PROGRESS

The check suite or run is in progress.

PENDING

The check suite or run is in pending state.

QUEUED

The check suite or run has been queued.

REQUESTED

The check suite or run has been requested.

WAITING

The check suite or run is in waiting state.

CollaboratorAffiliation

Collaborators affiliation level with a subject.

Values for CollaboratorAffiliation

ALL

All collaborators the authenticated user can see.

DIRECT

All collaborators with permissions to an organization-owned subject, regardless of organization membership status.

OUTSIDE

All outside collaborators of an organization-owned subject.

CommentAuthorAssociation

A comment author association with repository.

Values for CommentAuthorAssociation

COLLABORATOR

Author has been invited to collaborate on the repository.

CONTRIBUTOR

Author has previously committed to the repository.

FIRST_TIMER

Author has not previously committed to GitHub.

FIRST_TIME_CONTRIBUTOR

Author has not previously committed to the repository.

MANNEQUIN

Author is a placeholder for an unclaimed user.

MEMBER

Author is a member of the organization that owns the repository.

NONE

Author has no association with the repository.

OWNER

Author is the owner of the repository.

CommentCannotUpdateReason

The possible errors that will prevent a user from updating a comment.

Values for CommentCannotUpdateReason

ARCHIVED

Unable to create comment because repository is archived.

DENIED

You cannot update this comment.

INSUFFICIENT_ACCESS

You must be the author or have write access to this repository to update this comment.

LOCKED

Unable to create comment because issue is locked.

LOGIN_REQUIRED

You must be logged in to update this comment.

MAINTENANCE

Repository is under maintenance.

VERIFIED_EMAIL_REQUIRED

At least one email address must be verified to update this comment.

CommitContributionOrderField

Properties by which commit contribution connections can be ordered.

Values for CommitContributionOrderField

COMMIT_COUNT

Order commit contributions by how many commits they represent.

OCCURRED_AT

Order commit contributions by when they were made.

ComparisonStatus

The status of a git comparison between two refs.

Values for ComparisonStatus

AHEAD

The head ref is ahead of the base ref.

BEHIND

The head ref is behind the base ref.

DIVERGED

The head ref is both ahead and behind of the base ref, indicating git history has diverged.

IDENTICAL

The head ref and base ref are identical.

ContributionLevel

Varying levels of contributions from none to many.

Values for ContributionLevel

FIRST_QUARTILE

Lowest 25% of days of contributions.

FOURTH_QUARTILE

Highest 25% of days of contributions. More contributions than the third quartile.

NONE

No contributions occurred.

SECOND_QUARTILE

Second lowest 25% of days of contributions. More contributions than the first quartile.

THIRD_QUARTILE

Second highest 25% of days of contributions. More contributions than second quartile, less than the fourth quartile.

DefaultRepositoryPermissionField

The possible base permissions for repositories.

Values for DefaultRepositoryPermissionField

ADMIN

Can read, write, and administrate repos by default.

NONE

No access.

READ

Can read repos by default.

WRITE

Can read and write repos by default.

DependencyGraphEcosystem

The possible ecosystems of a dependency graph package.

Values for DependencyGraphEcosystem

ACTIONS

GitHub Actions.

COMPOSER

PHP packages hosted at packagist.org.

GO

Go modules.

MAVEN

Java artifacts hosted at the Maven central repository.

NPM

JavaScript packages hosted at npmjs.com.

NUGET

.NET packages hosted at the NuGet Gallery.

PIP

Python packages hosted at PyPI.org.

PUB

Dart packages hosted at pub.dev.

RUBYGEMS

Ruby gems hosted at RubyGems.org.

RUST

Rust crates.

SWIFT

Swift packages.

DeploymentOrderField

Properties by which deployment connections can be ordered.

Values for DeploymentOrderField

CREATED_AT

Order collection by creation time.

DeploymentProtectionRuleType

The possible protection rule types.

Values for DeploymentProtectionRuleType

REQUIRED_REVIEWERS

Required reviewers.

WAIT_TIMER

Wait timer.

DeploymentReviewState

The possible states for a deployment review.

Values for DeploymentReviewState

APPROVED

The deployment was approved.

REJECTED

The deployment was rejected.

DeploymentState

The possible states in which a deployment can be.

Values for DeploymentState

ABANDONED

The pending deployment was not updated after 30 minutes.

ACTIVE

The deployment is currently active.

DESTROYED

An inactive transient deployment.

ERROR

The deployment experienced an error.

FAILURE

The deployment has failed.

INACTIVE

The deployment is inactive.

IN_PROGRESS

The deployment is in progress.

PENDING

The deployment is pending.

QUEUED

The deployment has queued.

SUCCESS

The deployment was successful.

WAITING

The deployment is waiting.

DeploymentStatusState

The possible states for a deployment status.

Values for DeploymentStatusState

ERROR

The deployment experienced an error.

FAILURE

The deployment has failed.

INACTIVE

The deployment is inactive.

IN_PROGRESS

The deployment is in progress.

PENDING

The deployment is pending.

QUEUED

The deployment is queued.

SUCCESS

The deployment was successful.

WAITING

The deployment is waiting.

DiffSide

The possible sides of a diff.

Values for DiffSide

LEFT

The left side of the diff.

RIGHT

The right side of the diff.

DiscussionCloseReason

The possible reasons for closing a discussion.

Values for DiscussionCloseReason

DUPLICATE

The discussion is a duplicate of another.

OUTDATED

The discussion is no longer relevant.

RESOLVED

The discussion has been resolved.

DiscussionOrderField

Properties by which discussion connections can be ordered.

Values for DiscussionOrderField

CREATED_AT

Order discussions by creation time.

UPDATED_AT

Order discussions by most recent modification time.

DiscussionPollOptionOrderField

Properties by which discussion poll option connections can be ordered.

Values for DiscussionPollOptionOrderField

AUTHORED_ORDER

Order poll options by the order that the poll author specified when creating the poll.

VOTE_COUNT

Order poll options by the number of votes it has.

DiscussionState

The possible states of a discussion.

Values for DiscussionState

CLOSED

A discussion that has been closed.

OPEN

A discussion that is open.

DiscussionStateReason

The possible state reasons of a discussion.

Values for DiscussionStateReason

DUPLICATE

The discussion is a duplicate of another.

OUTDATED

The discussion is no longer relevant.

REOPENED

The discussion was reopened.

RESOLVED

The discussion has been resolved.

DismissReason

The possible reasons that a Dependabot alert was dismissed.

Values for DismissReason

FIX_STARTED

A fix has already been started.

INACCURATE

This alert is inaccurate or incorrect.

NOT_USED

Vulnerable code is not actually used.

NO_BANDWIDTH

No bandwidth to fix this.

TOLERABLE_RISK

Risk is tolerable to this project.

EnterpriseAdministratorInvitationOrderField

Properties by which enterprise administrator invitation connections can be ordered.

Values for EnterpriseAdministratorInvitationOrderField

CREATED_AT

Order enterprise administrator member invitations by creation time.

EnterpriseAdministratorRole

The possible administrator roles in an enterprise account.

Values for EnterpriseAdministratorRole

BILLING_MANAGER

Represents a billing manager of the enterprise account.

OWNER

Represents an owner of the enterprise account.

EnterpriseAllowPrivateRepositoryForkingPolicyValue

The possible values for the enterprise allow private repository forking policy value.

Values for EnterpriseAllowPrivateRepositoryForkingPolicyValue

ENTERPRISE_ORGANIZATIONS

Members can fork a repository to an organization within this enterprise.

ENTERPRISE_ORGANIZATIONS_USER_ACCOUNTS

Members can fork a repository to their enterprise-managed user account or an organization inside this enterprise.

EVERYWHERE

Members can fork a repository to their user account or an organization, either inside or outside of this enterprise.

SAME_ORGANIZATION

Members can fork a repository only within the same organization (intra-org).

SAME_ORGANIZATION_USER_ACCOUNTS

Members can fork a repository to their user account or within the same organization.

USER_ACCOUNTS

Members can fork a repository to their user account.

EnterpriseDefaultRepositoryPermissionSettingValue

The possible values for the enterprise base repository permission setting.

Values for EnterpriseDefaultRepositoryPermissionSettingValue

ADMIN

Organization members will be able to clone, pull, push, and add new collaborators to all organization repositories.

NONE

Organization members will only be able to clone and pull public repositories.

NO_POLICY

Organizations in the enterprise choose base repository permissions for their members.

READ

Organization members will be able to clone and pull all organization repositories.

WRITE

Organization members will be able to clone, pull, and push all organization repositories.

EnterpriseEnabledDisabledSettingValue

The possible values for an enabled/disabled enterprise setting.

Values for EnterpriseEnabledDisabledSettingValue

DISABLED

The setting is disabled for organizations in the enterprise.

ENABLED

The setting is enabled for organizations in the enterprise.

NO_POLICY

There is no policy set for organizations in the enterprise.

EnterpriseEnabledSettingValue

The possible values for an enabled/no policy enterprise setting.

Values for EnterpriseEnabledSettingValue

ENABLED

The setting is enabled for organizations in the enterprise.

NO_POLICY

There is no policy set for organizations in the enterprise.

EnterpriseMemberOrderField

Properties by which enterprise member connections can be ordered.

Values for EnterpriseMemberOrderField

CREATED_AT

Order enterprise members by creation time.

LOGIN

Order enterprise members by login.

EnterpriseMembersCanCreateRepositoriesSettingValue

The possible values for the enterprise members can create repositories setting.

Values for EnterpriseMembersCanCreateRepositoriesSettingValue

ALL

Members will be able to create public and private repositories.

DISABLED

Members will not be able to create public or private repositories.

NO_POLICY

Organization owners choose whether to allow members to create repositories.

PRIVATE

Members will be able to create only private repositories.

PUBLIC

Members will be able to create only public repositories.

EnterpriseMembersCanMakePurchasesSettingValue

The possible values for the members can make purchases setting.

Values for EnterpriseMembersCanMakePurchasesSettingValue

DISABLED

The setting is disabled for organizations in the enterprise.

ENABLED

The setting is enabled for organizations in the enterprise.

EnterpriseMembershipType

The possible values we have for filtering Platform::Objects::User#enterprises.

Values for EnterpriseMembershipType

ADMIN

Returns all enterprises in which the user is an admin.

ALL

Returns all enterprises in which the user is a member, admin, or billing manager.

BILLING_MANAGER

Returns all enterprises in which the user is a billing manager.

ORG_MEMBERSHIP

Returns all enterprises in which the user is a member of an org that is owned by the enterprise.

EnterpriseOrderField

Properties by which enterprise connections can be ordered.

Values for EnterpriseOrderField

NAME

Order enterprises by name.

EnterpriseServerInstallationOrderField

Properties by which Enterprise Server installation connections can be ordered.

Values for EnterpriseServerInstallationOrderField

CREATED_AT

Order Enterprise Server installations by creation time.

CUSTOMER_NAME

Order Enterprise Server installations by customer name.

HOST_NAME

Order Enterprise Server installations by host name.

EnterpriseServerUserAccountEmailOrderField

Properties by which Enterprise Server user account email connections can be ordered.

Values for EnterpriseServerUserAccountEmailOrderField

EMAIL

Order emails by email.

EnterpriseServerUserAccountOrderField

Properties by which Enterprise Server user account connections can be ordered.

Values for EnterpriseServerUserAccountOrderField

LOGIN

Order user accounts by login.

REMOTE_CREATED_AT

Order user accounts by creation time on the Enterprise Server installation.

EnterpriseServerUserAccountsUploadOrderField

Properties by which Enterprise Server user accounts upload connections can be ordered.

Values for EnterpriseServerUserAccountsUploadOrderField

CREATED_AT

Order user accounts uploads by creation time.

EnterpriseServerUserAccountsUploadSyncState

Synchronization state of the Enterprise Server user accounts upload.

Values for EnterpriseServerUserAccountsUploadSyncState

FAILURE

The synchronization of the upload failed.

PENDING

The synchronization of the upload is pending.

SUCCESS

The synchronization of the upload succeeded.

EnterpriseUserAccountMembershipRole

The possible roles for enterprise membership.

Values for EnterpriseUserAccountMembershipRole

MEMBER

The user is a member of an organization in the enterprise.

OWNER

The user is an owner of an organization in the enterprise.

UNAFFILIATED

The user is not an owner of the enterprise, and not a member or owner of any organizations in the enterprise; only for EMU-enabled enterprises.

EnterpriseUserDeployment

The possible GitHub Enterprise deployments where this user can exist.

Values for EnterpriseUserDeployment

CLOUD

The user is part of a GitHub Enterprise Cloud deployment.

SERVER

The user is part of a GitHub Enterprise Server deployment.

EnvironmentOrderField

Properties by which environments connections can be ordered.

Values for EnvironmentOrderField

NAME

Order environments by name.

FileViewedState

The possible viewed states of a file .

Values for FileViewedState

DISMISSED

The file has new changes since last viewed.

UNVIEWED

The file has not been marked as viewed.

VIEWED

The file has been marked as viewed.

FundingPlatform

The possible funding platforms for repository funding links.

Values for FundingPlatform

COMMUNITY_BRIDGE

Community Bridge funding platform.

CUSTOM

Custom funding platform.

GITHUB

GitHub funding platform.

ISSUEHUNT

IssueHunt funding platform.

KO_FI

Ko-fi funding platform.

LFX_CROWDFUNDING

LFX Crowdfunding funding platform.

LIBERAPAY

Liberapay funding platform.

OPEN_COLLECTIVE

Open Collective funding platform.

OTECHIE

Otechie funding platform.

PATREON

Patreon funding platform.

TIDELIFT

Tidelift funding platform.

GistOrderField

Properties by which gist connections can be ordered.

Values for GistOrderField

CREATED_AT

Order gists by creation time.

PUSHED_AT

Order gists by push time.

UPDATED_AT

Order gists by update time.

GistPrivacy

The privacy of a Gist.

Values for GistPrivacy

ALL

Gists that are public and secret.

PUBLIC

Public.

SECRET

Secret.

GitSignatureState

The state of a Git signature.

Values for GitSignatureState

BAD_CERT

The signing certificate or its chain could not be verified.

BAD_EMAIL

Invalid email used for signing.

EXPIRED_KEY

Signing key expired.

GPGVERIFY_ERROR

Internal error - the GPG verification service misbehaved.

GPGVERIFY_UNAVAILABLE

Internal error - the GPG verification service is unavailable at the moment.

INVALID

Invalid signature.

MALFORMED_SIG

Malformed signature.

NOT_SIGNING_KEY

The usage flags for the key that signed this don't allow signing.

NO_USER

Email used for signing not known to GitHub.

OCSP_ERROR

Valid signature, though certificate revocation check failed.

OCSP_PENDING

Valid signature, pending certificate revocation checking.

OCSP_REVOKED

One or more certificates in chain has been revoked.

UNKNOWN_KEY

Key used for signing not known to GitHub.

UNKNOWN_SIG_TYPE

Unknown signature type.

UNSIGNED

Unsigned.

UNVERIFIED_EMAIL

Email used for signing unverified on GitHub.

VALID

Valid signature and verified by GitHub.

IdentityProviderConfigurationState

The possible states in which authentication can be configured with an identity provider.

Values for IdentityProviderConfigurationState

CONFIGURED

Authentication with an identity provider is configured but not enforced.

ENFORCED

Authentication with an identity provider is configured and enforced.

UNCONFIGURED

Authentication with an identity provider is not configured.

IpAllowListEnabledSettingValue

The possible values for the IP allow list enabled setting.

Values for IpAllowListEnabledSettingValue

DISABLED

The setting is disabled for the owner.

ENABLED

The setting is enabled for the owner.

IpAllowListEntryOrderField

Properties by which IP allow list entry connections can be ordered.

Values for IpAllowListEntryOrderField

ALLOW_LIST_VALUE

Order IP allow list entries by the allow list value.

CREATED_AT

Order IP allow list entries by creation time.

IpAllowListForInstalledAppsEnabledSettingValue

The possible values for the IP allow list configuration for installed GitHub Apps setting.

Values for IpAllowListForInstalledAppsEnabledSettingValue

DISABLED

The setting is disabled for the owner.

ENABLED

The setting is enabled for the owner.

IssueClosedStateReason

The possible state reasons of a closed issue.

Values for IssueClosedStateReason

COMPLETED

An issue that has been closed as completed.

NOT_PLANNED

An issue that has been closed as not planned.

IssueCommentOrderField

Properties by which issue comment connections can be ordered.

Values for IssueCommentOrderField

UPDATED_AT

Order issue comments by update time.

IssueOrderField

Properties by which issue connections can be ordered.

Values for IssueOrderField

COMMENTS

Order issues by comment count.

CREATED_AT

Order issues by creation time.

UPDATED_AT

Order issues by update time.

IssueState

The possible states of an issue.

Values for IssueState

CLOSED

An issue that has been closed.

OPEN

An issue that is still open.

IssueStateReason

The possible state reasons of an issue.

Values for IssueStateReason

COMPLETED

An issue that has been closed as completed.

NOT_PLANNED

An issue that has been closed as not planned.

REOPENED

An issue that has been reopened.

IssueTimelineItemsItemType

The possible item types found in a timeline.

Values for IssueTimelineItemsItemType

ADDED_TO_PROJECT_EVENT

Represents aadded_to_projectevent on a given issue or pull request.

ASSIGNED_EVENT

Represents anassignedevent on any assignable object.

CLOSED_EVENT

Represents aclosedevent on any Closable.

COMMENT_DELETED_EVENT

Represents acomment_deletedevent on a given issue or pull request.

CONNECTED_EVENT

Represents aconnectedevent on a given issue or pull request.

CONVERTED_NOTE_TO_ISSUE_EVENT

Represents aconverted_note_to_issueevent on a given issue or pull request.

CONVERTED_TO_DISCUSSION_EVENT

Represents aconverted_to_discussionevent on a given issue.

CROSS_REFERENCED_EVENT

Represents a mention made by one issue or pull request to another.

DEMILESTONED_EVENT

Represents ademilestonedevent on a given issue or pull request.

DISCONNECTED_EVENT

Represents adisconnectedevent on a given issue or pull request.

ISSUE_COMMENT

Represents a comment on an Issue.

LABELED_EVENT

Represents alabeledevent on a given issue or pull request.

LOCKED_EVENT

Represents alockedevent on a given issue or pull request.

MARKED_AS_DUPLICATE_EVENT

Represents amarked_as_duplicateevent on a given issue or pull request.

MENTIONED_EVENT

Represents amentionedevent on a given issue or pull request.

MILESTONED_EVENT

Represents amilestonedevent on a given issue or pull request.

MOVED_COLUMNS_IN_PROJECT_EVENT

Represents amoved_columns_in_projectevent on a given issue or pull request.

PINNED_EVENT

Represents apinnedevent on a given issue or pull request.

REFERENCED_EVENT

Represents areferencedevent on a given ReferencedSubject.

REMOVED_FROM_PROJECT_EVENT

Represents aremoved_from_projectevent on a given issue or pull request.

RENAMED_TITLE_EVENT

Represents arenamedevent on a given issue or pull request.

REOPENED_EVENT

Represents areopenedevent on any Closable.

SUBSCRIBED_EVENT

Represents asubscribedevent on a given Subscribable.

TRANSFERRED_EVENT

Represents atransferredevent on a given issue or pull request.

UNASSIGNED_EVENT

Represents anunassignedevent on any assignable object.

UNLABELED_EVENT

Represents anunlabeledevent on a given issue or pull request.

UNLOCKED_EVENT

Represents anunlockedevent on a given issue or pull request.

UNMARKED_AS_DUPLICATE_EVENT

Represents anunmarked_as_duplicateevent on a given issue or pull request.

UNPINNED_EVENT

Represents anunpinnedevent on a given issue or pull request.

UNSUBSCRIBED_EVENT

Represents anunsubscribedevent on a given Subscribable.

USER_BLOCKED_EVENT

Represents auser_blockedevent on a given user.

LabelOrderField

Properties by which label connections can be ordered.

Values for LabelOrderField

CREATED_AT

Order labels by creation time.

NAME

Order labels by name.

LanguageOrderField

Properties by which language connections can be ordered.

Values for LanguageOrderField

SIZE

Order languages by the size of all files conta