GraphQL API Interfaces

An interface defines a set of fields that multiple object types can implement. For more information, see the GraphQL interface documentation.

Deprecated items are planned to be removed in a future release. For more information, see the GitLab deprecation process.

AccessLevelInterface

Implementations

Fields

NameTypeDescription
immutableBoolean!Returns true when tag rule is for tag immutability. Otherwise, false.
minimumAccessLevelForDeleteContainerProtectionTagRuleAccessLevelMinimum GitLab access level required to delete container image tags from the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, no access level can delete tags.
minimumAccessLevelForPushContainerProtectionTagRuleAccessLevelMinimum GitLab access level required to push container image tags to the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, no access level can push tags.

AiCatalogItem

An AI catalog item.

Implementations

Fields

NameTypeDescription
configurationForGroupAiCatalogItemConsumerIntroduced as an experiment in GitLab 18.7.

Item configuration for the given group.

Arguments for configurationForGroup:
groupId (GroupID!)
Global ID of the group to return the item configuration of.
configurationForProjectAiCatalogItemConsumerIntroduced as an experiment in GitLab 18.6.

Item configuration for the given project.

Arguments for configurationForProject:
projectId (ProjectID!)
Global ID of the project to return the item configuration of.
createdAtTime!Timestamp of when the item was created.
descriptionString!Description of the item.
descriptionHtmlStringGitLab Flavored Markdown rendering of description.
effectiveVersionAiCatalogItemVersionIntroduced as an experiment in GitLab 19.3.

Version of the item in effect for the given namespace, falling back to the latest version when none is in effect. In a project namespace, resolves to the project configuration pinned version when enabled, otherwise the latest version. In a group namespace, resolves to the group configuration pinned version when enabled, otherwise the latest version. In the global namespace, always resolves to the latest version.

Arguments for effectiveVersion:
groupId (GroupID)
Global ID of the group to return the effective version for.
projectId (ProjectID)
Global ID of the project to return the effective version for.
foundationalBoolean!Whether the item is a foundational item.
foundationalFlowReferenceStringFoundational flow reference.
idID!ID of the item.
isEnabledInManagedByProjectBoolean!Whether the item is enabled in the project it is managed by. This field can only be resolved for one AiCatalogItem in any single request.
itemTypeAiCatalogItemType!Type of the item.
last30DayUsageCountInt!Number of projects using the item in the last 30 days.
latestVersionAiCatalogItemVersionLatest version of the item.

Arguments for latestVersion:
released (Boolean)
Return the latest released version.
nameString!Name of the item.
projectProjectProject for the item.
publicBoolean!Deprecated in GitLab 19.3. Use visibility.
softDeletedBooleanIndicates if the item has been soft deleted.
softDeletedAtTimeTimestamp of when the item was soft deleted.
starCountInt!Number of stars for the item.
starredBoolean!Whether the current user has starred the item.
updatedAtTime!Timestamp of when the item was updated.
userPermissionsAiCatalogItemPermissions!Permissions for the current user on the resource.
verificationLevelAiCatalogItemVerificationLevel!Verification level of the item.
versionsAiCatalogItemVersionConnectionVersions of the item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
visibilityAiCatalogItemVisibility!Introduced as an experiment in GitLab 19.2.

Visibility of the item in the catalog.
webPathStringIntroduced as an experiment in GitLab 19.4.

Web path of the item in the AI catalog.

AiCatalogItemVersion

An AI catalog item version.

Implementations

Fields

NameTypeDescription
createdAtTime!Timestamp of when the item version was created.
createdByUserCoreUser that created the item version.
deprecatedBoolean!Indicates the item version has been deprecated by the author.
humanVersionNameStringHuman-friendly name of the item version. In the form v1.0.0-draft.
idID!ID of the item version.
itemAiCatalogItem!Item the version belongs to.
releasedBoolean!Indicates the item version is released.
releasedAtTimeTimestamp of when the item version was released.
updatedAtTime!Timestamp of when the item version was updated.
versionNameStringVersion name of the item version.

AlertManagementIntegration

Implementations

Fields

NameTypeDescription
activeBooleanWhether the endpoint is currently accepting alerts.
apiUrlStringDeprecated in GitLab 18.2. Feature removed in 16.0.
idID!ID of the integration.
nameStringName of the integration.
tokenStringToken used to authenticate alert notification requests.
typeAlertManagementIntegrationType!Type of integration.
urlStringEndpoint which accepts alert notifications.

AmazonS3ConfigurationInterface

Implementations

Fields

NameTypeDescription
accessKeyXidString!Access key ID of the Amazon S3 account.
activeBoolean!Active status of the destination.
awsRegionString!AWS region where the bucket is created.
bucketNameString!Name of the bucket where the audit events would be logged.
idID!ID of the configuration.
nameString!Name of the external destination to send audit events to.

AuditEventStreamingDestinationInterface

Implementations

Fields

NameTypeDescription
activeBoolean!Active status of the destination.
categoryString!Category of the external destination to send audit events to.
configJSON!Config of the external destination.
eventTypeFilters[String!]!List of event type filters added for streaming.
idID!ID of the destination.
nameString!Name of the external destination to send audit events to.
secretTokenString!Secret token for the destination, will be non-empty value only for http category.

BaseDiscussionInterface

Implementations

Fields

NameTypeDescription
createdAtTime!Timestamp of the discussion’s creation.
idDiscussionID!ID of the discussion.
replyIdDiscussionID!ID used to reply to the discussion.
resolvableBoolean!Indicates if the object can be resolved.
resolvedBoolean!Indicates if the object is resolved.
resolvedAtTimeTimestamp of when the object was resolved.
resolvedByUserCoreUser who resolved the object.

BaseHeaderInterface

Implementations

Fields

NameTypeDescription
activeBoolean!Header is active or not.
idID!ID of the header.
keyString!Key of the header.
valueString!Value of the header.

BaseNoteInterface

Implementations

Fields

NameTypeDescription
authorUserCoreUser who wrote the note.
awardEmojiAwardEmojiConnectionList of emoji reactions associated with the note. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
bodyString!Content of the note.
bodyFirstLineHtmlString!First line of the note content.
bodyHtmlStringGitLab Flavored Markdown rendering of the content of the note.
createdAtTime!Timestamp of the note creation.
lastEditedAtTimeTimestamp when note was last edited.
lastEditedByUserCoreUser who last edited the note.
resolvableBoolean!Indicates if the object can be resolved.
resolvedBoolean!Indicates if the object is resolved.
resolvedAtTimeTimestamp of when the object was resolved.
resolvedByUserCoreUser who resolved the object.
updatedAtTime!Timestamp of the note’s last activity.
urlStringURL to view the note in the Web UI.

CiJobInterface

Implementations

Fields

NameTypeDescription
activeBooleanIndicates the job is active.
allowFailureBooleanWhether the job is allowed to fail.
artifactsCiJobArtifactConnectionArtifacts generated by the job. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
browseArtifactsPathStringURL for browsing the artifact’s archive.
canPlayJobBooleanIndicates whether the current user can play the job.
cancelableBooleanIndicates the job can be canceled.
commitPathStringPath to the commit that triggered the job.
coverageFloatCoverage level of the job.
createdAtTimeWhen the job was created.
createdByTagBooleanWhether the job was created by a tag.
detailedStatusDetailedStatusDetailed status of the job.
durationIntDuration of the job in seconds.
erasedAtTimeWhen the job was erased.
exitCodeIntExit code of the job. Available for jobs that started after upgrading to GitLab 16.10 and failed with an exit code.
failureMessageStringMessage on why the job failed.
finishedAtTimeWhen a job has finished running.
idJobIDID of the job.
kindCiJobKindIndicates the type of job.
manualJobBooleanWhether the job has a manual action.
nameStringName of the job.
pipelinePipelineInterfacePipeline the job belongs to.
playPathStringPlay path of the job.
playableBooleanIndicates the job can be played.
projectProjectInterfaceProject that the job belongs to.
queuedAtTimeWhen the job was enqueued and marked as pending.
queuedDurationDurationHow long the job was enqueued before starting.
refNameStringRef name of the job.
refPathStringPath to the ref.
retriedBooleanIndicates that the job has been retried.
retryPathStringRetry path of the job.
retryableBooleanIndicates the job can be retried.
runnerCiRunnerRunner assigned to execute the job.
scheduledBooleanIndicates the job is scheduled.
scheduledAtTimeSchedule for the build.
schedulingTypeStringType of job scheduling. Value is dag if the job uses the needs keyword, and stage otherwise.
shortShaStringShort SHA1 ID of the commit.
sourceStringPolicy or action that initiated the job. If not set, the value is inherited from the pipeline.
stageCiStageStage of the job.
startedAtTimeWhen the job was started.
statusCiJobStatusStatus of the job.
stuckBooleanIndicates the job is stuck.
tags[String!]Tags for the current job.
traceCiJobTraceTrace generated by the job.
triggeredBooleanWhether the job was triggered.
userPermissionsJobPermissionsPermissions for the current user on the job.
webPathStringWeb path of the job.

CiVariable

Implementations

Fields

NameTypeDescription
idID!ID of the variable.
keyStringName of the variable.
rawBooleanIndicates whether the variable is raw.
valueStringValue of the variable.
variableTypeCiVariableTypeType of the variable.

CommitSignature

Represents signing information for a commit.

Implementations

Fields

NameTypeDescription
commitShaStringSHA of the associated commit.
projectProjectProject of the associated commit.
verificationStatusVerificationStatusIndicates verification status of the associated key or certificate.

CurrentUserTodos

Implementations

Fields

NameTypeDescription
currentUserTodosTodoConnection!To-do items for the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for currentUserTodos:
state (TodoStateEnum)
State of the to-do items.

CustomDashboardInterface

Implementations

Fields

NameTypeDescription
configJSON!Dashboard layout and widget configuration.
createdAtTimeTimestamp when the dashboard was created.
descriptionStringOptional summary or purpose of the dashboard.
idID!Global ID of the dashboard.
nameString!Display name of the dashboard.
slugStringDashboard url slug.
systemBoolean!Whether the dashboard is a built-in GitLab dashboard.

CustomRoleInterface

Implementations

Fields

NameTypeDescription
createdAtTime!Timestamp of when the member role was created.
editPathString!Introduced as an experiment in GitLab 16.11.

Web UI path to edit the custom role.

DependencyInterface

Implementations

Fields

NameTypeDescription
componentVersionComponentVersionVersion of the dependency.
dependencyPathsDependencyPathPageIntroduced as an experiment in GitLab 18.2.

Ancestor dependency paths for a dependency. Returns null if dependency_graph_graphql feature flag is disabled.

Arguments for dependencyPaths:
after (String)
Fetch paths after the cursor.
before (String)
Fetch paths before the cursor.
limit (Int)
Number of paths to fetch.
idGlobalID!ID of the dependency.
licenses[License!]Licenses associated to the dependency.
locationLocationInformation about where the dependency is located.
malwareBooleanIntroduced as an experiment in GitLab 19.1.

Indicates whether the dependency is a malware package. Returns true if a malware package is identified. Returns false if the package is not a malware package.
nameString!Name of the dependency.
packagerPackageManagerDescription of the tool used to manage the dependency.
reachabilityReachabilityTypeInformation about reachability of a dependency.
versionStringDeprecated in GitLab 18.1. Replaced by component_version.
vulnerabilitiesVulnerabilityConnectionVulnerabilities associated with the dependency. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
vulnerabilityCountInt!Number of vulnerabilities within the dependency.

DesignFields

Implementations

Fields

NameTypeDescription
diffRefsDiffRefs!Diff refs for the design.
eventDesignVersionEvent!How the design was changed in the current version.
filenameString!Filename of the design.
fullPathID!Full path to the design file.
idID!ID of the design.
imageString!URL of the full-sized image.
imageV432x230StringThe URL of the design resized to fit within the bounds of 432x230. This will be null if the image has not been generated.
issueIssue!Issue the design belongs to.
notesCountInt!Total count of user-created notes for the design.
projectProject!Project the design belongs to.

Entry

Implementations

Fields

NameTypeDescription
flatPathString!Flat path of the entry.
idID!ID of the entry.
nameString!Name of the entry.
pathString!Path of the entry.
shaString!SHA of the entry.
typeEntryType!Type of tree entry.

EntryInterface

Implementations

Fields

NameTypeDescription
contentTypeString!Introduced as an experiment in GitLab 18.9.

Content type of the cached file.
createdAtTime!Introduced as an experiment in GitLab 18.9.

Timestamp when the cache entry was created.
downloadedAtTimeIntroduced as an experiment in GitLab 18.9.

Timestamp when the cache entry was last downloaded.
downloadsCountInt!Introduced as an experiment in GitLab 18.9.

Number of times the entry has been downloaded.
fileMd5StringIntroduced as an experiment in GitLab 18.9.

MD5 hash of the cached file.
fileSha1String!Introduced as an experiment in GitLab 18.9.

SHA1 hash of the cached file.
idString!Introduced as an experiment in GitLab 18.9.

ID of the cache entry.
relativePathString!Introduced as an experiment in GitLab 18.9.

Relative path of the cached entry.
sizeBigInt!Introduced as an experiment in GitLab 18.9.

Size of the cached file in bytes.
updatedAtTime!Introduced as an experiment in GitLab 18.9.

Timestamp when the cache entry was last updated.
upstreamCheckedAtTimeIntroduced as an experiment in GitLab 18.9.

Timestamp when the upstream was last checked.
upstreamEtagStringIntroduced as an experiment in GitLab 18.9.

ETag from the upstream source.

Eventable

Implementations

Fields

NameTypeDescription
eventsEventConnectionList of events associated with the object. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

ExpressionInterface

Defines the common fields for all expressions.

Implementations

Fields

NameTypeDescription
fieldString!Field the expression applies to.
operatorString!Operator of the expression.

ExternalAuditEventDestinationInterface

Implementations

Fields

NameTypeDescription
activeBoolean!Active status of the destination.
destinationUrlString!External destination to send audit events to.
eventTypeFilters[String!]!List of event type filters added for streaming.
idID!ID of the destination.
nameString!Name of the external destination to send audit events to.
verificationTokenString!Verification token to validate source of event.

GoogleCloudLoggingConfigurationInterface

Implementations

Fields

NameTypeDescription
activeBoolean!Active status of the destination.
clientEmailString!Client email.
googleProjectIdNameString!Google project ID.
idID!ID of the configuration.
logIdNameString!Log ID.
nameString!Name of the external destination to send audit events to.

GroupInterface

Returns either a “Group” type for users with :read_group permission, or a “GroupMinimalAccess” type for users with only :read_group_metadata permission.

Implementations

Fields

NameTypeDescription
avatarUrlStringAvatar URL of the group.
fullNameStringFull name of the group.
fullPathID!Full path of the group.
idIDID of the group.
nameStringName of the group.
userPermissionsGroupPermissionsPermissions for the current user on the group.
webUrlStringWeb URL of the group.

LabelInterface

Implementations

Fields

NameTypeDescription
colorString!Background color of the label.
createdAtTime!When the label was created.
descriptionStringDescription of the label (Markdown rendered as HTML for caching).
textColorString!Text color of the label.
titleString!Content of the label.
updatedAtTime!When the label was last updated.

MarkdownPaths

Implementations

Fields

NameTypeDescription
autocompleteSourcesPathJSONSupported paths for autocomplete sources for a given namespace.

Arguments for autocompleteSourcesPath:
iid (String)
IID of the work item.
workItemTypeId (String)
ID of the work item type.
markdownPreviewPathStringPath for the markdown preview for given namespace.

Arguments for markdownPreviewPath:
iid (String)
IID of the target item for markdown preview.
uploadsPathStringUploads path for a given namespace.

MemberInterface

Implementations

Fields

NameTypeDescription
accessLevelAccessLevelGitLab::Access level.
createdAtTimeDate and time the membership was created.
createdByUserCoreUser that authorized membership.
expiresAtTimeDate and time the membership expires.
idID!ID of the member.
mergeRequestInteractionUserMergeRequestInteractionFind a merge request.

Arguments for mergeRequestInteraction:
id (MergeRequestID!)
Global ID of the merge request.
updatedAtTimeDate and time the membership was last updated.
userUserCoreUser that is associated with the member object.

NamespaceMetadata

Implementations

Fields

NameTypeDescription
groupIdStringIntroduced as an experiment in GitLab 18.6.

ID of the group. Returns null for user namespaces.
initialSortStringIntroduced as an experiment in GitLab 18.6.

User preference for initial sort order.
isIssueRepositioningDisabledBooleanIntroduced as an experiment in GitLab 18.6.

Whether issue repositioning is disabled for the namespace.
maxAttachmentSizeStringIntroduced as an experiment in GitLab 18.6.

Maximum allowed attachment size (humanized).
showNewWorkItemBooleanIntroduced as an experiment in GitLab 18.6.

Whether to show the new work item link.
timeTrackingLimitToHoursBooleanIntroduced as an experiment in GitLab 18.6.

Time tracking limit to hours setting.

NamespacesLinkPaths

Implementations

Fields

NameTypeDescription
autocompleteAwardEmojisPathStringIntroduced as an experiment in GitLab 18.6.

Path for autocomplete award emojis.
calendarPathStringIntroduced as an experiment in GitLab 18.4.

Calendar path for work items.
contributionGuidePathStringNamespace contribution guide path.
emailsHelpPagePathStringHelp page path for emails.
epicsListStringNamespace epics_list.
epicsListPathStringIntroduced as an experiment in GitLab 18.6.

Path to the epics list for the namespace.
groupIssuesStringNamespace group_issues.
groupPathStringIntroduced as an experiment in GitLab 18.6.

Full path of the group.
issuesListStringNamespace issues_list.
issuesListPathStringIntroduced as an experiment in GitLab 18.6.

Path to the issues list for the namespace.
issuesSettingsStringNamespace issues settings path.
labelsFetchStringNamespace labels_fetch.
labelsManageStringNamespace labels_manage.
markdownHelpPathStringHelp page path for Markdown.
namespaceFullPathStringIntroduced as an experiment in GitLab 18.6.

Full path of the namespace (project.namespace.full_path or group full_path).
newCommentTemplate[CommentTemplatePath!]Namespace new_comment_template_paths.
newIssuePathStringIntroduced as an experiment in GitLab 18.6.

Path to create a new issue.
newProjectStringNamespace new_project.
newTrialPathStringIntroduced as an experiment in GitLab 18.6.

New trial path for the namespace.
quickActionsHelpPathStringHelp page path for quick actions.
registerStringNamespace register_path.
reportAbuseStringNamespace report_abuse.
rssPathStringIntroduced as an experiment in GitLab 18.4.

RSS path for work items.
signInStringNamespace sign_in_path.
userExportEmailStringIntroduced as an experiment in GitLab 18.3.

User email for export CSV. Returns null for user namespaces.

NoteableInterface

Implementations

Fields

NameTypeDescription
commentersUserCoreConnection!All commenters on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
discussionsDiscussionConnection!All discussions on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
notesNoteConnection!All notes on this noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for notes:
filter (NotesFilterType)
Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.

OrchestrationPolicy

Implementations

Fields

NameTypeDescription
cspBoolean!Introduced as an experiment in GitLab 18.1.

Indicates whether the policy comes from a centralized security policy group.
descriptionString!Description of the policy.
editPathString!URL of policy edit page.
enabledBoolean!Indicates whether the policy is enabled.
idSecurityPolicyIDIntroduced as an experiment in GitLab 18.11.

ID of the policy. Returns null if the policy has not been synced to the database yet.
nameString!Name of the policy.
policyConfigurationIdSecurityOrchestrationPolicyConfigurationIDIntroduced as an experiment in GitLab 18.11.

ID of the policy configuration the policy belongs to.
policyScopePolicyScopeScope of the policy.
updatedAtTime!Timestamp of when the policy YAML was last updated.
yamlString!YAML definition of the policy.

PackageFileMetadata

Represents metadata associated with a Package file.

Implementations

Fields

NameTypeDescription
createdAtTime!Date of creation.
updatedAtTime!Date of most recent update.

PendingMemberInterface

Implementations

Fields

NameTypeDescription
accessLevelAccessLevelGitLab::Access level.
approvedBooleanWhether the pending member has been approved.
avatarUrlStringURL to avatar image file of the pending member.
createdAtTimeDate and time the membership was created.
createdByUserCoreUser that authorized membership.
emailStringPublic email of the pending member.
expiresAtTimeDate and time the membership expires.
idID!ID of the member.
invitedBooleanWhether the pending member has been invited.
mergeRequestInteractionUserMergeRequestInteractionFind a merge request.

Arguments for mergeRequestInteraction:
id (MergeRequestID!)
Global ID of the merge request.
nameStringName of the pending member.
updatedAtTimeDate and time the membership was last updated.
userUserCoreUser that is associated with the member object.
usernameStringUsername of the pending member.
webUrlStringWeb URL of the pending member.

PipelineInterface

Implementations

Fields

NameTypeDescription
commitCommitGit commit of the pipeline.
idIDID of the pipeline.
iidStringInternal ID of the pipeline.
pathStringRelative path to the pipeline’s page.
projectProjectInterfaceProject the pipeline belongs to.
userUserCorePipeline user.

ProjectInterface

Implementations

Fields

NameTypeDescription
avatarUrlStringAvatar URL of the project.
descriptionStringShort description of the project.
fullPathIDFull path of the project.
idIDID of the project.
nameStringName of the project without the namespace.
nameWithNamespaceStringName of the project including the namespace.
userPermissionsProjectPermissionsPermissions for the current user on the project.
webUrlStringWeb URL of the project.

RegistryInterface

Implementations

Fields

NameTypeDescription
descriptionStringDescription of the virtual registry.
idID!ID of the virtual registry.
nameString!Name of the virtual registry.
updatedAtTime!Timestamp of when the virtual registry was updated.

RegistryUpstreamInterface

Implementations

Fields

NameTypeDescription
idID!Introduced as an experiment in GitLab 18.2.

ID of the registry upstream.
positionInt!Introduced as an experiment in GitLab 18.2.

Position of the upstream registry in an ordered list.

ResolvableInterface

Implementations

Fields

NameTypeDescription
resolvableBoolean!Indicates if the object can be resolved.
resolvedBoolean!Indicates if the object is resolved.
resolvedAtTimeTimestamp of when the object was resolved.
resolvedByUserCoreUser who resolved the object.

RoleInterface

Implementations

Fields

NameTypeDescription
descriptionStringRole description.
detailsPathStringIntroduced as an experiment in GitLab 17.4.

URL path to the role details webpage.
idID!Role ID.
nameStringRole name.

RuleInterface

Implementations

Fields

NameTypeDescription
createdAtTime!When the rule was created.
idVirtualRegistriesPackagesMavenUpstreamRuleID!Global ID of the rule.
patternString!Pattern for the rule.
patternTypeMavenUpstreamPatternType!Type of pattern (WILDCARD or REGEX).
targetCoordinateMavenUpstreamTargetCoordinate!Target coordinate for the rule.

Service

Implementations

Fields

NameTypeDescription
activeBooleanIndicates if the service is active.
serviceTypeServiceTypeType of the service.
typeStringClass name of the service.

TerraformModuleMetadataSharedFields

Implementations

Fields

NameTypeDescription
inputs[TerraformModuleMetadataInput!]Inputs of the module.
outputs[TerraformModuleMetadataOutput!]Outputs of the module.
readmeStringReadme data.
readmeHtmlStringGitLab Flavored Markdown rendering of readme.

TimeboxReportInterface

Implementations

Fields

NameTypeDescription
reportTimeboxReportHistorically accurate report about the timebox.

Arguments for report:
fullPath (String)
Full path of the project or group used as a scope for report. For example, gitlab-org or gitlab-org/gitlab.

Todoable

Implementations

Fields

NameTypeDescription
nameStringName or title of the object.
webUrlStringURL of the object.

UpstreamInterface

Implementations

Fields

NameTypeDescription
cacheValidityHoursInt!Introduced as an experiment in GitLab 18.1.

Time before the cache expires for the upstream registry.
descriptionStringIntroduced as an experiment in GitLab 18.1.

Description of the upstream registry.
idID!Introduced as an experiment in GitLab 18.1.

ID of the upstream registry.
nameString!Introduced as an experiment in GitLab 18.1.

Name of the upstream registry.
registriesCountInt!Introduced as an experiment in GitLab 18.6.

Number of registries using the upstream.
urlString!Introduced as an experiment in GitLab 18.1.

URL of the upstream registry.

User

Representation of a GitLab user.

Implementations

Fields

NameTypeDescription
activeBooleanIndicates if the user is active.
assignedMergeRequestsMergeRequestConnectionMerge requests assigned to the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for assignedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
projectId (ProjectID)
The global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath (String)
The full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the criteria.
sourceBranches ([String!])
Array of source branch names. All resolved merge requests will have one of these branches as their source.
state (MergeRequestState)
Merge request state. If provided, all resolved merge requests will have the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
targetBranches ([String!])
Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter (Time)
Merge requests updated after the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
authoredMergeRequestsMergeRequestConnectionMerge requests authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for authoredMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeArchived (Boolean)
Merge requests from archived projects.
includeAssigned (Boolean)
Include merge requests the user is assigned to.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
projectId (ProjectID)
The global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath (String)
The full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the criteria.
sourceBranches ([String!])
Array of source branch names. All resolved merge requests will have one of these branches as their source.
state (MergeRequestState)
Merge request state. If provided, all resolved merge requests will have the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
targetBranches ([String!])
Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter (Time)
Merge requests updated after the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
avatarUrlStringURL of the user’s avatar.
bioStringBio of the user.
botBoolean!Indicates if the user is a bot.
calloutsUserCalloutConnectionUser callouts that belong to the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
commitEmailStringUser’s default commit email.
compositeIdentityEnforcedBooleanIndicates if composite identity is enforced for the user.
contributedProjectsProjectConnectionProjects the user has contributed to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for contributedProjects:
active (Boolean)
Filters by projects that are not archived and not marked for deletion.
includePersonal (Boolean)
Include personal projects.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
Sort contributed projects.
contributionCalendarUserContributionCalendarIntroduced as an experiment in GitLab 19.5.

Contribution calendar of the user: the profile page activity heatmap for the past year. Null when the current user cannot read the profile.
createdAtTimeTimestamp of when the user was created.
discordStringDiscord ID of the user.
duoStatusUserDuoStatusDuo status for the user.
emailStringDeprecated in GitLab 13.7. Renamed. Use User.publicEmail instead.
emailsEmailConnectionUser’s email addresses. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
eventsEventConnectionActivity events visible to the current user, most recent first. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for events:
filter (UserEventFilter)
Filter events by type. Defaults to all events.
githubStringGitHub profile name of the user.
gitpodEnabledBooleanWhether Ona is enabled at the user level.
groupCalloutsUserGroupCalloutConnectionUser callouts that belong to the user per group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groupCountIntGroup count for the user.
groupMembershipsGroupMemberConnectionGroup memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groupsGroupConnectionGroups where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for groups:
permissionScope (GroupPermission)
Filter by permissions the user has on groups.
search (String)
Search by group name or path.
soloOwned (Boolean)
When true, returns only groups in the current organization where the user is the sole owner.
sort (GroupSort)
Sort groups by given criteria.
humanBooleanIndicates if the user is a regular user.
idUserID!Global ID of the user.
ideIdeIDE settings.
jobTitleStringJob title of the user.
lastActivityOnDateDate the user last performed any actions.
linkedinStringLinkedIn profile name of the user.
locationStringLocation of the user.
nameString!Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project.
namespaceNamespacePersonal namespace of the user.
namespaceCommitEmailsNamespaceCommitEmailConnectionUser’s custom namespace commit emails. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
organizationStringWho the user represents or works for.
organizationsOrganizationConnectionIntroduced as an experiment in GitLab 16.6.

Organizations where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for organizations:
excludeDefault (Boolean)
Introduced as an experiment in GitLab 19.1.

Excludes the Default organization from results.
search (String)
Search query, which can be for the organization name or a path.
soloOwned (Boolean)
When true, returns only organizations solely owned by the user.
state (OrganizationState)
Introduced as an experiment in GitLab 19.1.

Filter organizations by state.
personalAccessTokensPersonalAccessTokenConnectionIntroduced as an experiment in GitLab 18.6.

Personal access tokens of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for personalAccessTokens:
createdAfter (Time)
Filter personal access tokens created after the timestamp.
createdBefore (Time)
Filter personal access tokens created before the timestamp.
expiresAfter (Date)
Filter personal access tokens that expire after the specified date.
expiresBefore (Date)
Filter personal access tokens that expire before the specified date.
id (PersonalAccessTokenID)
Filter personal access tokens by ID.
lastUsedAfter (Time)
Filter personal access tokens last used after the timestamp.
lastUsedBefore (Time)
Filter personal access tokens last used before the timestamp.
revoked (Boolean)
Filter personal access tokens by their revoked status.
search (String)
Query to search personal access tokens by name.
sort (AccessTokenSort)
Sort personal access tokens by the given criteria. Default is expires_at_asc.
state (AccessTokenState)
Filter personal access tokens by state.
preferencesGitpodPathStringWeb path to the Ona section within user preferences.
profileEnableGitpodPathStringWeb path to enable Ona for the user.
projectCountIntProject count for the user.
projectMembershipsProjectMemberConnectionProject memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
pronounsStringPronouns of the user.
publicEmailStringUser’s public email.
reviewRequestedMergeRequestsMergeRequestConnectionMerge requests assigned to the user for review. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for reviewRequestedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
projectId (ProjectID)
The global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath (String)
The full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the criteria.
sourceBranches ([String!])
Array of source branch names. All resolved merge requests will have one of these branches as their source.
state (MergeRequestState)
Merge request state. If provided, all resolved merge requests will have the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
targetBranches ([String!])
Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter (Time)
Merge requests updated after the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
savedRepliesSavedReplyConnectionSaved replies authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
savedReplySavedReplySaved reply authored by the user.

Arguments for savedReply:
id (UsersSavedReplyID!)
ID of a saved reply.
snippetsSnippetConnectionSnippets authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for snippets:
ids ([SnippetID!])
Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
type (TypeEnum)
Type of snippet.
visibility (VisibilityScopesEnum)
Visibility of the snippet.
starredProjectsProjectConnectionProjects starred by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for starredProjects:
active (Boolean)
Filters by projects that are not archived and not scheduled for deletion.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
List starred projects by sort order.
stateUserState!State of the user.
statusUserStatusUser status.
timelogsTimelogConnectionTime logged by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for timelogs:
endDate (Time)
List timelogs within a date range where the logged date is equal to or before endDate.
endTime (Time)
List timelogs within a time range where the logged time is equal to or before endTime.
groupId (GroupID)
List timelogs for a group.
projectId (ProjectID)
List timelogs for a project.
sort (TimelogSort)
List timelogs in a particular order.
startDate (Time)
List timelogs within a date range where the logged date is equal to or after startDate.
startTime (Time)
List timelogs within a time range where the logged time is equal to or after startTime.
username (String)
List timelogs for a user.
todosTodoConnectionTo-do items of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for todos:
action ([TodoActionEnum!])
Action to be filtered.
authorId ([ID!])
ID of an author.
groupId ([ID!])
ID of a group.
isSnoozed (Boolean)
Whether the to-do item is snoozed.
projectId ([ID!])
ID of a project.
sort (TodoSort)
Sort todos by given criteria.
state ([TodoStateEnum!])
State of the todo.
type ([TodoTargetEnum!])
Type of the todo.
twitterStringX (formerly Twitter) username of the user.
typeUserType!Type of the user.
userAchievementsUserAchievementConnectionAchievements for the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for userAchievements:
includeHidden (Boolean)
Indicates whether or not achievements hidden from the profile should be included in the result.
userPermissionsUserPermissions!Permissions for the current user on the resource.
userPreferencesUserPreferencesPreferences for the user.
usernameString!Username of the user. Unique within the instance of GitLab.
webPathString!Web path of the user.
webUrlString!Web URL of the user.

VulnerabilityStatisticInterface

Implementations

Fields

NameTypeDescription
criticalInt!Number of vulnerabilities of CRITICAL severity.
highInt!Number of vulnerabilities of HIGH severity.
infoInt!Number of vulnerabilities of INFO severity.
lowInt!Number of vulnerabilities of LOW severity.
mediumInt!Number of vulnerabilities of MEDIUM severity.
totalInt!Total of all vulnerabilities.
unknownInt!Number of vulnerabilities of UNKNOWN severity.
updatedAtTimeDate that data was last updated.

WorkItemCustomFieldValue

Implementations

Fields

NameTypeDescription
customFieldCustomField!Custom field associated with the custom field value.

WorkItemWidget

Implementations

Fields

NameTypeDescription
typeWorkItemWidgetTypeWidget type.

WorkItemWidgetDefinition

Implementations

Fields

NameTypeDescription
typeWorkItemWidgetType!Widget type.