GoHarbor

GoHarbor User Group API

The User Group API from GoHarbor — 3 operation(s) for user group.

GitHub OpenAPI

Operations 6

GET /usergroups Get all user groups information #
POST /usergroups Create user group #
GET /usergroups/search Search groups by groupname #
GET /usergroups/{group_id} Get user group information #
PUT /usergroups/{group_id} Update group information #
DELETE /usergroups/{group_id} Delete user group #

Documentation

📖
Documentation
https://goharbor.io/docs/2.15.0/working-with-projects/using-api-explorer/
📖
Documentation
https://goharbor.io/docs/2.15.0/
📖
APIReference
https://goharbor.io/docs/2.15.0/working-with-projects/using-api-explorer/
📖
Documentation
https://goharbor.io/docs/2.15.0/administration/vulnerability-scanning/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/goharbor/refs/heads/main/openapi/goharbor-user-group-api-openapi.yml

Other Resources

🔗
SourceCode
https://github.com/goharbor/harbor
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/goharbor/refs/heads/main/data-model/goharbor-data-model.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/goharbor/refs/heads/main/errors/goharbor-problem-types.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/goharbor/refs/heads/main/asyncapi/goharbor-webhooks.yml
🔗
SourceCode
https://github.com/goharbor/pluggable-scanner-spec

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/goharbor-user-group-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

goharbor-user-group-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Harbor Usergroup API
  description: These APIs provide services for manipulating Harbor project.
  version: '2.0'
servers:
- url: http://localhost/api/v2.0
- url: https://localhost/api/v2.0
security:
- basic: []
- {}
tags:
- name: User Group
paths:
  /usergroups:
    get:
      summary: Get all user groups information
      description: Get all user groups information, it is open for system admin
      operationId: listUserGroups
      tags:
      - User Group
      parameters:
      - $ref: '#/components/parameters/requestId'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pageSize'
      - name: ldap_group_dn
        in: query
        required: false
        description: search with ldap group DN
        schema:
          type: string
      - name: group_name
        in: query
        required: false
        description: group name need to search, fuzzy matches
        schema:
          type: string
      responses:
        '200':
          description: Get user group successfully.
          headers:
            X-Total-Count:
              description: The total count of available items
              schema:
                type: integer
            Link:
              description: Link to previous page and next page
              schema:
                type: string
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserGroup'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '500':
          $ref: '#/components/responses/500'
    post:
      summary: Create user group
      description: Create user group information
      operationId: createUserGroup
      tags:
      - User Group
      parameters:
      - $ref: '#/components/parameters/requestId'
      responses:
        '201':
          description: User group created successfully.
          headers:
            Location:
              description: The URL of the created resource
              schema:
                type: string
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserGroup'
  /usergroups/search:
    get:
      summary: Search groups by groupname
      description: This endpoint is to search groups by group name. It's open for all authenticated requests.
      tags:
      - User Group
      operationId: searchUserGroups
      parameters:
      - $ref: '#/components/parameters/requestId'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pageSize'
      - name: groupname
        in: query
        required: true
        description: Group name for filtering results.
        schema:
          type: string
      responses:
        '200':
          description: Search groups successfully.
          headers:
            X-Total-Count:
              description: The total count of available items
              schema:
                type: integer
            Link:
              description: Link to previous page and next page
              schema:
                type: string
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserGroupSearchItem'
        '401':
          $ref: '#/components/responses/401'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500'
  /usergroups/{group_id}:
    get:
      summary: Get user group information
      operationId: getUserGroup
      tags:
      - User Group
      parameters:
      - $ref: '#/components/parameters/requestId'
      - name: group_id
        in: path
        required: true
        description: Group ID
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: User group get successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroup'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
    put:
      summary: Update group information
      description: Update user group information
      operationId: updateUserGroup
      tags:
      - User Group
      parameters:
      - $ref: '#/components/parameters/requestId'
      - name: group_id
        in: path
        required: true
        description: Group ID
        schema:
          type: integer
          format: int64
      responses:
        '200':
          $ref: '#/components/responses/200'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserGroup'
    delete:
      summary: Delete user group
      operationId: deleteUserGroup
      tags:
      - User Group
      parameters:
      - $ref: '#/components/parameters/requestId'
      - name: group_id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          $ref: '#/components/responses/200'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '500':
          $ref: '#/components/responses/500'
components:
  responses:
    '400':
      description: Bad request. The request body or query parameters are invalid. Inspect the `errors` array in the response body for details.
      headers:
        X-Request-Id:
          description: The ID of the corresponding request for the response
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
    '500':
      description: Internal server error. Inspect the `errors` array in the response body for details.
      headers:
        X-Request-Id:
          description: The ID of the corresponding request for the response
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
    '200':
      description: Success
      headers:
        X-Request-Id:
          description: The ID of the corresponding request for the response
          schema:
            type: string
    '404':
      description: Not found. The requested resource does not exist.
      headers:
        X-Request-Id:
          description: The ID of the corresponding request for the response
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
    '409':
      description: Conflict. The resource already exists or the current state prevents the operation.
      headers:
        X-Request-Id:
          description: The ID of the corresponding request for the response
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
    '401':
      description: Unauthorized. Authentication is required to access this resource.
      headers:
        X-Request-Id:
          description: The ID of the corresponding request for the response
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
    '403':
      description: Forbidden. The caller does not have sufficient permission to perform the requested operation.
      headers:
        X-Request-Id:
          description: The ID of the corresponding request for the response
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
  schemas:
    UserGroup:
      type: object
      properties:
        id:
          type: integer
          description: The ID of the user group
        group_name:
          type: string
          description: The name of the user group
        group_type:
          type: integer
          description: The group type, 1 for LDAP group, 2 for HTTP group, 3 for OIDC group.
        ldap_group_dn:
          type: string
          description: The DN of the LDAP group if group type is 1 (LDAP group).
    Errors:
      description: The error array that describe the errors got during the handling of request
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
    UserGroupSearchItem:
      type: object
      properties:
        id:
          type: integer
          description: The ID of the user group
        group_name:
          type: string
          description: The name of the user group
        group_type:
          type: integer
          description: The group type, 1 for LDAP group, 2 for HTTP group, 3 for OIDC group.
    Error:
      description: a model for all the error response coming from harbor
      type: object
      properties:
        code:
          type: string
          description: The error code
        message:
          type: string
          description: The error message
      example:
        code: NOT_FOUND
        message: artifact library/hello-world:latest not found
  parameters:
    requestId:
      name: X-Request-Id
      description: An unique ID for the request
      in: header
      required: false
      schema:
        type: string
        minLength: 1
    pageSize:
      name: page_size
      in: query
      required: false
      description: The size of per page
      schema:
        type: integer
        format: int64
        default: 10
        maximum: 100
    page:
      name: page
      in: query
      required: false
      description: The page number
      schema:
        type: integer
        format: int64
        default: 1
  securitySchemes:
    basic:
      type: http
      scheme: basic