지정된 Cloud Manager 프로젝트에 대기 중인 초대 한 개의 세부 정보를 조회합니다.
필수 역할
Project User Admin 역할 을 사용하여 이 엔드포인트를 성공적으로 호출할 수 있습니다.
Resource
기본 URL: https://cloud.mongodb.com/api/public/v1.0
POST /groups/{GROUP-ID}/invites/{INVITATION-ID}
요청 경로 매개변수
경로 요소 | 유형 | 필요성 | 설명 |
|---|---|---|---|
그룹 ID | 문자열 | 필수 사항 | 프로젝트를 식별하는 고유한 24자리 16진수 문자열. |
요청 쿼리 매개변수
다음 쿼리 매개변수는 선택 사항입니다.
이름 | 유형 | 필요성 | 설명 | 기본값 | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | 부울 | 옵션 | 응답 본문이 pretty-print 형식이어야 하는지 여부를 나타내는 플래그입니다. |
| ||||||
envelope | 부울 | 옵션 | 응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.
|
|
요청 본문 매개변수
이름 | 유형 | 설명 |
|---|---|---|
roles | 문자열 배열 | 초대된 사용자에게 할당할 Cloud Manager 역할 입니다. 사용자가 초대를 수락하면 Cloud Manager가 이러한 역할을 할당합니다. |
사용자 이름 | 문자열 | Cloud Manager가 초대를 보낸 이메일 주소입니다. 사용자가 이 초대를 수락하면 이 이메일 주소를 Cloud Manager 사용자 이름으로 사용합니다. |
응답
이름 | 유형 | 설명 |
|---|---|---|
createdAt | 문자열 | Cloud Manager 초대를 보냈을 때 ISO 8601 날짜 및 시간 형식(UTC 기준)의 타임스탬프입니다. |
expiresAt | 문자열 | 초대가 만료될 때 ISO 8601 날짜 및 시간 형식(UTC)의 타임스탬프입니다. 사용자는 30일 이내에 Cloud Manager 프로젝트에 대한 초대를 수락할 수 있습니다. |
groupId | 문자열 | 프로젝트를 식별하는 고유한 24자리 16진수 문자열. |
groupName | 문자열 | 프로젝트의 이름입니다. |
id | 문자열 | 초대를 식별하는 고유한 24자리 16진수 문자열입니다. |
초대자 사용자 이름 | 문자열 | 프로젝트에 사용자 이름 을 초대한 Cloud Manager 사용자입니다. |
roles | 문자열 배열 | 초대된 사용자에게 할당할 Cloud Manager 역할 입니다. 사용자가 초대를 수락하면 Cloud Manager가 이러한 역할을 할당합니다. |
사용자 이름 | 문자열 | Cloud Manager가 초대를 보낸 이메일 주소입니다. 사용자가 초대를 수락하면 이 이메일 주소를 Cloud Manager 사용자 이름으로 사용합니다. |
요청 예시
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \ --header "Accept: application/json" \ --request POST "https://cloud.mongodb.com/api/public/v1.0/groups/{GROUP-ID}/invites?pretty=true"
응답 예시
응답 헤더
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
201 Created 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-18T18:51:46Z", 3 "expiresAt": "2021-03-20T18:51:46Z", 4 "groupId": "{GROUP-ID}", 5 "groupName": "group", 6 "id": "{INVITATION-ID}", 7 "inviterUsername": "admin@example.com", 8 "roles": [ 9 "GROUP_OWNER" 10 ], 11 "username": "jane.smith@example.com" 12 }