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

이 페이지의 내용

Resource

요청 경로 매개변수
요청 쿼리 매개변수
요청 본문 매개변수
응답
요청 예시
응답 예시
응답 헤더
응답 본문

Cloud Manager는 2024년 8월 30일부터 더 이상 MongoDB 3.6 및 4.0에 대한 자동화, 백업 및 모니터링을 지원하지 않습니다. MongoDB 배포를 업그레이드하거나 Atlas로 마이그레이션하세요.

Cloud Manager 에 대한 프로그래밍 방식의 액세스 를 위한 OAuth 2.0 인증 은 Preview 기능 으로 제공됩니다.: 기능 및 해당 설명서는 미리 보기 기간에 언제든지 변경될 수 있습니다. OAuth 2.0 인증 을 사용하려면 Cloud Manager 공개 API 에 대한 요청에 사용할서비스 계정을 만듭니다.

기본 URL: https://cloud.mongodb.com/api/public/v1.0

Resource

PATCH /groups/{PROJECT-ID}/apiKeys/{API-KEY-ID}

요청 경로 매개변수

이름	유형	설명
`PROJECT-ID`	문자열	API 키를 업데이트하려는 프로젝트의 고유 식별자입니다. /groups 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 조회합니다.
`API-KEY-ID`	문자열	업데이트하려는 API 키의 고유 식별자입니다. 지정된 조직에 대해 인증된 사용자가 액세스할 수 있는 모든 API 키를 검색하도록 /groups/{프로젝트 ID}/apiKeys 엔드포인트를 요청합니다.

요청 쿼리 매개변수

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

이름

유형

설명

기본값

pageNum

integer

페이지 번호(1-인덱스 기준)입니다.

1

itemsPerPage

integer

페이지당 반환할 항목 수. 최대 500개까지 가능합니다.

100

pretty

부울

응답 본문이 프리티프린트 에 있어야 하는지 여부를 나타냅니다. 형식.

false

envelope

부울

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

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

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

이름	설명
`status`	HTTP 응답 코드
`content`	예상되는 응답 본문

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

none

요청 본문 매개변수

이름

유형

필요성

설명

roles

배열

필수 사항

API 키를 부여해야 하는 역할 목록입니다. 역할을 최소 한 개 제공해야 합니다. 제공된 모든 역할은 할당된 프로젝트에 유효해야 합니다.

API의 역할 값	역할
`GROUP_AUTOMATION_ADMIN`	`Project Automation Admin`
`GROUP_BACKUP_ADMIN`	`Project Backup Admin`
`GROUP_BILLING_ADMIN`	프로젝트 청구 관리자
`GROUP_DATA_ACCESS_ADMIN`	`Project Data Access Admin`
`GROUP_DATA_ACCESS_READ_ONLY`	`Project Data Access Read Only`
`GROUP_DATA_ACCESS_READ_WRITE`	`Project Data Access Read/Write`
`GROUP_MONITORING_ADMIN`	`Project Monitoring Admin`
`GROUP_OWNER`	`Project Owner`
`GROUP_READ_ONLY`	`Project Read Only`
`GROUP_USER_ADMIN`	`Project User Admin`

응답

이름

유형

설명

desc

문자열

이 프로젝트에 할당된 이 조직 API 키에 대한 설명입니다.

id

문자열

이 프로젝트에 할당된 이 조직 API 키의 고유 식별자입니다.

privateKey

문자열

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

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

publicKey

문자열

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

roles

객체 배열

이 프로젝트에 할당된 조직 API 키가 갖는 역할입니다. 이 배열은 사용자가 Cloud Manager에서 가지고 있는 모든 조직 및 프로젝트 역할을 반환합니다.

roles.groupId

문자열

이 역할이 속한 프로젝트의 고유 식별자입니다.

roles.orgId

문자열

이 역할이 속한 조직의 고유 식별자입니다.

roles.roleName

문자열

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

조직 역할

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

API의 역할 값	역할
`ORG_OWNER`	`Organization Owner`
`ORG_MEMBER`	`Organization Member`
`ORG_GROUP_CREATOR`	`Organization Project Creator`
`ORG_BILLING_ADMIN`	`Organization Billing Admin`
`ORG_READ_ONLY`	`Organization Read Only`
`ORG_BILLING_READ_ONLY`	`Organization Billing Viewer`

프로젝트 역할

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

API의 역할 값	역할
`GROUP_AUTOMATION_ADMIN`	`Project Automation Admin`
`GROUP_BACKUP_ADMIN`	`Project Backup Admin`
`GROUP_BILLING_ADMIN`	프로젝트 청구 관리자
`GROUP_DATA_ACCESS_ADMIN`	`Project Data Access Admin`
`GROUP_DATA_ACCESS_READ_ONLY`	`Project Data Access Read Only`
`GROUP_DATA_ACCESS_READ_WRITE`	`Project Data Access Read/Write`
`GROUP_MONITORING_ADMIN`	`Project Monitoring Admin`
`GROUP_OWNER`	`Project Owner`
`GROUP_READ_ONLY`	`Project Read Only`
`GROUP_USER_ADMIN`	`Project User Admin`

요청 예시

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include \
5      --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/apiKeys/{API-KEY-ID}?pretty=true"
6      --data '{
7        "roles": [ "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE" ]
8      }'

응답 예시

응답 헤더

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   "desc" : "test",
3   "id" : "{API-KEY-ID}",
4   "links" : [ {
5     "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}",
6     "rel" : "self"
7   } ],
8   "privateKey" : "********-****-****-1493e7bcfde9",
9   "publicKey" : "{PUBLIC-KEY}",
10   "roles" : [ {
11     "groupId" : "{PROJECT-ID-1}",
12     "roleName" : "GROUP_DATA_ACCESS_READ_WRITE"
13   }, {
14     "groupId" : "{PROJECT-ID-1}",
15     "roleName" : "GROUP_READ_ONLY"
16   }, {
17     "groupId" : "{PROJECT-ID-2}",
18     "roleName" : "GROUP_READ_ONLY"
19   }, {
20     "orgId" : "{ORG-ID}",
21     "roleName" : "ORG_MEMBER"
22   } ]
23 }

돌아가기

생성 및 할당

역할 수정

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/apiKeys/{API-KEY-ID}?pretty=true"
6	--data '{
7	"roles": [ "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE" ]
8	}'

1	{
2	"desc" : "test",
3	"id" : "{API-KEY-ID}",
4	"links" : [ {
5	"href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}",
6	"rel" : "self"
7	} ],
8	"privateKey" : "******--**-1493e7bcfde9",
9	"publicKey" : "{PUBLIC-KEY}",
10	"roles" : [ {
11	"groupId" : "{PROJECT-ID-1}",
12	"roleName" : "GROUP_DATA_ACCESS_READ_WRITE"
13	}, {
14	"groupId" : "{PROJECT-ID-1}",
15	"roleName" : "GROUP_READ_ONLY"
16	}, {
17	"groupId" : "{PROJECT-ID-2}",
18	"roleName" : "GROUP_READ_ONLY"
19	}, {
20	"orgId" : "{ORG-ID}",
21	"roleName" : "ORG_MEMBER"
22	} ]
23	}