artifact12

auditlog3

configure3

gc7

health1

icon1

immutable4

jobservice6

label5

Ldap4

member5

oidc1

permissions1

ping1

preheat19

project14

projectMetadata5

purge7

quota3

registry9

replication11

repository5

Retention10

robot6

scan3

scan data export4

scanAll6

scanner8

schedule2

search1

securityhub2

statistic1

SystemCVEAllowlist2

systeminfo3

user11

usergroup6

webhook10

webhookjob1

usergroup

Search groups by groupname

This endpoint is to search groups by group name. It's open for all authenticated requests.

get/usergroups/search

Request

Base URL
http://localhost/api/v2.0
Auth
- HTTP basic
- or none
TypeScript
https://skmtc.dev/goharbor/apis/harbor-api/docs/usergroups/search/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

pageinteger

The page number

page_sizeinteger

The size of per page

groupnamestring required

Group name for filtering results.

Headers

X-Request-Idstring

An unique ID for the request

Response

Search groups successfully.

idinteger

The ID of the user group

group_namestring

The name of the user group

group_typeinteger

The group type, 1 for LDAP group, 2 for HTTP group, 3 for OIDC group.

Changes

No recorded changes to this operation across all 1 revision of this API.