---
sidebar_label: GitLab repository and access
doc_id: 092c915d-766e-49db-a098-2f5444a4c5f5
description: >-
  Configure GitLab integration with repository setup, authentication, and
  collaborator access permissions.
keywords:
  - GitLab
  - repository configuration
  - access control
  - authentication
  - API integration
---

# GitLab repository and access

Defines the setup and access settings for GitLab integration, including installation details and collaborator permissions.

**Type**: `gitlab-configuration`

**Properties**

|Name|Type|Description|Required|
|----|----|-----------|--------|
|[**setup**](#setup)|`object`|Initial setup details for GitLab integration, including installation URL, authentication, and default repository settings.<br/>|yes|
|[**access**](#access)<br/>(Default Collaborators)|`object`|Defines the default access levels for collaborators within repositories.<br/>|no|

**Additional Properties:** not allowed  
**Example**

```json
{
    "setup": {
        "group_path": "my-organization/my-group",
        "access_token": "glpat-XXXXXXXXXXXXXXXXXXXXX",
        "installation_url": "https://gitlab.com"
    },
    "access": {
        "default_collaborators": [
            {
                "id": "np-pilundain",
                "role": "developer",
                "type": "user"
            },
            {
                "id": "wallet",
                "role": "developer",
                "type": "group"
            }
        ]
    }
}
```

<a name="setup"></a>
## setup: Setup

Initial setup details for GitLab integration, including installation URL, authentication, and default repository settings.

**Properties**

|Name|Type|Description|Required|
|----|----|-----------|--------|
|**group\_path**|`string`|The complete path to your GitLab group, including any parent groups.<br/>Minimal Length: `1`<br/>Pattern: `^[\w.-]+(?:/[\w.-]+)*$`<br/>|no|
|**access\_token**|`string`|The GitLab personal access token or project access token with appropriate permissions.<br/>Minimal Length: `20`<br/>|yes|
|**installation\_url**|`string`|The base URL of your GitLab installation. Defaults to GitLab SaaS (gitlab.com).<br/>Minimal Length: `1`<br/>Pattern: `^https?://[\w.-]+(?::\d+)?$`<br/>|yes|

**Additional Properties:** not allowed  
**Example**

```json
{
    "group_path": "my-organization/my-group",
    "access_token": "glpat-XXXXXXXXXXXXXXXXXXXXX",
    "installation_url": "https://gitlab.com"
}
```

<a name="access"></a>
## access: Default Collaborators

Defines the default access levels for collaborators within repositories.

**Properties**

|Name|Type|Description|Required|
|----|----|-----------|--------|
|[**default\_collaborators**](#accessdefault_collaborators)<br/>(Collaborators)|`object[]`|List of collaborators and their corresponding access levels.<br/>|no|

**Additional Properties:** not allowed  
**Example**

```json
{
    "default_collaborators": [
        {
            "id": "np-pilundain",
            "role": "developer",
            "type": "user"
        },
        {
            "id": "wallet",
            "role": "developer",
            "type": "group"
        }
    ]
}
```

<a name="accessdefault_collaborators"></a>
### access\.default\_collaborators\[\]: Collaborators

List of collaborators and their corresponding access levels.

**Items**

**Item Properties**

|Name|Type|Description|Required|
|----|----|-----------|--------|
|**id**<br/>(Name)|`string`|GitLab username or group name<br/>Minimal Length: `1`<br/>Pattern: `^[a-zA-Z][a-zA-Z0-9_.-]*$`<br/>|yes|
|**role**<br/>(Permission Level)|`string`|Access level for the member or group<br/>Enum: `"no access"`, `"minimal access"`, `"guest"`, `"reporter"`, `"developer"`, `"maintainer"`, `"owner"`<br/>|yes|
|**type**<br/>(Collaborator Type)|`string`|Type of collaborator<br/>Enum: `"user"`, `"group"`<br/>|yes|

**Item Additional Properties:** not allowed  
**Example**

```json
[
    {
        "id": "np-pilundain",
        "role": "developer",
        "type": "user"
    },
    {
        "id": "wallet",
        "role": "developer",
        "type": "group"
    }
]
```