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."
ActionExecutionCapabilitySetting
The possible capabilities for action executions setting.
Values
ALL_ACTIONS
All action executions are enabled.
DISABLED
All action executions are disabled.
LOCAL_ACTIONS_ONLY
Only actions defined within the repo are allowed.
NO_POLICY
Organization administrators action execution capabilities.
AuditLogOrderField
Properties by which Audit Log connections can be ordered.
Values
CREATED_AT
Order audit log entries by timestamp.
CheckAnnotationLevel
Represents an annotation's information level.
Preview notice
CheckAnnotationLevel is available under the Checks preview. During the preview period, the API may change without notice.
Values
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.
Preview notice
CheckConclusionState is available under the Checks preview. During the preview period, the API may change without notice.
Values
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.
SUCCESS
The check suite or run has succeeded.
TIMED_OUT
The check suite or run has timed out.
CheckRunType
The possible types of check runs.
Preview notice
CheckRunType is available under the Checks preview. During the preview period, the API may change without notice.
Values
ALL
Every check run available.
LATEST
The latest check run.
CheckStatusState
The possible states for a check suite or run status.
Preview notice
CheckStatusState is available under the Checks preview. During the preview period, the API may change without notice.
Values
COMPLETED
The check suite or run has been completed.
IN_PROGRESS
The check suite or run is in progress.
QUEUED
The check suite or run has been queued.
REQUESTED
The check suite or run has been requested.
CollaboratorAffiliation
Collaborators affiliation level with a subject.
Values
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
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.
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
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
COMMIT_COUNT
Order commit contributions by how many commits they represent.
OCCURRED_AT
Order commit contributions by when they were made.
ContributionOrderField
Properties by which contribution connections can be ordered.
Values
OCCURRED_AT
Order contributions by when they were made.
DefaultRepositoryPermissionField
The possible default permissions for repositories.
Values
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.
DeploymentOrderField
Properties by which deployment connections can be ordered.
Values
CREATED_AT
Order collection by creation time.
DeploymentState
The possible states in which a deployment can be.
Values
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.
DeploymentStatusState
The possible states for a deployment status.
Values
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.
DiffSide
The possible sides of a diff.
Preview notice
DiffSide is available under the Multi line comments preview. During the preview period, the API may change without notice.
Values
LEFT
The left side of the diff.
RIGHT
The right side of the diff.
EnterpriseAdministratorInvitationOrderField
Properties by which enterprise administrator invitation connections can be ordered.
Values
CREATED_AT
Order enterprise administrator member invitations by creation time.
EnterpriseAdministratorRole
The possible administrator roles in an enterprise account.
Values
BILLING_MANAGER
Represents a billing manager of the enterprise account.
OWNER
Represents an owner of the enterprise account.
EnterpriseDefaultRepositoryPermissionSettingValue
The possible values for the enterprise default repository permission setting.
Values
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 default 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
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
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
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
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 administrators 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
DISABLED
The setting is disabled for organizations in the enterprise.
ENABLED
The setting is enabled for organizations in the enterprise.
EnterpriseServerUserAccountEmailOrderField
Properties by which Enterprise Server user account email connections can be ordered.
Values
Order emails by email.
EnterpriseServerUserAccountOrderField
Properties by which Enterprise Server user account connections can be ordered.
Values
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
CREATED_AT
Order user accounts uploads by creation time.
EnterpriseServerUserAccountsUploadSyncState
Synchronization state of the Enterprise Server user accounts upload.
Values
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
MEMBER
The user is a member of the enterprise membership.
OWNER
The user is an owner of the enterprise membership.
EnterpriseUserDeployment
The possible GitHub Enterprise deployments where this user can exist.
Values
CLOUD
The user is part of a GitHub Enterprise Cloud deployment.
SERVER
The user is part of a GitHub Enterprise Server deployment.
GistOrderField
Properties by which gist connections can be ordered.
Values
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
ALL
Gists that are public and secret.
PUBLIC
Public.
SECRET
Secret.
GitSignatureState
The state of a Git signature.
Values
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 siganture, 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
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.
IssueOrderField
Properties by which issue connections can be ordered.
Values
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
CLOSED
An issue that has been closed.
OPEN
An issue that is still open.
IssueTimelineItemsItemType
The possible item types found in a timeline.
Values
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.
CONVERTED_NOTE_TO_ISSUE_EVENT
Represents aconverted_note_to_issueevent on a given issue or pull request.
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.
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.