1개의 서비스 계정 가져오기
- Cloud Manager 에 대한 프로그래밍 방식의 액세스 를 위한 OAuth 2.0 인증 은 Preview 기능 으로 제공됩니다.
- 기능 및 해당 설명서는 미리 보기 기간에 언제든지 변경될 수 있습니다. OAuth 2.0 인증 을 사용하려면 Cloud Manager 공개 API 에 대한 요청에 사용할서비스 계정을 만듭니다.
기본 URL: https://cloud.mongodb.com/api/public/v1.0
Resource
GET /orgs/{ORG-ID}/serviceAccounts/{CLIENT-ID}
요청 경로 매개변수
이름 | 유형 | 설명 |
---|---|---|
| 문자열 | 조회 하려는 서비스 계정이 있는 조직 의 고유 식별자입니다. 인증된 사용자가 액세스 있는 모든 조직을 조회 하려면 /orgs 엔드포인트를 사용합니다. |
| 문자열 | 조회 하려는 서비스 계정의 고유 식별자입니다. 인증된 사용자가 액세스 있는 지정된 조직 의 모든 서비스 계정을 조회 하도록 /orgs/{ORG- ID }/serviceAccounts 엔드포인트를 요청합니다. |
요청 쿼리 매개변수
다음 쿼리 매개변수는 선택 사항입니다.
이름 | 유형 | 설명 | 기본값 | ||||||
---|---|---|---|---|---|---|---|---|---|
pageNum | integer | 페이지 번호(1-인덱스 기준)입니다. |
| ||||||
itemsPerPage | integer | 페이지당 반환할 항목 수. 최대 500개까지 가능합니다. |
| ||||||
pretty | 부울 |
| |||||||
envelope | 부울 | 응답을 엔벨로프에 래핑할지 여부를 나타냅니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.
결과 목록을 반환하는 엔드포인트의 경우 | none |
요청 본문 매개변수
이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.
응답
응답 요소
쿼리 요소 envelope
를 true
로 설정하면 응답이 content
객체에 의해 래핑됩니다.
HTTP 응답은 다음 객체를 포함하는 JSON document를 반환합니다.
이름 | 유형 | 설명 |
---|---|---|
| 문자열 | 서비스 계정의 고유 식별자입니다. |
| 문자열 | 서비스 계정에 대한 설명입니다. 허용되는 문자는 |
| 문자열 | 서비스 계정의 이름입니다. 허용되는 문자는 |
| timestamp | 서비스 계정 생성 시간입니다. |
| 객체 배열 | 서비스 계정 비밀 목록입니다. |
| 문자열 | 고유한 24-시크릿을 식별하는 16진수 문자열입니다.string |
| 문자열 | 서비스 계정 비밀번호는 생성 시에만 사용할 수 있습니다. |
| 문자열 | 접두사와 마지막 4자만 표시하는 마스킹된 시크릿입니다. |
| timestamp | 시크릿 생성 시간을 나타내는 타임스탬프입니다. |
| timestamp | 마지막 시크릿 사용량을 나타내는 타임스탬프입니다. |
| timestamp | 시크릿 만료 시간을 나타내는 타임스탬프입니다. |
| 객체 배열 | 서비스 계정이 조직 에서 갖는 역할입니다. 조직의 역할은 다음과 같습니다. |
요청 예시
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/serviceAccounts/{CLIENT-ID}?pretty=true"
응답 예시
응답 헤더
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
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}
응답 본문
{ "createdAt" : "2024-05-31T17:27:05Z", "description" : "This service account is for admins.", "clientId" : "mdb_sa_id_665a086958c92d31a28d452e", "name" : "Admin Service Account", "roles" : [ "ORG_OWNER" ], "secrets" : [ { "createdAt" : "2024-05-31T17:27:05Z", "expiresAt" : "2025-05-31T17:27:05Z", "id" : "665a086958c92d31a28d452f", "maskedSecretValue" : "mdb_sa_sk_…OEyV" } ] }