API 키 업데이트
기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
PATCH /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}
요청 경로 매개변수
이름 | 유형 | 설명 |
|---|---|---|
ORG-ID | 문자열 | |
API-KEY-ID | 문자열 | 업데이트하려는 API 키의 고유 식별자입니다. /orgs/{ORG-ID}/apiKeys 엔드포인트에 지정된 조직에 대해 인증된 사용자가 액세스할 수 있는 모든 API 키를 검색하도록 요청합니다. |
요청 쿼리 매개변수
다음 쿼리 매개변수는 선택 사항입니다.
이름 | 유형 | 설명 | 기본값 | ||||||
|---|---|---|---|---|---|---|---|---|---|
pageNum | integer | 페이지 번호(1-인덱스 기준)입니다. | 1 | ||||||
itemsPerPage | integer | 페이지당 반환할 항목 수. 최대 500개까지 가능합니다. | 100 | ||||||
pretty | 부울 | false | |||||||
envelope | 부울 | 응답을 엔벨로프에 래핑할지 여부를 나타냅니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.
결과 목록을 반환하는 엔드포인트의 경우 | none |
요청 본문 매개변수
이름 | 유형 | 필수/선택 사항 | 설명 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
desc | 문자열 | 옵션 | 키에 대한 설명입니다. 이 매개변수는 선택 사항입니다. 그러나 요청에는 desc 매개변수 또는 roles 매개변수가 포함되어야 합니다. desc 가 제공되는 경우 길이는 1~250자 사이여야 합니다. | ||||||||||
roles | 문자열 배열 | 옵션 | API 키가 가져야 하는 역할 목록입니다. 이 매개변수는 선택 사항입니다. 단, 요청에는 조직의 역할은 다음과 같습니다.
|
응답
이름 | 유형 | 설명 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | 문자열 | API 키의 고유 식별자 | ||||||||||
desc | 문자열 | API 키에 대한 설명 | ||||||||||
privateKey | 문자열 | API 키에 대해 수정된 비공개 키 | ||||||||||
publicKey | 문자열 | API 키의 공개 키 | ||||||||||
roles | 객체 배열 | API 키의 역할 | ||||||||||
roles.{ENTITY-ID} | 문자열 | {ENTITY-ID} 는 이 역할이 적용되는 조직 또는 프로젝트를 나타냅니다. 가능한 값은 orgId 또는 groupId 입니다. | ||||||||||
roles.roleName | 문자열 | 역할의 이름입니다.
|
요청 예시
참고
요청 하는 사용자는 {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"] }'
응답 예시
응답 헤더
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}
응답 본문
{ "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" } ] }