기본 URL: https://cloud.mongodb.com/api/public/v1.0
Resource
PATCH /groups/{PROJECT-ID}/apiKeys/{API-KEY-ID}요청 경로 매개변수
이름 | 유형 | 설명 |
|---|---|---|
| 문자열 | API 키를 업데이트 하려는 프로젝트의 고유 식별자입니다. 인증된 사용자가 액세스 있는 모든 조직을 조회 하려면 /groups 엔드포인트를 사용합니다. |
| 문자열 | 업데이트하려는 API 키의 고유 식별자입니다. 인증된 사용자가 지정된 조직에 대해 액세스할 수 있는 모든 API 키를 조회하기 위해 /groups/{PROJECT-ID}/apiKeys 엔드포인트를 요청합니다. |
요청 쿼리 매개변수
다음 쿼리 매개변수는 선택 사항입니다.
이름 | 유형 | 설명 | 기본값 |
|---|---|---|---|
pageNum | integer | 페이지 번호(1-인덱스 기준)입니다. |
|
itemsPerPage | integer | 페이지당 반환할 항목 수. 최대 500개까지 가능합니다. |
|
pretty | 부울 | 응답 본문을 prettyprint 형식으로 반환할지 여부를 나타냅니다. |
|
envelope | 부울 | 응답을 엔벨로프에 래핑할지 여부를 나타냅니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.
결과 목록을 반환하는 엔드포인트의 경우 | none |
요청 본문 매개변수
body 매개변수는 필수입니다.
이름 | 유형 | 필요성 | 설명 |
|---|---|---|---|
| 문자열 배열 | 필수 사항 | API 키에 부여되어야 하는 역할 목록 최소 하나의 역할이 제공되어야 합니다. 제공된 모든 역할은 할당된 프로젝트에 대해 유효해야 합니다:
이 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" \ --header "Content-Type: application/json" \ --include \ --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/apiKeys/5d1d143c87d9d63e6d694746?pretty=true" \ --data '{ "roles": [ "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE" ] }'응답 예시
응답 헤더
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}응답 본문
{ "desc" : "New API key for test purposes", "id" : "5d1d143c87d9d63e6d694746", "links" : [ { "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfe20b6d97029d82fa63/apiKeys/5d1d143c87d9d63e6d694746", "rel" : "self" } ], "privateKey" : "********-****-****-eac4256753ba", "publicKey" : "{PUBLIC-KEY}", "roles" : [ { "orgId" : "5980cfe20b6d97029d82fa63", "roleName" : "ORG_BILLING_ADMIN" }, { "groupId" : "{PROJECT-ID}", "roleName" : "GROUP_DATA_ACCESS_READ_WRITE" }, { "orgId" : "5980cfe20b6d97029d82fa63", "roleName" : "ORG_MEMBER" }, { "groupId" : "{PROJECT-ID}", "roleName" : "GROUP_READ_ONLY" } ]}