조직 초대 목록 조회
조직 초대 목록 조회
주어진 조직의 모든 보류 중인 초대를 반환해요. 팀 소유자만 이 엔드포인트를 호출할 수 있어요. 이 작업은 조직 액세스 토큰(OAT)에서 발급한 bearer 토큰을 받아요.
출처: 문서
본문
GET /v2/orgs/{org_name}/invites
조직 초대 목록 조회 작업이에요. 주어진 조직의 모든 보류 중인 초대를 반환해요. 팀 소유자만 이 엔드포인트를 호출할 수 있어요. 이 작업은 조직 액세스 토큰(OAT)에서 발급한 bearer 토큰을 받아요.
요청 예시
실행 전에 자리 표시자를 바꾸고 필요 자격 증명이나 요청 바디를 채워야 해요.
curl \
--request GET \
--header "Authorization: Bearer ${TOKEN}" \
--header 'Accept: application/json' \
'https://hub.docker.com/v2/orgs/myorganization/invites'
요청과 응답
응답 200 Schema:
{
"examples": [
{
"data": [
{
"created_at": "2021-10-28T18:30:19.520861Z",
"id": "e36eca69-4cc8-4f17-9845-ae8c2b832691",
"invitee": "[email protected]",
"inviter_username": "moby",
"org": "docker",
"team": "owners"
}
]
}
],
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/invite"
},
"type": "array"
}
},
"type": "object"
}
Schema example:
{
"data": [
{
"created_at": "2021-10-28T18:30:19.520861Z",
"id": "e36eca69-4cc8-4f17-9845-ae8c2b832691",
"invitee": "[email protected]",
"inviter_username": "moby",
"org": "docker",
"team": "owners"
}
]
}
응답 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": "Return all pending invites for a given org, only team owners can call this endpoint\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n",
"operationId": "getV2OrgsByOrgNameInvites",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"examples": [
{
"data": [
{
"created_at": "2021-10-28T18:30:19.520861Z",
"id": "e36eca69-4cc8-4f17-9845-ae8c2b832691",
"invitee": "[email protected]",
"inviter_username": "moby",
"org": "docker",
"team": "owners"
}
]
}
],
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/invite"
},
"type": "array"
}
},
"type": "object"
}
}
},
"description": ""
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/not_found"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "List org invites",
"tags": [
"invites"
]
}