GraphQL API 인터페이스
GitLab v19.5요약
An interface defines a set of fields that multiple object types can implement. Deprecated items are planned to be removed in a future release.
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#
| Name | Type | Description |
|---|---|---|
immutable |
Boolean! |
Returns true when tag rule is for tag immutability. Otherwise, false. |
minimumAccessLevelForDelete |
ContainerProtectionTagRuleAccessLevel |
Minimum 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. |
minimumAccessLevelForPush |
ContainerProtectionTagRuleAccessLevel |
Minimum 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#
| Name | Type | Description |
|---|---|---|
configurationForGroup |
AiCatalogItemConsumer |
Introduced as an experiment in GitLab 18.7. Item configuration for the given group. Arguments for configurationForGroup:
|
configurationForProject |
AiCatalogItemConsumer |
Introduced as an experiment in GitLab 18.6. Item configuration for the given project. Arguments for configurationForProject:
|
createdAt |
Time! |
Timestamp of when the item was created. |
description |
String! |
Description of the item. |
descriptionHtml |
String |
GitLab Flavored Markdown rendering of description. |
effectiveVersion |
AiCatalogItemVersion |
Introduced 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: |
foundational |
Boolean! |
Whether the item is a foundational item. |
foundationalFlowReference |
String |
Foundational flow reference. |
id |
ID! |
ID of the item. |
isEnabledInManagedByProject |
Boolean! |
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. |
itemType |
AiCatalogItemType! |
Type of the item. |
last30DayUsageCount |
Int! |
Number of projects using the item in the last 30 days. |
latestVersion |
AiCatalogItemVersion |
Latest version of the item. Arguments for latestVersion:
|
name |
String! |
Name of the item. |
project |
Project |
Project for the item. |
public |
Boolean! |
Deprecated in GitLab 19.3. Use visibility. |
softDeleted |
Boolean |
Indicates if the item has been soft deleted. |
softDeletedAt |
Time |
Timestamp of when the item was soft deleted. |
starCount |
Int! |
Number of stars for the item. |
starred |
Boolean! |
Whether the current user has starred the item. |
updatedAt |
Time! |
Timestamp of when the item was updated. |
userPermissions |
AiCatalogItemPermissions! |
Permissions for the current user on the resource. |
verificationLevel |
AiCatalogItemVerificationLevel! |
Verification level of the item. |
versions |
AiCatalogItemVersionConnection |
Versions of the item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last. |
visibility |
AiCatalogItemVisibility! |
Introduced as an experiment in GitLab 19.2. Visibility of the item in the catalog. |
webPath |
String |
Introduced as an experiment in GitLab 19.4. Web path of the item in the AI catalog. |
AiCatalogItemVersion#
An AI catalog item version.
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
createdAt |
Time! |
Timestamp of when the item version was created. |
createdBy |
UserCore |
User that created the item version. |
deprecated |
Boolean! |
Indicates the item version has been deprecated by the author. |
humanVersionName |
String |
Human-friendly name of the item version. In the form v1.0.0-draft. |
id |
ID! |
ID of the item version. |
item |
AiCatalogItem! |
Item the version belongs to. |
released |
Boolean! |
Indicates the item version is released. |
releasedAt |
Time |
Timestamp of when the item version was released. |
updatedAt |
Time! |
Timestamp of when the item version was updated. |
versionName |
String |
Version name of the item version. |
AlertManagementIntegration#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
active |
Boolean |
Whether the endpoint is currently accepting alerts. |
apiUrl |
String |
Deprecated in GitLab 18.2. Feature removed in 16.0. |
id |
ID! |
ID of the integration. |
name |
String |
Name of the integration. |
token |
String |
Token used to authenticate alert notification requests. |
type |
AlertManagementIntegrationType! |
Type of integration. |
url |
String |
Endpoint which accepts alert notifications. |
AmazonS3ConfigurationInterface#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
accessKeyXid |
String! |
Access key ID of the Amazon S3 account. |
active |
Boolean! |
Active status of the destination. |
awsRegion |
String! |
AWS region where the bucket is created. |
bucketName |
String! |
Name of the bucket where the audit events would be logged. |
id |
ID! |
ID of the configuration. |
name |
String! |
Name of the external destination to send audit events to. |
AuditEventStreamingDestinationInterface#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
active |
Boolean! |
Active status of the destination. |
category |
String! |
Category of the external destination to send audit events to. |
config |
JSON! |
Config of the external destination. |
eventTypeFilters |
[String!]! |
List of event type filters added for streaming. |
id |
ID! |
ID of the destination. |
name |
String! |
Name of the external destination to send audit events to. |
secretToken |
String! |
Secret token for the destination, will be non-empty value only for http category. |
BaseDiscussionInterface#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
createdAt |
Time! |
Timestamp of the discussion's creation. |
id |
DiscussionID! |
ID of the discussion. |
replyId |
DiscussionID! |
ID used to reply to the discussion. |
resolvable |
Boolean! |
Indicates if the object can be resolved. |
resolved |
Boolean! |
Indicates if the object is resolved. |
resolvedAt |
Time |
Timestamp of when the object was resolved. |
resolvedBy |
UserCore |
User who resolved the object. |
BaseHeaderInterface#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
active |
Boolean! |
Header is active or not. |
id |
ID! |
ID of the header. |
key |
String! |
Key of the header. |
value |
String! |
Value of the header. |
BaseNoteInterface#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
author |
UserCore |
User who wrote the note. |
awardEmoji |
AwardEmojiConnection |
List of emoji reactions associated with the note. This field is a connection and accepts the four standard pagination arguments: before, after, first, last. |
body |
String! |
Content of the note. |
bodyFirstLineHtml |
String! |
First line of the note content. |
bodyHtml |
String |
GitLab Flavored Markdown rendering of the content of the note. |
createdAt |
Time! |
Timestamp of the note creation. |
lastEditedAt |
Time |
Timestamp when note was last edited. |
lastEditedBy |
UserCore |
User who last edited the note. |
resolvable |
Boolean! |
Indicates if the object can be resolved. |
resolved |
Boolean! |
Indicates if the object is resolved. |
resolvedAt |
Time |
Timestamp of when the object was resolved. |
resolvedBy |
UserCore |
User who resolved the object. |
updatedAt |
Time! |
Timestamp of the note's last activity. |
url |
String |
URL to view the note in the Web UI. |
CiJobInterface#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
active |
Boolean |
Indicates the job is active. |
allowFailure |
Boolean |
Whether the job is allowed to fail. |
artifacts |
CiJobArtifactConnection |
Artifacts generated by the job. This field is a connection and accepts the four standard pagination arguments: before, after, first, last. |
browseArtifactsPath |
String |
URL for browsing the artifact's archive. |
canPlayJob |
Boolean |
Indicates whether the current user can play the job. |
cancelable |
Boolean |
Indicates the job can be canceled. |
commitPath |
String |
Path to the commit that triggered the job. |
coverage |
Float |
Coverage level of the job. |
createdAt |
Time |
When the job was created. |
createdByTag |
Boolean |
Whether the job was created by a tag. |
detailedStatus |
DetailedStatus |
Detailed status of the job. |
duration |
Int |
Duration of the job in seconds. |
erasedAt |
Time |
When the job was erased. |
exitCode |
Int |
Exit code of the job. Available for jobs that started after upgrading to GitLab 16.10 and failed with an exit code. |
failureMessage |
String |
Message on why the job failed. |
finishedAt |
Time |
When a job has finished running. |
id |
JobID |
ID of the job. |
kind |
CiJobKind |
Indicates the type of job. |
manualJob |
Boolean |
Whether the job has a manual action. |
name |
String |
Name of the job. |
pipeline |
PipelineInterface |
Pipeline the job belongs to. |
playPath |
String |
Play path of the job. |
playable |
Boolean |
Indicates the job can be played. |
project |
ProjectInterface |
Project that the job belongs to. |
queuedAt |
Time |
When the job was enqueued and marked as pending. |
queuedDuration |
Duration |
How long the job was enqueued before starting. |
refName |
String |
Ref name of the job. |
refPath |
String |
Path to the ref. |
retried |
Boolean |
Indicates that the job has been retried. |
retryPath |
String |
Retry path of the job. |
retryable |
Boolean |
Indicates the job can be retried. |
runner |
CiRunner |
Runner assigned to execute the job. |
scheduled |
Boolean |
Indicates the job is scheduled. |
scheduledAt |
Time |
Schedule for the build. |
schedulingType |
String |
Type of job scheduling. Value is dag if the job uses the needs keyword, and stage otherwise. |
shortSha |
String |
Short SHA1 ID of the commit. |
source |
String |
Policy or action that initiated the job. If not set, the value is inherited from the pipeline. |
stage |
CiStage |
Stage of the job. |
startedAt |
Time |
When the job was started. |
status |
CiJobStatus |
Status of the job. |
stuck |
Boolean |
Indicates the job is stuck. |
tags |
[String!] |
Tags for the current job. |
trace |
CiJobTrace |
Trace generated by the job. |
triggered |
Boolean |
Whether the job was triggered. |
userPermissions |
JobPermissions |
Permissions for the current user on the job. |
webPath |
String |
Web path of the job. |
CiVariable#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
id |
ID! |
ID of the variable. |
key |
String |
Name of the variable. |
raw |
Boolean |
Indicates whether the variable is raw. |
value |
String |
Value of the variable. |
variableType |
CiVariableType |
Type of the variable. |
CommitSignature#
Represents signing information for a commit.
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
commitSha |
String |
SHA of the associated commit. |
project |
Project |
Project of the associated commit. |
verificationStatus |
VerificationStatus |
Indicates verification status of the associated key or certificate. |
CurrentUserTodos#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
currentUserTodos |
TodoConnection! |
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:
|
CustomDashboardInterface#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
config |
JSON! |
Dashboard layout and widget configuration. |
createdAt |
Time |
Timestamp when the dashboard was created. |
description |
String |
Optional summary or purpose of the dashboard. |
id |
ID! |
Global ID of the dashboard. |
name |
String! |
Display name of the dashboard. |
slug |
String |
Dashboard url slug. |
system |
Boolean! |
Whether the dashboard is a built-in GitLab dashboard. |
CustomRoleInterface#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
createdAt |
Time! |
Timestamp of when the member role was created. |
editPath |
String! |
Introduced as an experiment in GitLab 16.11. Web UI path to edit the custom role. |
DependencyInterface#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
componentVersion |
ComponentVersion |
Version of the dependency. |
dependencyPaths |
DependencyPathPage |
Introduced 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: |
id |
GlobalID! |
ID of the dependency. |
licenses |
[License!] |
Licenses associated to the dependency. |
location |
Location |
Information about where the dependency is located. |
malware |
Boolean |
Introduced 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. |
name |
String! |
Name of the dependency. |
packager |
PackageManager |
Description of the tool used to manage the dependency. |
reachability |
ReachabilityType |
Information about reachability of a dependency. |
version |
String |
Deprecated in GitLab 18.1. Replaced by component_version. |
vulnerabilities |
VulnerabilityConnection |
Vulnerabilities associated with the dependency. This field is a connection and accepts the four standard pagination arguments: before, after, first, last. |
vulnerabilityCount |
Int! |
Number of vulnerabilities within the dependency. |
DesignFields#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
diffRefs |
DiffRefs! |
Diff refs for the design. |
event |
DesignVersionEvent! |
How the design was changed in the current version. |
filename |
String! |
Filename of the design. |
fullPath |
ID! |
Full path to the design file. |
id |
ID! |
ID of the design. |
image |
String! |
URL of the full-sized image. |
imageV432x230 |
String |
The URL of the design resized to fit within the bounds of 432x230. This will be null if the image has not been generated. |
issue |
Issue! |
Issue the design belongs to. |
notesCount |
Int! |
Total count of user-created notes for the design. |
project |
Project! |
Project the design belongs to. |
Entry#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
flatPath |
String! |
Flat path of the entry. |
id |
ID! |
ID of the entry. |
name |
String! |
Name of the entry. |
path |
String! |
Path of the entry. |
sha |
String! |
SHA of the entry. |
type |
EntryType! |
Type of tree entry. |
EntryInterface#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
contentType |
String! |
Introduced as an experiment in GitLab 18.9. Content type of the cached file. |
createdAt |
Time! |
Introduced as an experiment in GitLab 18.9. Timestamp when the cache entry was created. |
downloadedAt |
Time |
Introduced as an experiment in GitLab 18.9. Timestamp when the cache entry was last downloaded. |
downloadsCount |
Int! |
Introduced as an experiment in GitLab 18.9. Number of times the entry has been downloaded. |
fileMd5 |
String |
Introduced as an experiment in GitLab 18.9. MD5 hash of the cached file. |
fileSha1 |
String! |
Introduced as an experiment in GitLab 18.9. SHA1 hash of the cached file. |
id |
String! |
Introduced as an experiment in GitLab 18.9. ID of the cache entry. |
relativePath |
String! |
Introduced as an experiment in GitLab 18.9. Relative path of the cached entry. |
size |
BigInt! |
Introduced as an experiment in GitLab 18.9. Size of the cached file in bytes. |
updatedAt |
Time! |
Introduced as an experiment in GitLab 18.9. Timestamp when the cache entry was last updated. |
upstreamCheckedAt |
Time |
Introduced as an experiment in GitLab 18.9. Timestamp when the upstream was last checked. |
upstreamEtag |
String |
Introduced as an experiment in GitLab 18.9. ETag from the upstream source. |
Eventable#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
events |
EventConnection |
List 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#
| Name | Type | Description |
|---|---|---|
field |
String! |
Field the expression applies to. |
operator |
String! |
Operator of the expression. |
ExternalAuditEventDestinationInterface#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
active |
Boolean! |
Active status of the destination. |
destinationUrl |
String! |
External destination to send audit events to. |
eventTypeFilters |
[String!]! |
List of event type filters added for streaming. |
id |
ID! |
ID of the destination. |
name |
String! |
Name of the external destination to send audit events to. |
verificationToken |
String! |
Verification token to validate source of event. |
GoogleCloudLoggingConfigurationInterface#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
active |
Boolean! |
Active status of the destination. |
clientEmail |
String! |
Client email. |
googleProjectIdName |
String! |
Google project ID. |
id |
ID! |
ID of the configuration. |
logIdName |
String! |
Log ID. |
name |
String! |
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#
| Name | Type | Description |
|---|---|---|
avatarUrl |
String |
Avatar URL of the group. |
fullName |
String |
Full name of the group. |
fullPath |
ID! |
Full path of the group. |
id |
ID |
ID of the group. |
name |
String |
Name of the group. |
userPermissions |
GroupPermissions |
Permissions for the current user on the group. |
webUrl |
String |
Web URL of the group. |
LabelInterface#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
color |
String! |
Background color of the label. |
createdAt |
Time! |
When the label was created. |
description |
String |
Description of the label (Markdown rendered as HTML for caching). |
textColor |
String! |
Text color of the label. |
title |
String! |
Content of the label. |
updatedAt |
Time! |
When the label was last updated. |
MarkdownPaths#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
autocompleteSourcesPath |
JSON |
Supported paths for autocomplete sources for a given namespace. Arguments for autocompleteSourcesPath: |
markdownPreviewPath |
String |
Path for the markdown preview for given namespace. Arguments for markdownPreviewPath:
|
uploadsPath |
String |
Uploads path for a given namespace. |
MemberInterface#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
accessLevel |
AccessLevel |
GitLab::Access level. |
createdAt |
Time |
Date and time the membership was created. |
createdBy |
UserCore |
User that authorized membership. |
expiresAt |
Time |
Date and time the membership expires. |
id |
ID! |
ID of the member. |
mergeRequestInteraction |
UserMergeRequestInteraction |
Find a merge request. Arguments for mergeRequestInteraction:
|
updatedAt |
Time |
Date and time the membership was last updated. |
user |
UserCore |
User that is associated with the member object. |
NamespaceMetadata#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
groupId |
String |
Introduced as an experiment in GitLab 18.6. ID of the group. Returns null for user namespaces. |
initialSort |
String |
Introduced as an experiment in GitLab 18.6. User preference for initial sort order. |
isIssueRepositioningDisabled |
Boolean |
Introduced as an experiment in GitLab 18.6. Whether issue repositioning is disabled for the namespace. |
maxAttachmentSize |
String |
Introduced as an experiment in GitLab 18.6. Maximum allowed attachment size (humanized). |
showNewWorkItem |
Boolean |
Introduced as an experiment in GitLab 18.6. Whether to show the new work item link. |
timeTrackingLimitToHours |
Boolean |
Introduced as an experiment in GitLab 18.6. Time tracking limit to hours setting. |
NamespacesLinkPaths#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
autocompleteAwardEmojisPath |
String |
Introduced as an experiment in GitLab 18.6. Path for autocomplete award emojis. |
calendarPath |
String |
Introduced as an experiment in GitLab 18.4. Calendar path for work items. |
contributionGuidePath |
String |
Namespace contribution guide path. |
emailsHelpPagePath |
String |
Help page path for emails. |
epicsList |
String |
Namespace epics_list. |
epicsListPath |
String |
Introduced as an experiment in GitLab 18.6. Path to the epics list for the namespace. |
groupIssues |
String |
Namespace group_issues. |
groupPath |
String |
Introduced as an experiment in GitLab 18.6. Full path of the group. |
issuesList |
String |
Namespace issues_list. |
issuesListPath |
String |
Introduced as an experiment in GitLab 18.6. Path to the issues list for the namespace. |
issuesSettings |
String |
Namespace issues settings path. |
labelsFetch |
String |
Namespace labels_fetch. |
labelsManage |
String |
Namespace labels_manage. |
markdownHelpPath |
String |
Help page path for Markdown. |
namespaceFullPath |
String |
Introduced 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. |
newIssuePath |
String |
Introduced as an experiment in GitLab 18.6. Path to create a new issue. |
newProject |
String |
Namespace new_project. |
newTrialPath |
String |
Introduced as an experiment in GitLab 18.6. New trial path for the namespace. |
quickActionsHelpPath |
String |
Help page path for quick actions. |
register |
String |
Namespace register_path. |
reportAbuse |
String |
Namespace report_abuse. |
rssPath |
String |
Introduced as an experiment in GitLab 18.4. RSS path for work items. |
signIn |
String |
Namespace sign_in_path. |
userExportEmail |
String |
Introduced as an experiment in GitLab 18.3. User email for export CSV. Returns null for user namespaces. |
NoteableInterface#
Implementations#
AlertManagementAlertBoardEpicCommitCountableVulnerabilityDesignEpicEpicIssueIssueMergeRequestProjectComplianceViolationSnippetVulnerabilityWikiPage
Fields#
| Name | Type | Description |
|---|---|---|
commenters |
UserCoreConnection! |
All commenters on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last. |
discussions |
DiscussionConnection! |
All discussions on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last. |
notes |
NoteConnection! |
All notes on this noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last. Arguments for notes:
|
OrchestrationPolicy#
Implementations#
ApprovalPolicyPipelineExecutionPolicyPipelineExecutionSchedulePolicyScanExecutionPolicyScanResultPolicySecurityPolicyTypeVulnerabilityManagementPolicy
Fields#
| Name | Type | Description |
|---|---|---|
csp |
Boolean! |
Introduced as an experiment in GitLab 18.1. Indicates whether the policy comes from a centralized security policy group. |
description |
String! |
Description of the policy. |
editPath |
String! |
URL of policy edit page. |
enabled |
Boolean! |
Indicates whether the policy is enabled. |
id |
SecurityPolicyID |
Introduced as an experiment in GitLab 18.11. ID of the policy. Returns null if the policy has not been synced to the database yet. |
name |
String! |
Name of the policy. |
policyConfigurationId |
SecurityOrchestrationPolicyConfigurationID |
Introduced as an experiment in GitLab 18.11. ID of the policy configuration the policy belongs to. |
policyScope |
PolicyScope |
Scope of the policy. |
updatedAt |
Time! |
Timestamp of when the policy YAML was last updated. |
yaml |
String! |
YAML definition of the policy. |
PackageFileMetadata#
Represents metadata associated with a Package file.
Implementations#
Fields#
PendingMemberInterface#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
accessLevel |
AccessLevel |
GitLab::Access level. |
approved |
Boolean |
Whether the pending member has been approved. |
avatarUrl |
String |
URL to avatar image file of the pending member. |
createdAt |
Time |
Date and time the membership was created. |
createdBy |
UserCore |
User that authorized membership. |
email |
String |
Public email of the pending member. |
expiresAt |
Time |
Date and time the membership expires. |
id |
ID! |
ID of the member. |
invited |
Boolean |
Whether the pending member has been invited. |
mergeRequestInteraction |
UserMergeRequestInteraction |
Find a merge request. Arguments for mergeRequestInteraction:
|
name |
String |
Name of the pending member. |
updatedAt |
Time |
Date and time the membership was last updated. |
user |
UserCore |
User that is associated with the member object. |
username |
String |
Username of the pending member. |
webUrl |
String |
Web URL of the pending member. |
PipelineInterface#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
commit |
Commit |
Git commit of the pipeline. |
id |
ID |
ID of the pipeline. |
iid |
String |
Internal ID of the pipeline. |
path |
String |
Relative path to the pipeline's page. |
project |
ProjectInterface |
Project the pipeline belongs to. |
user |
UserCore |
Pipeline user. |
ProjectInterface#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
avatarUrl |
String |
Avatar URL of the project. |
description |
String |
Short description of the project. |
fullPath |
ID |
Full path of the project. |
id |
ID |
ID of the project. |
name |
String |
Name of the project without the namespace. |
nameWithNamespace |
String |
Name of the project including the namespace. |
userPermissions |
ProjectPermissions |
Permissions for the current user on the project. |
webUrl |
String |
Web URL of the project. |
RegistryInterface#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
description |
String |
Description of the virtual registry. |
id |
ID! |
ID of the virtual registry. |
name |
String! |
Name of the virtual registry. |
updatedAt |
Time! |
Timestamp of when the virtual registry was updated. |
RegistryUpstreamInterface#
Implementations#
ContainerRegistryUpstreamWithRegistryContainerRegistryUpstreamWithUpstreamMavenRegistryUpstreamWithRegistryMavenRegistryUpstreamWithUpstream
Fields#
| Name | Type | Description |
|---|---|---|
id |
ID! |
Introduced as an experiment in GitLab 18.2. ID of the registry upstream. |
position |
Int! |
Introduced as an experiment in GitLab 18.2. Position of the upstream registry in an ordered list. |
ResolvableInterface#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
resolvable |
Boolean! |
Indicates if the object can be resolved. |
resolved |
Boolean! |
Indicates if the object is resolved. |
resolvedAt |
Time |
Timestamp of when the object was resolved. |
resolvedBy |
UserCore |
User who resolved the object. |
RoleInterface#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
description |
String |
Role description. |
detailsPath |
String |
Introduced as an experiment in GitLab 17.4. URL path to the role details webpage. |
id |
ID! |
Role ID. |
name |
String |
Role name. |
RuleInterface#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
createdAt |
Time! |
When the rule was created. |
id |
VirtualRegistriesPackagesMavenUpstreamRuleID! |
Global ID of the rule. |
pattern |
String! |
Pattern for the rule. |
patternType |
MavenUpstreamPatternType! |
Type of pattern (WILDCARD or REGEX). |
targetCoordinate |
MavenUpstreamTargetCoordinate! |
Target coordinate for the rule. |
Service#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
active |
Boolean |
Indicates if the service is active. |
serviceType |
ServiceType |
Type of the service. |
type |
String |
Class name of the service. |
TerraformModuleMetadataSharedFields#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
inputs |
[TerraformModuleMetadataInput!] |
Inputs of the module. |
outputs |
[TerraformModuleMetadataOutput!] |
Outputs of the module. |
readme |
String |
Readme data. |
readmeHtml |
String |
GitLab Flavored Markdown rendering of readme. |
TimeboxReportInterface#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
report |
TimeboxReport |
Historically accurate report about the timebox. Arguments for report:
|
Todoable#
Implementations#
AddOnUserAlertManagementAlertAutocompletedUserBoardEpicCommitCountableVulnerabilityCurrentUserDesignDuoWorkflowEpicEpicIssueGroupIssueKeyMergeRequestMergeRequestAssigneeMergeRequestAuthorMergeRequestParticipantMergeRequestReviewerNamespaceProjectProjectComplianceViolationUserCoreVulnerabilityWikiPageWorkItem
Fields#
UpstreamInterface#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
cacheValidityHours |
Int! |
Introduced as an experiment in GitLab 18.1. Time before the cache expires for the upstream registry. |
description |
String |
Introduced as an experiment in GitLab 18.1. Description of the upstream registry. |
id |
ID! |
Introduced as an experiment in GitLab 18.1. ID of the upstream registry. |
name |
String! |
Introduced as an experiment in GitLab 18.1. Name of the upstream registry. |
registriesCount |
Int! |
Introduced as an experiment in GitLab 18.6. Number of registries using the upstream. |
url |
String! |
Introduced as an experiment in GitLab 18.1. URL of the upstream registry. |
User#
Representation of a GitLab user.
Implementations#
AddOnUserAutocompletedUserCurrentUserMergeRequestAssigneeMergeRequestAuthorMergeRequestParticipantMergeRequestReviewerUserCore
Fields#
| Name | Type | Description |
|---|---|---|
active |
Boolean |
Indicates if the user is active. |
assignedMergeRequests |
MergeRequestConnection |
Merge requests assigned to the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last. Arguments for assignedMergeRequests:
|
authoredMergeRequests |
MergeRequestConnection |
Merge requests authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last. Arguments for authoredMergeRequests:
|
avatarUrl |
String |
URL of the user's avatar. |
bio |
String |
Bio of the user. |
bot |
Boolean! |
Indicates if the user is a bot. |
callouts |
UserCalloutConnection |
User callouts that belong to the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last. |
commitEmail |
String |
User's default commit email. |
compositeIdentityEnforced |
Boolean |
Indicates if composite identity is enforced for the user. |
contributedProjects |
ProjectConnection |
Projects the user has contributed to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last. Arguments for contributedProjects:
|
contributionCalendar |
UserContributionCalendar |
Introduced 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. |
createdAt |
Time |
Timestamp of when the user was created. |
discord |
String |
Discord ID of the user. |
duoStatus |
UserDuoStatus |
Duo status for the user. |
email |
String |
Deprecated in GitLab 13.7. Renamed. Use User.publicEmail instead. |
emails |
EmailConnection |
User's email addresses. This field is a connection and accepts the four standard pagination arguments: before, after, first, last. |
events |
EventConnection |
Activity 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:
|
github |
String |
GitHub profile name of the user. |
gitpodEnabled |
Boolean |
Whether Ona is enabled at the user level. |
groupCallouts |
UserGroupCalloutConnection |
User callouts that belong to the user per group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last. |
groupCount |
Int |
Group count for the user. |
groupMemberships |
GroupMemberConnection |
Group memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last. |
groups |
GroupConnection |
Groups where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last. Arguments for groups:
|
human |
Boolean |
Indicates if the user is a regular user. |
id |
UserID! |
Global ID of the user. |
ide |
Ide |
IDE settings. |
jobTitle |
String |
Job title of the user. |
lastActivityOn |
Date |
Date the user last performed any actions. |
linkedin |
String |
LinkedIn profile name of the user. |
location |
String |
Location of the user. |
name |
String! |
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. |
namespace |
Namespace |
Personal namespace of the user. |
namespaceCommitEmails |
NamespaceCommitEmailConnection |
User's custom namespace commit emails. This field is a connection and accepts the four standard pagination arguments: before, after, first, last. |
organization |
String |
Who the user represents or works for. |
organizations |
OrganizationConnection |
Introduced 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:
|
personalAccessTokens |
PersonalAccessTokenConnection |
Introduced 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:
|
preferencesGitpodPath |
String |
Web path to the Ona section within user preferences. |
profileEnableGitpodPath |
String |
Web path to enable Ona for the user. |
projectCount |
Int |
Project count for the user. |
projectMemberships |
ProjectMemberConnection |
Project memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last. |
pronouns |
String |
Pronouns of the user. |
publicEmail |
String |
User's public email. |
reviewRequestedMergeRequests |
MergeRequestConnection |
Merge 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:
|
savedReplies |
SavedReplyConnection |
Saved replies authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last. |
savedReply |
SavedReply |
Saved reply authored by the user. Arguments for savedReply:
|
snippets |
SnippetConnection |
Snippets authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last. Arguments for snippets:
|
starredProjects |
ProjectConnection |
Projects starred by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last. Arguments for starredProjects:
|
state |
UserState! |
State of the user. |
status |
UserStatus |
User status. |
timelogs |
TimelogConnection |
Time logged by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last. Arguments for timelogs:
|
todos |
TodoConnection |
To-do items of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last. Arguments for todos:
|
twitter |
String |
X (formerly Twitter) username of the user. |
type |
UserType! |
Type of the user. |
userAchievements |
UserAchievementConnection |
Achievements for the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last. Arguments for userAchievements:
|
userPermissions |
UserPermissions! |
Permissions for the current user on the resource. |
userPreferences |
UserPreferences |
Preferences for the user. |
username |
String! |
Username of the user. Unique within the instance of GitLab. |
webPath |
String! |
Web path of the user. |
webUrl |
String! |
Web URL of the user. |
VulnerabilityStatisticInterface#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
critical |
Int! |
Number of vulnerabilities of CRITICAL severity. |
high |
Int! |
Number of vulnerabilities of HIGH severity. |
info |
Int! |
Number of vulnerabilities of INFO severity. |
low |
Int! |
Number of vulnerabilities of LOW severity. |
medium |
Int! |
Number of vulnerabilities of MEDIUM severity. |
total |
Int! |
Total of all vulnerabilities. |
unknown |
Int! |
Number of vulnerabilities of UNKNOWN severity. |
updatedAt |
Time |
Date that data was last updated. |
WorkItemCustomFieldValue#
Implementations#
Fields#
| Name | Type | Description |
|---|---|---|
customField |
CustomField! |
Custom field associated with the custom field value. |
WorkItemWidget#
Implementations#
WorkItemWidgetAgentPlanWorkItemWidgetAiSessionWorkItemWidgetAssigneesWorkItemWidgetAwardEmojiWorkItemWidgetColorWorkItemWidgetCrmContactsWorkItemWidgetCurrentUserTodosWorkItemWidgetCustomFieldsWorkItemWidgetDecisionLogWorkItemWidgetDescriptionWorkItemWidgetDesignsWorkItemWidgetDevelopmentWorkItemWidgetEmailParticipantsWorkItemWidgetErrorTrackingWorkItemWidgetEscalationPolicyWorkItemWidgetEscalationStatusWorkItemWidgetHealthStatusWorkItemWidgetHierarchyWorkItemWidgetIterationWorkItemWidgetLabelsWorkItemWidgetLinkedItemsWorkItemWidgetLinkedResourcesWorkItemWidgetMilestoneWorkItemWidgetNotesWorkItemWidgetNotificationsWorkItemWidgetParticipantsWorkItemWidgetProgressWorkItemWidgetRequirementLegacyWorkItemWidgetSeverityWorkItemWidgetStartAndDueDateWorkItemWidgetStatusWorkItemWidgetTestReportsWorkItemWidgetTimeTrackingWorkItemWidgetVerificationStatusWorkItemWidgetVulnerabilitiesWorkItemWidgetWeight
Fields#
| Name | Type | Description |
|---|---|---|
type |
WorkItemWidgetType |
Widget type. |
WorkItemWidgetDefinition#
Implementations#
WorkItemWidgetDefinitionAssigneesWorkItemWidgetDefinitionCustomFieldsWorkItemWidgetDefinitionGenericWorkItemWidgetDefinitionHierarchyWorkItemWidgetDefinitionLabelsWorkItemWidgetDefinitionProgressWorkItemWidgetDefinitionStartAndDueDateWorkItemWidgetDefinitionStatusWorkItemWidgetDefinitionWeight
Fields#
| Name | Type | Description |
|---|---|---|
type |
WorkItemWidgetType! |
Widget type. |