문서 메뉴

문서 홈 → MongoDB Ops Manager

모든 프로젝트 초대 가져오기

이 페이지의 내용

  • 필수 역할
  • 리소스
  • 요청 경로 매개변수
  • 요청 쿼리 매개변수
  • 요청 본문 매개변수
  • 응답
  • 요청 예시
  • 응답 예시
  • 응답 헤더
  • 응답 본문

지정된 Ops Manager 프로젝트에 대해 대기 중인 모든 초대를 검색합니다.

필수 역할

Project User Admin 역할로 이 엔드포인트를 성공적으로 호출할 수 있습니다.

리소스

기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /groups/{GROUP-ID}/invites

요청 경로 매개변수

경로 요소
유형
필요성
설명
그룹 ID
문자열
필수 사항
프로젝트를 식별하는 고유한 24자리 16진수 문자열.

요청 쿼리 매개변수

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

이름
유형
필요성
설명
기본값
pretty
부울
옵션
응답 본문을 프리티프린트 에 포함해야 하는지 여부를 나타내는 플래그입니다. 형식.
false
envelope
부울
옵션

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

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

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

이름
설명
상태
HTTP 응답 코드
envelope
예상되는 응답 본문
false
사용자 이름
문자열
옵션

초대된 사용자의 이메일 주소입니다. 이 주소는 Ops Manager가 초대를 보낸 주소입니다.

이를 생략하면 Ops Manager는 대기 중인 모든 초대를 반환합니다.

요청 본문 매개변수

이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.

응답

응답 JSON 문서에는 객체 배열이 포함되어 있습니다. 각 객체는 Ops Manager 프로젝트에 대한 초대 한 건을 나타냅니다.

이름
유형
설명
createdAt
문자열
ISO 8601 의 타임스탬프 Ops Manager가 초대를 보낸 UTC 의 날짜 및 시간 형식입니다.
expiresAt
문자열

ISO 8601 의 타임스탬프 초대가 만료되는 경우 UTC 의 날짜 및 시간 형식입니다.

팁

사용자는 30일 이내에 Ops Manager 프로젝트 초대를 수락할 수 있습니다.

groupId
문자열
프로젝트를 식별하는 고유한 24자리 16진수 문자열.
groupName
문자열
프로젝트의 이름입니다.
id
문자열
초대를 식별하는 고유한 24자리 16진수 문자열입니다.
초대자 사용자 이름
문자열
프로젝트에 사용자 이름 을 초대한 Ops Manager 사용자입니다.
roles
문자열 배열

초대된 사용자에게 할당할 Ops Manager 역할 입니다.

사용자가 초대를 수락하면 Ops Manager가 사용자에게 이러한 역할을 할당합니다.

사용자 이름
문자열

Ops Manager가 초대를 보낸 이메일 주소입니다.

사용자가 초대를 수락하면 이 이메일 주소를 Ops Manager 사용자 이름으로 사용합니다.

요청 예시

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \
     --header "Accept: application/json" \
     --request GET "https://opsmanager.example.com/api/public/v1.0/groups/{GROUP-ID}/invites?pretty=true"

응답 예시

응답 헤더

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  {
3    "createdAt": "2021-02-18T18:51:46Z",
4    "expiresAt": "2021-03-20T18:51:46Z",
5    "groupId": "{GROUP-ID}",
6    "groupName": "group",
7    "id": "{INVITATION-ID}",
8    "inviterUsername": "admin@example.com",
9    "roles": [
10      "GROUP_OWNER"
11    ],
12    "username": "jane.smith@example.com"
13  },
14  {
15    "createdAt": "2021-02-18T21:05:40Z",
16    "expiresAt": "2021-03-20T21:05:40Z",
17    "groupId": "{GROUP-ID}",
18    "groupName": "group",
19    "id": "{INVITATION-ID}",
20    "inviterUsername": "admin@example.com",
21    "roles": [
22      "GROUP_READ_ONLY"
23    ],
24    "username": "john.smith@example.com"
25  }
26]
← 1개의 프로젝트 초대 삭제
1개의 프로젝트 초대 받기 →

이 페이지의 내용