/ /

/ /

서비스 계정 업데이트

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

Resource

PATCH /orgs/{ORG-ID}/serviceAccounts/{CLIENT-ID}

요청 경로 매개변수

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

요청 쿼리 매개변수

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

이름

유형

설명

기본값

pageNum

integer

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

1

itemsPerPage

integer

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

100

pretty

부울

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

false

envelope

부울

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

Some API clients cannot access the HTTP response headers or status code. To remediate this, set "envelope" : true in the query.

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

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

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

none

요청 본문 매개변수

이름

유형

설명

description

문자열

1 ~ 250 자 사이의 서비스 계정에 대한 설명입니다. 허용되는 문자는 A-Z, a-z, 0-9, 공백, 마침표 ., 아포스트로피 ', 쉼표 ,, 밑줄 _ 및 대시 - 입니다.

roles

문자열 배열

서비스 계정이 가져야 하는 역할 목록입니다. 하나 이상의 역할 이 나열되어야 하며 모든 역할은 조직에 대해 유효해야 합니다.

조직의 역할은 다음과 같습니다.

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`

응답

이름	유형	설명
`clientId`	문자열	서비스 계정의 고유 식별자입니다.
`description`	문자열	서비스 계정에 대한 설명입니다. 허용되는 문자는 `A-Z`, `a-z`, `0-9`, 공백, 마침표 `.`, 아포스트로피 `'`, 쉼표 `,`, 밑줄 `_` 및 대시 `-` 입니다.
`name`	문자열	서비스 계정의 이름입니다. 허용되는 문자는 `A-Z`, `a-z`, `0-9`, 공백, 마침표 `.`, 아포스트로피 `'`, 쉼표 `,`, 밑줄 `_` 및 대시 `-` 입니다.
`createdAt`	timestamp	서비스 계정 생성 시간입니다.
`secrets`	객체 배열	서비스 계정 비밀 목록입니다.
`secrets.id`	문자열	고유한 24-시크릿을 식별하는 16진수 문자열입니다.string
`secrets.secret`	문자열	서비스 계정 비밀번호는 생성 시에만 사용할 수 있습니다.
`secrets.maskedSecretValue`	문자열	접두사와 마지막 4자만 표시하는 마스킹된 시크릿입니다.
`secrets.createdAt`	timestamp	시크릿 생성 시간을 나타내는 타임스탬프입니다.
`secrets.lastUsedAt`	timestamp	마지막 시크릿 사용량을 나타내는 타임스탬프입니다.
`secrets.expiresAt`	timestamp	시크릿 만료 시간을 나타내는 타임스탬프입니다.
`roles`	객체 배열	서비스 계정이 조직 에서 갖는 역할입니다. 조직의 역할은 다음과 같습니다. `ORG_OWNER` `ORG_MEMBER` `ORG_GROUP_CREATOR` `ORG_BILLING_ADMIN` `ORG_READ_ONLY` `ORG_BILLING_READ_ONLY`

요청 예시

참고

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

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --request PATCH "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/serviceAccounts/{CLIENT-ID}?pretty=true" \
     --data '{
       "description" : "Updated service account description",
       "roles": ["ORG_MEMBER", "ORG_READ_ONLY"]
     }'

응답 예시

응답 헤더

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}

응답 본문

{
  "createdAt" : "2024-05-31T17:27:05Z",
  "description" : "Updated service account description",
  "clientId" : "mdb_sa_id_665a086958c92d31a28d452e",
  "name" : "Audit Service Account",
  "roles" : [ "ORG_READ_ONLY", "ORG_MEMBER" ],
  "secrets" : [ {
    "createdAt" : "2024-05-31T17:27:05Z",
    "expiresAt" : "2025-05-31T17:27:05Z",
    "id" : "665a086958c92d31a28d452f",
    "maskedSecretValue" : "mdb_sa_sk_…OEyV"
  } ]
}

돌아가기

만들기

삭제