프로젝트 서비스 계정 하나 가져오기

이 페이지의 내용

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

GET /groups/{PROJECT-ID}/serviceAccounts

요청 경로 매개변수

이름	유형	설명
`PROJECT-ID`	문자열	할당된 조직 서비스 계정을 조회 하려는 프로젝트의 고유 식별자입니다. 인증된 사용자가 액세스 있는 모든 프로젝트를 조회 하려면 /groups 엔드포인트를 사용합니다.
`CLIENT-ID`	문자열	조회 하려는 서비스 계정의 고유 식별자입니다. 인증된 사용자가 액세스 있는 지정된 프로젝트 의 모든 서비스 계정을 조회하도록 /groups/{ 조회 ID }/serviceAccounts 엔드포인트를 요청합니다.

요청 쿼리 매개변수

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

이름

유형

설명

기본값

pageNum

integer

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

1

itemsPerPage

integer

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

100

pretty

부울

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

false

envelope

부울

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

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

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

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

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

none

요청 본문 매개변수

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

응답

응답 요소

쿼리 요소 envelope 를 true 로 설정하면 응답이 content 객체에 의해 래핑됩니다.

HTTP 응답은 다음 객체를 포함하는 JSON document를 반환합니다.

이름	유형	설명
`clientId`	문자열	서비스 계정의 고유 식별자입니다.
`createdAt`	timestamp	서비스 계정 생성 시간입니다.
`name`	문자열	서비스 계정의 이름입니다.
`description`	문자열	서비스 계정에 대한 설명입니다.
`roles`	문자열 배열	서비스 계정이 프로젝트 에서 갖는 역할 목록입니다. 프로젝트 역할에는 다음이 포함됩니다. `GROUP_AUTOMATION_ADMIN` `GROUP_BACKUP_ADMIN` `GROUP_BILLING_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`
`secrets`	객체 배열	서비스 계정 비밀 목록입니다.
`secrets.id`	문자열	고유한 24-시크릿을 식별하는 16진수 문자열입니다.string
`secrets.createdAt`	timestamp	시크릿 생성 시간을 나타내는 타임스탬프입니다.
`secrets.expiresAt`	timestamp	시크릿 만료 시간을 나타내는 타임스탬프입니다.
`secrets.lastUsedAt`	timestamp	마지막 시크릿 사용량을 나타내는 타임스탬프입니다.
`secrets.maskedSecretValue`	문자열	접두사와 마지막 4자만 표시하는 마스킹된 시크릿입니다.

요청 예시

참고

요청 하는 사용자는 {PUBLIC-KEY}:{PRIVATE-KEY} 형식으로 지정할 수 있습니다.

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2      --header "Accept: application/json" \
3      --include \
4      --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/serviceAccounts/{CLIENT-ID}?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   "createdAt" : "2024-08-03T14:02:40Z",
3   "description" : "Service account for developers.",
4   "clientId" : "mdb_sa_id_66ae38803cdf55582cb01144",
5   "name" : "Dev Service Account",
6   "roles" : [ "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN" ],
7   "secrets" : [ {
8     "createdAt" : "2024-08-03T14:02:40Z",
9     "expiresAt" : "2024-12-31T14:02:40Z",
10     "lastUsedAt" : "2024-08-24T21:10:35Z",
11     "id" : "66ae38803cdf55582cb01143",
12     "maskedSecretValue" : "mdb_sa_sk_...hcOL"
13   } ]
14 }

돌아가기

1개의 프로젝트에 할당된 모든 조직 서비스 계정 가져오기

1개의 프로젝트에 1개의 조직 서비스 계정 생성 및 할당

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--include \
4	--request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/serviceAccounts/{CLIENT-ID}?pretty=true"

1	{
2	"createdAt" : "2024-08-03T14:02:40Z",
3	"description" : "Service account for developers.",
4	"clientId" : "mdb_sa_id_66ae38803cdf55582cb01144",
5	"name" : "Dev Service Account",
6	"roles" : [ "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN" ],
7	"secrets" : [ {
8	"createdAt" : "2024-08-03T14:02:40Z",
9	"expiresAt" : "2024-12-31T14:02:40Z",
10	"lastUsedAt" : "2024-08-24T21:10:35Z",
11	"id" : "66ae38803cdf55582cb01143",
12	"maskedSecretValue" : "mdb_sa_sk_...hcOL"
13	} ]
14	}