gitlab-ce/doc/api/group_placeholder_reassignm...

2.6 KiB

stage group info title
Foundations Import and Integrate To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments Group placeholder reassignments API

{{< details >}}

  • Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

{{< /details >}}

{{< history >}}

{{< /history >}}

{{< alert type="flag" >}}

The availability of this feature is controlled by a feature flag. For more information, see the history.

{{< /alert >}}

Prerequisites:

  • You must have the Owner role for the group.

Use the following endpoints to reassign placeholder users in bulk without using the UI.

Download the CSV file

Download a CSV file of pending reassignments.

GET /groups/:id/placeholder_reassignments

Supported attributes:

Attribute Type Required Description
id integer or string yes ID of the group or URL-encoded path of the group.

Example request:

curl \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/2/placeholder_reassignments"

Example response:

Source host,Import type,Source user identifier,Source user name,Source username,GitLab username,GitLab public email
http://gitlab.example,gitlab_migration,11,Bob,bob,"",""
http://gitlab.example,gitlab_migration,9,Alice,alice,"",""

Reassign placeholders

Complete the CSV file and upload it to reassign placeholder users.

POST /groups/:id/placeholder_reassignments

Supported attributes:

Attribute Type Required Description
id integer or string yes ID of the group or URL-encoded path of the group.

Example request:

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
  --form "file=@placeholder_reassignments_for_group_2_1741253695.csv" \
  "http://gdk.test:3000/api/v4/groups/2/placeholder_reassignments"

Example response:

{"message":"The file is being processed and you will receive an email when completed."}