GitLabv2

Overview

GitLab v2 is The DevOps platform that empowers organizations to maximize the overall return on software development by delivering software faster and efficiently while strengthening security and compliance.

Use Cases

This integration enables you to:

• Create, close, or update a GitLab issue.
• Get a list of all GitLab issues you have access to.
• Create, close, update and delete a GitLab issue note.
• Get a list of all the notes related to an issue.
• Create, delete and search a branch in GitLab.
• Get a list of all GitLab branches in your project.
• Get a list of the projects’ commits.
• Create, update a GitLab merge requests or get a list of all the merge requests.
• Create, close, update and delete a merge request’s note.
• Create, upload ,delete and update a file in the GitLab project.
• Get a list of files in the GitLab project.
• Get the contents and details of a file in GitLab.
• Search for code in the GitLab project.
• Trigger a pipeline in the GitLab project.

Create a Personal Access Token

Personal access tokens (PATs) are an alternative to using passwords for authentication to GitLab when using the GitLab API.
To generate a new token:

1. Navigate to the upper-right corner of any page and click your profile photo.
2. In the left sidebar, click Preferences.
3. In the left sidebar, click Access tokens.
4. Give your token a descriptive name.
5. To give your token an expiration, select the Expiration drop-down menu, then click a default or use the calendar picker.
6. Select the scopes, or permissions, you want to grant this token. The minimum is read-only on repo.
7. Click Create personal access token and copy the api key generated.-+

Create a Trigger Token

Trigger tokens allow you to trigger a pipeline for a branch using it to authenticate on an API call.

Prerequisite:

You must have at least the Maintainer role for the project.

To generate a new token:

1. Navigate to your project.
2. Select Settings > CI/CD.
3. Expand Pipeline triggers.
4. Enter a description and select Add trigger.
   • You can view and copy the full token for all triggers you have created.
   • You can only see the first 4 characters for tokens created by other project members.

Get Project ID

1. Go to the desired project example gitlab.com/username/project1.
2. Under the project name get the argument project_id

Configure GitLab on Cortex XSOAR

1. Navigate to Settings > Integrations > Servers & Services.
2. Search for GitLab.

3. Click Add instance to create and configure a new integration instance.

   Parameter	Description	Required
   Server URL (e.g. https://gitlab.com/api/v4)		False
   API Key	The API Key to use for connection	True
   Trigger Token	The trigger token to run pipelines	False
   Project ID		True
   Trust any certificate (not secure)		False
   Use system proxy settings		False

4. Click Test to validate the URLs, token, and connection.

Commands

You can execute these commands from the Cortex XSOAR CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.

gitlab-version-get

Retrieve version information for this GitLab instance.

Base Command

gitlab-version-get

Input

There are no input arguments for this command.

Context Output

Command example

#### Context Example

```json
{
    "GitLab": {
        "Version": {
            "revision": "4cfc3f317b2",
            "version": "15.5.0-pre"
        }
    }
}

Human Readable Output

GitLab version 15.5.0-pre
reversion: 4cfc3f317b2

gitlab-file-get

Allows to receive information about file in repository like name, size, content.

Base Command

gitlab-file-get

Input

Context Output

gitlab-file-create

This allows you to create a single file. File path or entry_id must be specified.

Base Command

gitlab-file-create

Input

Context Output

Command Example

!gitlab-file-create file_path=path branch=main entry_id=.gitlab-ci.yml author_email=email@google.com author_name=authorName file_content='cfgdfr' commit_message=addFile execute_filemode=True

Human Readable Output

File created successfully.

Base Command

gitlab-file-update

Input

Context Output

Command Example

!gitlab-file-update file_path=./gitlabca branch=thisbranch start_branch=main encoding=base64 author_email=author@email.com author_name=name entry_id=.gitlab-ci.yml file_content="contant of file" commit_message=commit last_commit_id=5 execute_filemode=True

Human Readable Output

File updated successfully.

gitlab-file-delete

Editing existing file in repository.

Base Command

gitlab-file-delete

Input

Context Output

There is no context output for this command.

Command Example

!gitlab-file-delete branch=main file file_path=./gitlabca commit_message=deleteFile

Human Readable Output

File deleted successfully.

gitlab-issue-list

Get a list of a project’s issues.

Base Command

gitlab-issue-list

Input

Context Output

Command Example

!gitlab-issue-list limit=1 page=1 assignee_id=1 assignee_username=Assignusername author_id=4 author_username=usernameAuthoe confidential=False created_after=2000-09-15T17:22:42.246Z created_before=2022-09-15T17:22:42.246Z due_date=2023-09-15T17:22:42.246Z epic_id=1 issue_type=Issue labels=label2 milestone=PR order_by=Weight partial_response=false

Human Readable Output

List Issues

gitlab-issue-update

Updates an existing project issue. This call is also used to mark an issue as closed. The iid can be taken from gitlab-issue-list.

Base Command

gitlab-issue-update

Input

Context Output

Command Example

!gitlab-issue-update issue_iid=20 add_labels=label3 assignee_ids=2 confidential=False description=UpdateDesc discussion_locked=False due_date=2022-09-15T17:22:42.246Z epic_id=1 epic_iid=2 issue_type=Issue milestone_id=16 remove_labels=label1 state_event=Close title=updateTitle partial_response=false

Human Readable Output

Update Issue

gitlab-commit-list

Get a list of repository commits in a project.

Base Command

gitlab-commit-list

Input

Command Example

!gitlab-commit-list limit=1 page=1 commit_id=c156b66b ref_name=main created_before=2022-09-15T17:22:42.246Z created_after=2000-09-15T17:22:42.246Z path=./ all=True with_stats=True first_parent=True order=Default partial_response=false

Human Readable Output

List Commits

Context Output

gitlab-merge-request-list

Get all merge requests for this project.

Base Command

gitlab-merge-request-list

Input

Context Output

Command Example

!gitlab-merge-request-list limit=1 page=1 state=Opened order_by=title sort=asc milestone=Any labels=label1 created_before=2022-11-15T17:22:42.246Z created_after=2000-09-15T17:22:42.246Z updated_after=2000-09-15T17:22:42.246Z updated_before=2022-09-15T17:22:42.246Z scope=All author_id=1 author_username=usernameAuthor assignee_id=1 reviewer_id=6 reviewer_username=username source_branch=sourceBranceName target_branch=main search=gitlab partial_response=false

Human Readable Output

List Merge requests

gitlab-merge-request-create

Creates a new merge request.

Base Command

gitlab-merge-request-create

Input

Context Output

Command Example

!gitlab-merge-request-create source_branch=NewName target_branch=main title=titleName assignee_ids=1 reviewer_ids2 description=description target_project_id=3320 labels=label1 milestone_id=1 remove_source_branch=False allow_collaboration=False allow_maintainer_to_push=False approvals_before_merge=2 squash=False partial_response=false

Human Readable Output

Merge request created successfully

gitlab-merge-request-update

Updates an existing merge request. You can change the target branch, title, or even close the MR.

Base Command

gitlab-merge-request-update

Input

Context Output

Command Example

!gitlab-merge-request-update merge_request_id target_branch=NewName title=newTitle assignee_ids=1 reviewer_ids=2 description=UpdateDesc target_project_id=3003 add_labels=label2 remove_labels=label1 milestone_id=1 state_event=Close remove_source_branch=True squash=True discussion_locked=True allow_collaboration=True allow_maintainer_to_push=True partial_response=false

Human Readable Output

Merge request updated successfully

gitlab-issue-note-create

Creates a new note to a single project issue.

Base Command

gitlab-issue-note-create

Input

Context Output

Command example

!gitlab-issue-note-create issue_iid=4 body=body confidential=True partial_response=false

Context Example

{
    "GitLab": {
        "IssueNote": {
            "attachment": null,
            "author": {
                "avatar_url": "https://secure.gravatar.com/avatar/9c7fbddb174ff5468dd993fb6f83b59a?s=80&d=identicon",
                "id": 12665296,
                "name": "Test Account",
                "state": "active",
                "username": "test9308",
                "web_url": "https://gitlab.com/test9308"
            },
            "body": "body",
            "commands_changes": {},
            "confidential": true,
            "created_at": "2022-10-11T09:35:02.558Z",
            "id": 1131185222,
            "internal": true,
            "noteable_id": 116016614,
            "noteable_iid": 4,
            "noteable_type": "Issue",
            "resolvable": false,
            "system": false,
            "type": null,
            "updated_at": "2022-10-11T09:35:02.558Z"
        }
    }
}

Human Readable Output

Issue note created successfully

gitlab-issue-note-delete

Deletes an existing note of an issue.

Base Command

gitlab-issue-note-delete

Input

Context Output

Command Example

!gitlab-issue-note-delete issue_iid=4 note_id=1045951925

Human Readable Output

Issue note deleted successfully

gitlab-issue-note-update

Modify existing note of an issue.

Base Command

gitlab-issue-note-update

Input

Context Output

Command Example

!gitlab-issue-note-update issue_iid=4 note_id=1045951925 body=UpdatedBody partial_response=false

Human Readable Output

Issue note updated was updated successfully

gitlab-issue-note-list

Gets a list of all notes for a single issue.

Base Command

gitlab-issue-note-list

Input

Context Output

Command Example

!gitlab-issue-note-list limit=1 page=1 partial_response=false

Human Readable Output

List Issue notes

gitlab-merge-request-note-list

Gets a list of all notes for a single merge request.

Base Command

gitlab-merge-request-note-list

Input

Context Output

Command example

!gitlab-merge-request-note-list limit=1 page=1 merge_request_iid=5 sort=asc order_by=created_at partial_response=false

Human Readable Output

List Merge Issue Notes

gitlab-merge-request-note-create

Creates a new note for a single merge request.

Base Command

gitlab-merge-request-note-create

Input

Context Output

Command example

!gitlab-merge-request-note-create merge_request_iid=5 body=body partial_response=false

Context Example

{
    "GitLab": {
        "MergeRequestNote": {
            "attachment": null,
            "author": {
                "avatar_url": "https://secure.gravatar.com/avatar/9c7fbddb174ff5468dd993fb6f83b59a?s=80&d=identicon",
                "id": 12665296,
                "name": "Test Account",
                "state": "active",
                "username": "test9308",
                "web_url": "https://gitlab.com/test9308"
            },
            "body": "body",
            "commands_changes": {},
            "confidential": false,
            "created_at": "2022-10-11T09:35:10.685Z",
            "id": 1131185415,
            "internal": false,
            "noteable_id": 180503976,
            "noteable_iid": 5,
            "noteable_type": "MergeRequest",
            "resolvable": false,
            "system": false,
            "type": null,
            "updated_at": "2022-10-11T09:35:10.685Z"
        }
    }
}

Human Readable Output

Merge request note created successfully.

gitlab-merge-request-note-update

Modify existing note of a merge request.

Base Command

gitlab-merge-request-note-update

Input

Context Output

Command Example

!gitlab-merge-request-note-update merge_request_iid=5 body=UpdatedBody note_id=1100241092

Human Readable Output

Merge request note was updated successfully.

gitlab-merge-request-note-delete

Deletes an existing note of a merge request.

Base Command

gitlab-merge-request-note-delete

Input

Context Output

There is no context output for this command.

Command Example

!gitlab-merge-request-note-delete merge_request_iid=5 note_id=1100241092

Human Readable Output

Merge request note was deleted successfully.

gitlab-issue-create

Create an issue.

Base Command

gitlab-issue-create

Input

Context Output

Command example

!gitlab-issue-create description=issueDescription title=issueTitle labels=label1,label2 partial_response=false

Context Example

{
    "GitLab": {
        "Issue": {
            "_links": {
                "award_emoji": "https://gitlab.com/api/v4/projects/39823965/issues/21/award_emoji",
                "closed_as_duplicate_of": null,
                "notes": "https://gitlab.com/api/v4/projects/39823965/issues/21/notes",
                "project": "https://gitlab.com/api/v4/projects/39823965",
                "self": "https://gitlab.com/api/v4/projects/39823965/issues/21"
            },
            "assignee": null,
            "assignees": [],
            "author": {
                "avatar_url": "https://secure.gravatar.com/avatar/9c7fbddb174ff5468dd993fb6f83b59a?s=80&d=identicon",
                "id": 12665296,
                "name": "Test Account",
                "state": "active",
                "username": "test9308",
                "web_url": "https://gitlab.com/test9308"
            },
            "blocking_issues_count": 0,
            "closed_at": null,
            "closed_by": null,
            "confidential": false,
            "created_at": "2022-10-11T09:34:55.292Z",
            "description": "issueDescription",
            "discussion_locked": null,
            "downvotes": 0,
            "due_date": null,
            "has_tasks": false,
            "id": 116652264,
            "iid": 21,
            "issue_type": "issue",
            "labels": [
                "label1",
                "label2"
            ],
            "merge_requests_count": 0,
            "milestone": null,
            "moved_to_id": null,
            "project_id": 39823965,
            "references": {
                "full": "test9308/gitlabtest#21",
                "relative": "#21",
                "short": "#21"
            },
            "service_desk_reply_to": null,
            "severity": "UNKNOWN",
            "state": "opened",
            "subscribed": true,
            "task_completion_status": {
                "completed_count": 0,
                "count": 0
            },
            "time_stats": {
                "human_time_estimate": null,
                "human_total_time_spent": null,
                "time_estimate": 0,
                "total_time_spent": 0
            },
            "title": "issueTitle",
            "type": "ISSUE",
            "updated_at": "2022-10-11T09:34:55.292Z",
            "upvotes": 0,
            "user_notes_count": 0,
            "web_url": "https://gitlab.com/test9308/gitlabtest/-/issues/21"
        }
    }
}

Human Readable Output

Created Issue

Iid	Title	CreatedAt	CreatedBy	UpdatedAt	State
21	issueTitle	2022-10-11T09:34:55.292Z	Test Account	2022-10-11T09:34:55.292Z	opened

gitlab-project-list

Get a list of all visible projects across GitLab for the authenticated user. When accessed without authentication, only public projects with simple fields are returned.

Base Command

gitlab-project-list

Input

Context Output

Command Example

!gitlab-project-list limit=1 page=1 membership=True order_by=Name owned=True sort=desc visibillity=public with_issues_enabled=True with_merge_requests_enabled=True partial_response=false

Human Readable Output

List Projects

gitlab-group-project-list

Get the list of projects of a given group.

Base Command

gitlab-group-project-list

Input

Context Output

Command Example

!gitlab-group-project-list limit=1 page=1 group_id=1

Human Readable Output

List of the group projects

gitlab-raw-file-get

Get the file in a raw format.

Base Command

gitlab-raw-file-get

Input

Context Output

Command Example

!gitlab-raw-file-get file_path=./gitlabca ref=main

gitlab-branch-create

Creates a new branch in the repository.

Base Command

gitlab-branch-create

Input

Context Output

Command example

!gitlab-branch-create branch=newBranch ref=main partial_response=true

Context Example

{
    "GitLab": {
        "Branch": {
            "can_push": true,
            "commit": {
                "author_email": "test@demistodev.com",
                "author_name": "Test Account",
                "authored_date": "2022-10-02T10:01:15.000+00:00",
                "committed_date": "2022-10-02T10:01:15.000+00:00",
                "committer_email": "test@demistodev.com",
                "committer_name": "Test Account",
                "created_at": "2022-10-02T10:01:15.000+00:00",
                "id": "eadec97163297620df38f9cbc906eff7fa04eb18",
                "message": "Update CheckRawFileCommand_main",
                "parent_ids": [
                    "c4a4c5d80f9cce20108bf5325b88ec73698f92c8"
                ],
                "short_id": "eadec971",
                "title": "Update CheckRawFileCommand_main",
                "trailers": {},
                "web_url": "https://gitlab.com/test9308/gitlabtest/-/commit/eadec97163297620df38f9cbc906eff7fa04eb18"
            },
            "default": false,
            "developers_can_merge": false,
            "developers_can_push": false,
            "merged": false,
            "name": "newBranch",
            "protected": false,
            "web_url": "https://gitlab.com/test9308/gitlabtest/-/tree/newBranch"
        }
    }
}

Human Readable Output

Create Branch

Title	CommitShortId	CommitTitle	CreatedAt	IsMerge	IsProtected
newBranch	eadec971	Update CheckRawFileCommand_main	2022-10-02T10:01:15.000+00:00	false	false

gitlab-branch-delete

Deletes a branch from the repository.

Base Command

gitlab-branch-delete

Input

Context Output

There is no context output for this command.

Command Example

!gitlab-branch-delete branch=new-branch-example

Human Readable Output

Branch deleted successfully

gitlab-merged-branch-delete

Deletes all branches that are merged into the project’s default branch.

Base Command

gitlab-merged-branch-delete

Input

There are no input arguments for this command.

Context Output

There is no context output for this command.

Command example

#### Context Example

```json
{
    "message": "202 Accepted"
}

Human Readable Output

Merged branches Deleted successfully

gitlab-branch-list

Get a list of repository branches from a project, sorted by name alphabetically.

Base Command

gitlab-branch-list

Input

Context Output

Command Example

!gitlab-branch-list limit=1 page=1 branch_name=branchName search=searchString partial_response=false

Human Readable Output

Branch details

gitlab-group-list

Get a list of visible groups for the authenticated user. When accessed without authentication, only public groups are returned. By default, this request returns 20 results at a time because the API results are paginated

Base Command

gitlab-group-list

Input

Context Output

Command Example

!gitlab-group-list limit=1 page=1 skip_groups=1,2 all_available=False search=string order_by=Name sort=asc owned=True min_access_level=1 top_level_only=False

Human Readable Output

List Groups

gitlab-group-member-list

Gets a list of group or project members viewable by the authenticated user.

Base Command

gitlab-group-member-list

Input

Context Output

Command Example

!gitlab-group-member-list group_id=1130

Human Readable Output

List Group Members

gitlab-code-search

Using Scope blobs. Blobs searches are performed on both filenames and contents.

Base Command

gitlab-code-search

Input

Context Output

Command Example

!gitlab-code-search search=testSearch limit=1 page=1

Human Readable Output

Results

gitlab-project-user-list

Get the users list of a project.

Base Command

gitlab-project-user-list

Input

Context Output

Command Example

!gitlab-project-user-list search=DemoName limit=1 page=1

Human Readable Output

List Users

API relevant Scopes for each command

gitlab-pipelines-list

Gets the details of the pipelines.

Base Command

gitlab-pipelines-list

Input

Context Output

gitlab-pipelines-schedules-list

Gets the details of the pipeline schedules.

Base Command

gitlab-pipelines-schedules-list

Input

Context Output

gitlab-jobs-list

Gets job details.

Base Command

gitlab-jobs-list

Input

Context Output

gitlab-artifact-get

Gets an artifact from a given artifact path, corresponding to a given job ID.

Base Command

gitlab-artifact-get

Input

Context Output

gitlab-trigger-pipeline

Triggers a GitLab pipeline on a selected project and branch.

Base Command

gitlab-trigger-pipeline

Input

Context Output

gitlab-cancel-pipeline

Cancels a GitLab pipeline.

Base Command

gitlab-cancel-pipeline

Input

Context Output