Docs Menu
Docs Home
/
MongoDB Ops Manager
/
API
/
Ops Manager 관리 API 리소스
/
프로그래밍 방식 API 키
/
프로젝트의 조직 API 키

1개의 프로젝트에 할당된 모든 조직 API 키 가져오기

이 페이지의 내용

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

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

Resource

GET /groups/{PROJECT-ID}/apiKeys

요청 경로 매개변수

이름
유형
설명
PROJECT-ID
문자열
할당된 조직 API 키를 조회 하려는 프로젝트의 고유 식별자입니다. /groups 엔드포인트를 사용하여 인증된 사용자가 액세스 있는 모든 프로젝트를 조회 합니다.

요청 쿼리 매개변수

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

이름
유형
설명
기본값
pageNum
integer
페이지 번호(1-인덱스 기준)입니다.
1
itemsPerPage
integer
페이지당 반환할 항목 수. 최대 500개까지 가능합니다.
100
pretty
부울
응답 본문이 프리티프린트 에 있어야 하는지 여부를 나타냅니다. 형식.
false
envelope
부울

응답을 엔벨로프에 래핑할지 여부를 나타냅니다.

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

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

상태
HTTP 응답 코드
envelope
예상되는 응답 본문

결과 목록을 반환하는 엔드포인트의 경우 results 객체는 엔벨로프입니다. Ops Manager가 응답 본문에 status 필드를 추가합니다.

none

요청 본문 매개변수

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

응답

응답 문서

응답 JSON 문서에는 result 객체 배열, link 객체 배열, 조회된 result 객체의 총 개수가 포함되어 있습니다.

이름
유형
설명
results
배열
배열에는 results 내장된 문서 섹션에 자세히 설명된 각 항목에 대해 하나의 객체가 포함됩니다.
links
배열
배열에 하위 리소스 및/또는 관련 리소스에 대한 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에설명되어 있습니다.
totalCount
숫자
결과 집합에 있는 총 항목 수의 정수 개수입니다. 전체 결과 집합이 페이지로 매겨진 경우 results 배열의 객체 수보다 클 수 있습니다.

results embeddedDocument

각 결과 는 하나의 프로젝트 API 키입니다.

이름
유형
설명
desc
문자열
이 프로젝트에 할당된 이 조직 API 키에 대한 설명입니다.
id
문자열
이 프로젝트에 할당된 이 조직 API 키의 고유 식별자입니다.
privateKey
문자열

이 프로젝트에 할당된 이 조직 API 키의 수정된 비공개 키입니다.

이 키는 처음 생성될 때 수정되지 않은 상태로 표시됩니다.

publicKey
문자열
이 프로젝트에 할당된 이 조직 API 키의 공개 키입니다.
roles
객체 배열
이 프로젝트에 할당된 조직 API 키가 갖는 역할입니다. 이 배열은 사용자가 Ops Manager에서 가지고 있는 모든 조직 및 프로젝트 역할을 반환합니다.
roles.groupId
문자열
이 역할이 속한 프로젝트의 고유 식별자입니다.
roles.orgId
문자열
이 역할이 속한 조직의 고유 식별자입니다.
roles.roleName
문자열

역할의 이름입니다. 이 리소스는 사용자가 Ops Manager에서 가지고 있는 모든 역할을 반환합니다. 가능한 값은 다음과 같습니다.

조직 역할

roles.orgId (조직)인 경우 값은 다음과 같습니다.

API의 역할 값
역할
ORG_OWNER
ORG_MEMBER
ORG_GROUP_CREATOR
ORG_READ_ONLY

프로젝트 역할

roles.groupId (프로젝트)인 경우 값에는 다음이 포함됩니다.

API의 역할 값
역할
GROUP_AUTOMATION_ADMIN
GROUP_BACKUP_ADMIN
GROUP_DATA_ACCESS_ADMIN
GROUP_DATA_ACCESS_READ_ONLY
GROUP_DATA_ACCESS_READ_WRITE
GROUP_MONITORING_ADMIN
GROUP_OWNER
GROUP_READ_ONLY
GROUP_USER_ADMIN

요청 예시

참고

요청을 하는 사용자의 형식은 {USERNAME}:{APIKEY} 또는 {PUBLIC-KEY}:{PRIVATE-KEY}로 지정할 수 있습니다.

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2  --header "Accept: application/json" \
3  --include \
4  --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/apiKeys?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  "links" : [ {
3    "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/apiKeys?pretty=true&pageNum=1&itemsPerPage=100",
4    "rel" : "self"
5  } ],
6  "results" : [ {
7    "desc" : "Updated API Key description for DOCSP-6042",
8    "id" : "5d1cf1f980eef570c9fc87e5",
9    "links" : [ {
10      "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/5980cfe20b6d97029d82fa63/apiKeys/5d1cf1f980eef570c9fc87e5",
11      "rel" : "self"
12    } ],
13    "privateKey" : "********-****-****-9d4ae38e4ddd",
14    "publicKey" : "{PUBLIC-KEY}",
15    "roles" : [ {
16      "groupId" : "{PROJECT-ID}",
17      "roleName" : "GROUP_AUTOMATION_ADMIN"
18    }, {
19      "groupId" : "{PROJECT-ID}",
20      "roleName" : "GROUP_MONITORING_ADMIN"
21    }, {
22      "orgId" : "5980cfe20b6d97029d82fa63",
23      "roleName" : "ORG_MEMBER"
24    }, {
25      "groupId" : "{PROJECT-ID}",
26      "roleName" : "GROUP_DATA_ACCESS_ADMIN"
27    }, {
28      "groupId" : "{PROJECT-ID}",
29      "roleName" : "GROUP_USER_ADMIN"
30    }, {
31      "groupId" : "{PROJECT-ID}",
32      "roleName" : "GROUP_READ_ONLY"
33    }, {
34      "groupId" : "{PROJECT-ID}",
35      "roleName" : "GROUP_OWNER"
36    }, {
37      "orgId" : "5980cfe20b6d97029d82fa63",
38      "roleName" : "ORG_OWNER"
39    }, {
40      "groupId" : "{PROJECT-ID}",
41      "roleName" : "GROUP_DATA_ACCESS_READ_WRITE"
42    }, {
43      "orgId" : "5980cfe20b6d97029d82fa63",
44      "roleName" : "ORG_GROUP_CREATOR"
45    }, {
46      "orgId" : "5980cfe20b6d97029d82fa63",
47      "roleName" : "ORG_READ_ONLY"
48    }, {
49      "groupId" : "{PROJECT-ID}",
50      "roleName" : "GROUP_DATA_ACCESS_READ_ONLY"
51    }, {
52      "groupId" : "{PROJECT-ID}",
53      "roleName" : "GROUP_BACKUP_ADMIN"
54    }, {
55      "groupId" : "{PROJECT-ID}",
56      "roleName" : "GROUP_CLUSTER_MANAGER"
57    } ]
58  }, {
59    "desc" : "New API key for test purposes",
60    "id" : "5d1d12c087d9d63e6d682438",
61    "links" : [ {
62      "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/5980cfe20b6d97029d82fa63/apiKeys/5d1d12c087d9d63e6d682438",
63      "rel" : "self"
64    } ],
65    "privateKey" : "********-****-****-cb34f12aafdb",
66    "publicKey" : "oxhzytwb",
67    "roles" : [ {
68      "groupId" : "{PROJECT-ID}",
69      "roleName" : "GROUP_READ_ONLY"
70    }, {
71      "orgId" : "5980cfe20b6d97029d82fa63",
72      "roleName" : "ORG_MEMBER"
73    } ]
74  } ],
75  "totalCount" : 2
76}

돌아가기

프로젝트의 조직 API 키

다음

1개의 프로젝트에 조직 API 키 1개 생성 및 할당