Skip to content

Create an instance member role

POST
/api/v4/member_roles

Creates an instance member role.

Media type application/json
object
base_access_level
required

Base Access Level for the configured role

integer
Allowed values: 10 15 20 25 30 40 50
name

Name for role (default: ‘Custom’)

string
nullable
description

Description for role

string
nullable
apply_security_scan_profiles

Apply security scan profiles.

boolean
nullable
admin_merge_request

Allows approval of merge requests.

boolean
nullable
archive_project

Allows archiving of projects.

boolean
nullable
admin_ai_catalog_item_consumer

Enable, disable, and configure custom agents and flows from the AI catalog for a project.

boolean
nullable
destroy_package

Delete packages and package files in the package registry.

boolean
nullable
remove_project

Allows deletion of projects.

boolean
nullable
remove_group

Ability to delete or restore a subgroup. This ability does not allow deleting top-level groups. Review the retention period settings to prevent accidental deletion.

boolean
nullable
manage_security_policy_link

Allows linking security policy projects.

boolean
nullable
admin_ai_catalog_item

Create, edit, and delete custom agents and flows in the AI catalog.

boolean
nullable
admin_compliance_framework

Create, read, update, and delete compliance frameworks. Users with this permission can also assign a compliance framework label to a project, and set the default framework of a group.

boolean
nullable
admin_cicd_variables

Create, read, update, and delete CI/CD variables.

boolean
nullable
manage_deploy_tokens

Manage deploy tokens at the group or project level.

boolean
nullable
manage_group_access_tokens

Create, read, update, and delete group access tokens. When creating a token, users with this custom permission must select a role for that token that has the same or fewer permissions as the default role used as the base for the custom role.

boolean
nullable
admin_group_member

Add or remove users in a group, and assign roles to users. When assigning a role, users with this custom permission must select a role that has the same or fewer permissions as the default role used as the base for their custom role.

boolean
nullable
admin_integrations

Create, read, update, and delete integrations with external applications.

boolean
nullable
manage_merge_request_settings

Configure merge request settings at the group or project level. Group actions include managing merge checks and approval settings. Project actions include managing MR configurations, approval rules and settings, and branch targets. In order to enable Suggested reviewers, the “Manage project access tokens” custom permission needs to be enabled.

boolean
nullable
manage_project_access_tokens

Create, read, update, and delete project access tokens. When creating a token, users with this custom permission must select a role for that token that has the same or fewer permissions as the default role used as the base for the custom role.

boolean
nullable
admin_protected_branch

Create, read, update, and delete protected branches for a project.

boolean
nullable
admin_protected_environments

Create, read, update, and delete protected environments

boolean
nullable
admin_push_rules

Configure push rules for repositories at the group or project level.

boolean
nullable
admin_runners

Create, view, edit, and delete group or project Runners. Includes configuring Runner settings.

boolean
nullable
admin_security_attributes

Manage the security categories and attributes belonging to a top-level group. Also requires the read_security_attribute permission.

boolean
nullable
admin_terraform_state

Execute terraform commands, lock/unlock terraform state files, and remove file versions.

boolean
nullable
admin_vulnerability

Edit the status, linked issue, and severity of a vulnerability object. Also requires the read_vulnerability permission.

boolean
nullable
admin_web_hook

Manage webhooks

boolean
nullable
read_agent_artifacts

Read GitLab Duo Agent Platform artifacts, including audit events and session metadata, that are exposed through the agent artifacts dashboard.

boolean
nullable
read_compliance_dashboard

Read compliance capabilities including adherence, violations, and frameworks for groups and projects.

boolean
nullable
read_security_scan_profiles

Read security scan profiles.

boolean
nullable
read_virtual_registry

Allows read access to virtual registries at the group level. Enables users to resolve packages through the virtual registry without requiring broader group membership permissions. Only works on top level groups.

boolean
nullable
update_sec_ai_workflow_settings

Update security AI workflow settings such as SAST Vulnerability Resolution. Also requires the read_vulnerability permission.

boolean
nullable
read_admin_cicd

Read CI/CD details for runners and jobs in the Admin Area.

boolean
nullable
read_crm_contact

Read CRM contact.

boolean
nullable
read_dependency

Allows read-only access to the dependencies and licenses.

boolean
nullable
read_admin_groups

Read group details in the Admin Area.

boolean
nullable
read_admin_projects

Read project details in the Admin Area.

boolean
nullable
read_code

Allows read-only access to the source code in the user interface. Does not allow users to edit or download repository archives, clone or pull repositories, view source code in an IDE, or view merge requests for private projects. You can download individual files because read-only access inherently grants the ability to make a local copy of the file.

boolean
nullable
read_runners

Allows read-only access to group or project runners, including the runner fleet dashboard.

boolean
nullable
read_security_attribute

Allows read-only access to the security categories and attributes that belong to a top-level group.

boolean
nullable
read_admin_subscription

Read subscription details in the Admin area.

boolean
nullable
read_admin_monitoring

Read system information such as background migrations, health checks, and Gitaly in the Admin Area.

boolean
nullable
read_admin_users

Read the user list and user details in the Admin area.

boolean
nullable
read_vulnerability

Read vulnerability reports and security dashboards.

boolean
nullable

Created

Media type application/json
object
id
integer format: int64
group_id
integer format: int64
name
string
description
string
base_access_level
integer
apply_security_scan_profiles
boolean
admin_merge_request
boolean
archive_project
boolean
admin_ai_catalog_item_consumer
boolean
destroy_package
boolean
remove_project
boolean
remove_group
boolean
manage_security_policy_link
boolean
admin_ai_catalog_item
boolean
admin_compliance_framework
boolean
admin_cicd_variables
boolean
manage_deploy_tokens
boolean
manage_group_access_tokens
boolean
admin_group_member
boolean
admin_integrations
boolean
manage_merge_request_settings
boolean
manage_project_access_tokens
boolean
admin_protected_branch
boolean
admin_protected_environments
boolean
admin_push_rules
boolean
admin_runners
boolean
admin_security_attributes
boolean
admin_terraform_state
boolean
admin_vulnerability
boolean
admin_web_hook
boolean
read_agent_artifacts
boolean
read_compliance_dashboard
boolean
read_security_scan_profiles
boolean
read_virtual_registry
boolean
update_sec_ai_workflow_settings
boolean
read_admin_cicd
boolean
read_crm_contact
boolean
read_dependency
boolean
read_admin_groups
boolean
read_admin_projects
boolean
read_code
boolean
read_runners
boolean
read_security_attribute
boolean
read_admin_subscription
boolean
read_admin_monitoring
boolean
read_admin_users
boolean
read_vulnerability
boolean
Example
{
"id": 2,
"group_id": 2,
"name": "Custom guest",
"description": "Guest user who can also read_code",
"base_access_level": 40,
"apply_security_scan_profiles": false,
"admin_merge_request": false,
"archive_project": false,
"admin_ai_catalog_item_consumer": false,
"destroy_package": false,
"remove_project": false,
"remove_group": false,
"manage_security_policy_link": false,
"admin_ai_catalog_item": false,
"admin_compliance_framework": false,
"admin_cicd_variables": false,
"manage_deploy_tokens": false,
"manage_group_access_tokens": false,
"admin_group_member": false,
"admin_integrations": false,
"manage_merge_request_settings": false,
"manage_project_access_tokens": false,
"admin_protected_branch": false,
"admin_protected_environments": false,
"admin_push_rules": false,
"admin_runners": false,
"admin_security_attributes": false,
"admin_terraform_state": false,
"admin_vulnerability": false,
"admin_web_hook": false,
"read_agent_artifacts": false,
"read_compliance_dashboard": false,
"read_security_scan_profiles": false,
"read_virtual_registry": false,
"update_sec_ai_workflow_settings": false,
"read_admin_cicd": false,
"read_crm_contact": false,
"read_dependency": false,
"read_admin_groups": false,
"read_admin_projects": false,
"read_code": false,
"read_runners": false,
"read_security_attribute": false,
"read_admin_subscription": false,
"read_admin_monitoring": false,
"read_admin_users": false,
"read_vulnerability": false
}

Bad Request

Unauthorized