기본 URL: https://cloud.mongodb.com/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/apiKeys요청 경로 매개변수
이름 | 유형 | 설명 |
|---|---|---|
| 문자열 | 할당된 조직 API 키를 조회 하려는 프로젝트의 고유 식별자입니다. 인증된 사용자가 액세스 있는 모든 프로젝트를 조회 하려면 /groups 엔드포인트를 사용합니다. |
요청 쿼리 매개변수
다음 쿼리 매개변수는 선택 사항입니다.
이름 | 유형 | 설명 | 기본값 |
|---|---|---|---|
pageNum | integer | 페이지 번호(1-인덱스 기준)입니다. |
|
itemsPerPage | integer | 페이지당 반환할 항목 수. 최대 500개까지 가능합니다. |
|
pretty | 부울 | 응답 본문을 prettyprint 형식으로 반환할지 여부를 나타냅니다. |
|
envelope | 부울 | 응답을 엔벨로프에 래핑할지 여부를 나타냅니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.
결과 목록을 반환하는 엔드포인트의 경우 | none |
요청 본문 매개변수
이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.
응답
응답 문서
응답 JSON 문서에는 result 객체 배열, link 객체 배열, 조회된 result 객체의 총 개수가 포함되어 있습니다.
이름 | 유형 | 설명 |
|---|---|---|
| 배열 | 배열에는 내장된 |
| 배열 | 배열에 하위 리소스 및/또는 관련 리소스에 대한 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에설명되어 있습니다. |
| 숫자 | 결과 집합에 있는 총 항목 수의 정수 개수입니다. 전체 결과 집합이 페이지로 매겨진 경우 results 배열의 객체 수보다 클 수 있습니다. |
results embeddedDocument
각 결과 는 하나의 프로젝트 API 키입니다.
이름 | 유형 | 설명 |
|---|---|---|
| 문자열 | 이 프로젝트에 할당된 이 조직 API 키에 대한 설명입니다. |
| 문자열 | 이 프로젝트에 할당된 이 조직 API 키의 고유 식별자입니다. |
| 문자열 | 이 프로젝트에 할당된 이 조직 API 키의 비공개 키가 수정되었습니다. 이 키는 처음 생성될 때 수정되지 않은 상태로 표시됩니다. |
| 문자열 | 이 프로젝트에 할당된 이 조직 API 키의 공개 키입니다. |
| 객체 배열 | 이 프로젝트에 할당된 조직 API 키의 역할입니다. 이 배열은 Cloud Manager에서 사용자가 가진 모든 조직 및 프로젝트 역할을 반환합니다. |
| 문자열 | 이 역할이 속한 프로젝트의 고유 식별자입니다. |
| 문자열 | 이 역할이 속한 조직의 고유 식별자입니다. |
| 문자열 | 역할의 이름입니다. 이 리소스는 사용자가 Cloud Manager에서 가지고 있는 모든 역할을 반환합니다. 가능한 값은 다음과 같습니다. 조직 역할
프로젝트 역할
|
요청 예시
참고
요청 하는 사용자는 {PUBLIC-KEY}:{PRIVATE-KEY} 형식으로 지정할 수 있습니다.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/apiKeys?pretty=true"응답 예시
응답 헤더
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}응답 본문
{ "links" : [ { "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/apiKeys?pretty=true&pageNum=1&itemsPerPage=100", "rel" : "self" } ], "results" : [ { "desc" : "Updated API Key description for DOCSP-6042", "id" : "5d1cf1f980eef570c9fc87e5", "links" : [ { "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfe20b6d97029d82fa63/apiKeys/5d1cf1f980eef570c9fc87e5", "rel" : "self" } ], "privateKey" : "********-****-****-9d4ae38e4ddd", "publicKey" : "{PUBLIC-KEY}", "roles" : [ { "groupId" : "{PROJECT-ID}", "roleName" : "GROUP_AUTOMATION_ADMIN" }, { "groupId" : "{PROJECT-ID}", "roleName" : "GROUP_MONITORING_ADMIN" }, { "orgId" : "5980cfe20b6d97029d82fa63", "roleName" : "ORG_MEMBER" }, { "orgId" : "5980cfe20b6d97029d82fa63", "roleName" : "ORG_BILLING_ADMIN" }, { "groupId" : "{PROJECT-ID}", "roleName" : "GROUP_DATA_ACCESS_ADMIN" }, { "groupId" : "{PROJECT-ID}", "roleName" : "GROUP_USER_ADMIN" }, { "groupId" : "{PROJECT-ID}", "roleName" : "GROUP_READ_ONLY" }, { "groupId" : "{PROJECT-ID}", "roleName" : "GROUP_OWNER" }, { "orgId" : "5980cfe20b6d97029d82fa63", "roleName" : "ORG_OWNER" }, { "groupId" : "{PROJECT-ID}", "roleName" : "GROUP_DATA_ACCESS_READ_WRITE" }, { "orgId" : "5980cfe20b6d97029d82fa63", "roleName" : "ORG_GROUP_CREATOR" }, { "orgId" : "5980cfe20b6d97029d82fa63", "roleName" : "ORG_READ_ONLY" }, { "groupId" : "{PROJECT-ID}", "roleName" : "GROUP_DATA_ACCESS_READ_ONLY" }, { "groupId" : "{PROJECT-ID}", "roleName" : "GROUP_BACKUP_ADMIN" }, { "groupId" : "{PROJECT-ID}", "roleName" : "GROUP_CLUSTER_MANAGER" } ] }, { "desc" : "New API key for test purposes", "id" : "5d1d12c087d9d63e6d682438", "links" : [ { "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfe20b6d97029d82fa63/apiKeys/5d1d12c087d9d63e6d682438", "rel" : "self" } ], "privateKey" : "********-****-****-cb34f12aafdb", "publicKey" : "oxhzytwb", "roles" : [ { "groupId" : "{PROJECT-ID}", "roleName" : "GROUP_READ_ONLY" }, { "orgId" : "5980cfe20b6d97029d82fa63", "roleName" : "ORG_MEMBER" }, { "orgId" : "5980cfe20b6d97029d82fa63", "roleName" : "ORG_BILLING_ADMIN" } ] } ], "totalCount" : 2}