git-lab-preflight

List GitLab groups accessible to a PAT

post/workspaces/gitlab/groups

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /workspaces/gitlab/groups
  • Auth: HTTP bearer

Request body

groupFullPathstring

GitLab group full path, used to validate the token against the group when /api/v4/user refuses it

personalAccessTokenstring required

GitLab Personal Access Token to validate

serverUrlstring

The default GitLab instance this server reads from, which is also used when omitted; any other instance is refused.

Example request

{
  "groupFullPath": "my-org/my-team",
  "personalAccessToken": "your-gitlab-token",
  "serverUrl": "https://gitlab.example.com"
}

Response

Accessible groups

avatarUrlstring

Group avatar URL

fullPathstring required

Full group path including parent groups

idinteger required

GitLab group numeric ID

namestring required

Group display name

visibilitystring

Group visibility: public, internal, or private

webUrlstring

Group web URL

Example response

[
  {
    "fullPath": "my-org/my-team"
  }
]

Changes

No recorded changes to this operation across all 50 revisions of this API.