조직의 그룹 목록 조회

조직의 그룹 목록 조회

조직의 그룹 목록을 반환해요. 이 작업은 조직 액세스 토큰(OAT)에서 발급한 bearer 토큰을 받아요.

출처: 문서

본문

GET /v2/orgs/{org_name}/groups

조직의 그룹 목록 조회 작업이에요. 조직의 그룹 목록을 반환해요. 이 작업은 조직 액세스 토큰(OAT)에서 발급한 bearer 토큰을 받아요.

요청 예시

실행 전에 자리 표시자를 바꾸고 필요 자격 증명이나 요청 바디를 채워야 해요.

curl \
  --request GET \
  --header "Authorization: Bearer ${TOKEN}" \
  --header 'Accept: application/json' \
  'https://hub.docker.com/v2/orgs/myorganization/groups'

요청과 응답

응답 200 Schema:

{
  "examples": [
    {
      "count": 1,
      "next": null,
      "previous": null,
      "results": [
        {
          "description": "Development team",
          "id": 10,
          "member_count": 1,
          "name": "developers",
          "role": "member",
          "uuid": "e36eca69-4cc8-4f17-9845-ae8c2b832691"
        }
      ]
    }
  ],
  "properties": {
    "count": {
      "example": 1,
      "type": "number"
    },
    "next": {
      "example": null,
      "type": [
        "string",
        "null"
      ]
    },
    "previous": {
      "example": null,
      "type": [
        "string",
        "null"
      ]
    },
    "results": {
      "items": {
        "$ref": "#/components/schemas/org_group"
      },
      "type": "array"
    }
  },
  "type": "object"
}

Schema example:

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "description": "Development team",
      "id": 10,
      "member_count": 1,
      "name": "developers",
      "role": "member",
      "uuid": "e36eca69-4cc8-4f17-9845-ae8c2b832691"
    }
  ]
}

응답 401 Unauthorized

Schema:

{
  "$ref": "#/components/schemas/error"
}

error:

{
  "errinfo": null,
  "message": "unauthorized"
}

응답 403 Forbidden

Schema:

{
  "$ref": "#/components/schemas/error"
}

error:

{
  "errinfo": null,
  "message": "permission denied"
}

응답 404 Not Found

Schema:

{
  "$ref": "#/components/schemas/error"
}

error:

{
  "errinfo": null,
  "message": "not found"
}

전체 작업 계약

{
  "description": "Get groups of an organization.\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n",
  "operationId": "getV2OrgsByOrgNameGroups",
  "parameters": [
    {
      "$ref": "#/components/parameters/page"
    },
    {
      "$ref": "#/components/parameters/page_size"
    },
    {
      "description": "Get groups for the specified username in the organization.",
      "in": "query",
      "name": "username",
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Get groups for the specified group in the organization.",
      "in": "query",
      "name": "search",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "examples": [
              {
                "count": 1,
                "next": null,
                "previous": null,
                "results": [
                  {
                    "description": "Development team",
                    "id": 10,
                    "member_count": 1,
                    "name": "developers",
                    "role": "member",
                    "uuid": "e36eca69-4cc8-4f17-9845-ae8c2b832691"
                  }
                ]
              }
            ],
            "properties": {
              "count": {
                "example": 1,
                "type": "number"
              },
              "next": {
                "example": null,
                "type": [
                  "string",
                  "null"
                ]
              },
              "previous": {
                "example": null,
                "type": [
                  "string",
                  "null"
                ]
              },
              "results": {
                "items": {
                  "$ref": "#/components/schemas/org_group"
                },
                "type": "array"
              }
            },
            "type": "object"
          }
        }
      },
      "description": ""
    },
    "401": {
      "$ref": "#/components/responses/unauthorized"
    },
    "403": {
      "$ref": "#/components/responses/forbidden"
    },
    "404": {
      "$ref": "#/components/responses/not_found"
    }
  },
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "summary": "Get groups of an organization",
  "tags": [
    "groups"
  ]
}

참조된 스키마

더 알아보기