초대 ID로 1개의 조직 초대 업데이트

이 페이지의 내용

필수 역할

Resource
요청 경로 매개변수
요청 쿼리 매개변수
요청 본문 매개변수
응답
요청 예시
응답 예시
응답 헤더
응답 본문

Cloud Manager는 2024년 8월 30일부터 더 이상 MongoDB 3.6 및 4.0에 대한 자동화, 백업 및 모니터링을 지원하지 않습니다. MongoDB 배포를 업그레이드하거나 Atlas로 마이그레이션하세요.

Cloud Manager 에 대한 프로그래밍 방식의 액세스 를 위한 OAuth 2.0 인증 은 Preview 기능 으로 제공됩니다.: 기능 및 해당 설명서는 미리 보기 기간에 언제든지 변경될 수 있습니다. OAuth 2.0 인증 을 사용하려면 Cloud Manager 공개 API 에 대한 요청에 사용할 서비스 계정 을 만듭니다.

지정한 Cloud Manager 조직 에 대해 {INVITATION-ID} 이(가) 대기 중인 초대 한 개를 업데이트합니다.

모든 조직 초대 가져오기 엔드포인트를 사용하여 대기 중인 모든 조직 초대의 ID를 조회 합니다.

필수 역할

Organization User Admin 역할을 사용하여 이 엔드포인트를 성공적으로 호출할 수 있습니다.

Resource

기본 URL: https://cloud.mongodb.com/api/public/v1.0

PATCH /orgs/{ORG-ID}/invites/{INVITATION-ID}

요청 경로 매개변수

경로 요소	유형	필요성	설명
ORG-ID	문자열	필수 사항	조직을 식별하는 고유한 24자리 16진수 문자열입니다.
INVITATION-ID	문자열	필수 사항	초대를 식별하는 고유한 24자리 16진수 문자열입니다.

요청 쿼리 매개변수

다음 쿼리 매개변수는 선택 사항입니다.

이름

유형

필요성

설명

기본값

pretty

부울

옵션

응답 본문을 프리티프린트 에 포함해야 하는지 여부를 나타내는 플래그입니다. 형식.

false

envelope

부울

옵션

응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다.

일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다.

하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.

이름	설명
`status`	HTTP 응답 코드
`content`	예상되는 응답 본문

false

요청 본문 매개변수

본문 매개변수	유형	필요성	설명
roles	문자열 배열	필수 사항	초대된 사용자에게 할당할 Cloud Manager 역할 입니다. 사용자가 초대를 수락하면 Cloud Manager가 이러한 역할을 할당합니다. 중요: Cloud Manager 는 초대의 역할 을 이 요청 에서 제공한 역할로 대체합니다. 이 요청 에 사용자에게 할당하려는 모든 역할을 포함해야 합니다.

응답

이름	유형	설명
createdAt	문자열	ISO 8601 의 타임스탬프 Cloud Manager가 초대를 보낸 UTC 의 날짜 및 시간 형식입니다.
expiresAt	문자열	ISO 8601 의 타임스탬프 초대가 만료되는 경우 UTC 의 날짜 및 시간 형식입니다. 사용자는 30일 이내에 Cloud Manager 프로젝트에 대한 초대를 수락할 수 있습니다.
id	문자열	초대를 식별하는 고유한 24자리 16진수 문자열입니다.
초대자 사용자 이름	문자열	조직에 사용자 이름 을 초대한 Cloud Manager 사용자입니다.
orgId	문자열	조직을 식별하는 고유한 24자리 16진수 문자열입니다.
orgName	문자열	조직의 이름입니다.
roles	문자열 배열	초대된 사용자에게 할당할 Cloud Manager 역할 입니다. 사용자가 초대를 수락하면 Cloud Manager가 이러한 역할을 할당합니다.
teamIds	문자열 배열	사용자가 가입하도록 초대된 팀을 식별하는 고유한 24자리 16진수 문자열입니다.
사용자 이름	문자열	Cloud Manager가 초대를 보낸 이메일 주소입니다. 사용자가 초대를 수락하면 이 이메일 주소를 Cloud Manager 사용자 이름으로 사용합니다.

요청 예시

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --request PATCH "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invites/{INVITATION-ID}?pretty=true" \
5      --data '
6        {
7          "roles": [
8            "ORG_OWNER"
9          ]
10        }'

응답 예시

응답 헤더

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

응답 본문

1 {
2   "createdAt": "2021-02-18T21:05:40Z",
3   "expiresAt": "2021-03-20T21:05:40Z",
4   "id": "{INVITATION-ID}",
5   "inviterUsername": "admin@example.com",
6   "orgId": "{ORG-ID}",
7   "orgName": "{ORG-NAME}",
8   "roles": [
9     "ORG_OWNER"
10   ],
11   "teamIds": [],
12   "username": "wyatt.smith@example.com"
13 }

돌아가기

1개의 조직 초대 받기

1개의 조직 초대 업데이트

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--request PATCH "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invites/{INVITATION-ID}?pretty=true" \
5	--data '
6	{
7	"roles": [
8	"ORG_OWNER"
9	]
10	}'

1	{
2	"createdAt": "2021-02-18T21:05:40Z",
3	"expiresAt": "2021-03-20T21:05:40Z",
4	"id": "{INVITATION-ID}",
5	"inviterUsername": "admin@example.com",
6	"orgId": "{ORG-ID}",
7	"orgName": "{ORG-NAME}",
8	"roles": [
9	"ORG_OWNER"
10	],
11	"teamIds": [],
12	"username": "wyatt.smith@example.com"
13	}