Docs Menu
Docs Home
/
MongoDB Ops Manager
/
API
/
Ops Manager 관리 API 리소스
/
프로그래밍 방식 API 키
/
조직 프로그래매틱 API 키

API 키 업데이트

이 페이지의 내용

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

기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

PATCH /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}

요청 경로 매개변수

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

요청 쿼리 매개변수

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

이름
유형
설명
기본값
pageNum
integer
페이지 번호(1-인덱스 기준)입니다.
1
itemsPerPage
integer
페이지당 반환할 항목 수. 최대 500개까지 가능합니다.
100
pretty
부울
응답 본문이 프리티프린트 에 있어야 하는지 여부를 나타냅니다. 형식.
false
envelope
부울

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

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

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

상태
HTTP 응답 코드
envelope
예상되는 응답 본문

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

none

요청 본문 매개변수

이름
유형
필수/선택 사항
설명
desc
문자열
옵션
키에 대한 설명입니다. 이 매개변수는 선택 사항입니다. 그러나 요청에는 desc 매개변수 또는 roles 매개변수가 포함되어야 합니다. desc 가 제공되는 경우 길이는 1~250자 사이여야 합니다.
roles
문자열 배열
옵션

API 키가 가져야 하는 역할 목록입니다. 이 매개변수는 선택 사항입니다. 단, 요청에는 desc 매개변수 또는 roles 매개변수가 포함되어야 합니다. roles 가 제공되는 경우 역할이 하나 이상 나열되어야 하며 모든 역할은 조직에 대해 유효해야 합니다.

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

API의 역할 값
역할
ORG_OWNER
ORG_MEMBER
ORG_GROUP_CREATOR
ORG_READ_ONLY

응답

이름
유형
설명
id
문자열
API 키의 고유 식별자
desc
문자열
API 키에 대한 설명
privateKey
문자열
API 키에 대해 수정된 비공개 키
publicKey
문자열
API 키의 공개 키
roles
객체 배열
API 키의 역할
roles.{ENTITY-ID}
문자열
{ENTITY-ID} 는 이 역할이 적용되는 조직 또는 프로젝트를 나타냅니다. 가능한 값은 orgId 또는 groupId 입니다.
roles.roleName
문자열

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

  • 조직 역할

    API의 역할 값
    역할
    ORG_OWNER
    ORG_MEMBER
    ORG_GROUP_CREATOR
    ORG_READ_ONLY

  • 프로젝트 역할

    그룹과 프로젝트는 동의어입니다.

    • GROUP_OWNER

    • GROUP_READ_ONLY

    • GROUP_DATA_ACCESS_ADMIN

    • GROUP_DATA_ACCESS_READ_WRITE

    • GROUP_DATA_ACCESS_READ_ONLY

    • GROUP_AUTOMATION_ADMIN

    • GROUP_BACKUP_ADMIN

    • GROUP_MONITORING_ADMIN

    • GROUP_OWNER

    • GROUP_USER_ADMIN

요청 예시

참고

요청을 하는 사용자의 형식은 {USERNAME}:{APIKEY} 또는 {PUBLIC-KEY}:{PRIVATE-KEY}로 지정할 수 있습니다.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}?pretty=true" \
  --data '{
    "desc" : "Updated |api| key description for test purposes",
    "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}

응답 본문

{
  "desc" : "Updated |api| key description for test purposes",
  "id" : "5c47ba5127d9d61b9fd8a27b",
  "links" : [ {
    "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "kzurbulc",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_READ_ONLY"
  } ]
}

돌아가기

API 키 생성

다음

하나의 API 키 삭제