키 메타데이터 검색

다음 항목을 사용하여 단일 암호화 키의 일반 특성을 검색할 수 있습니다. IBM® Key Protect for IBM Cloud®.

단일 키에 세분화된 액세스 권한을 지정할 수 있지만, 목록 키 API를 호출하면 개별 액세스가 지정된 키(즉, 사용자만 액세스할 수 있는 키)는 리턴되지 않습니다. 그러나 이 API를 호출하면 사용자가 액세스할 수 있는 키 링의 키가 리턴됩니다(인스턴스의 모든 키에 액세스할 수 있는 경우 모든 키가 표시됨). 그러나 IAM을 통해 키를 확인하기 위해 키에 액세스 권한 부여의 지시사항에 따르거나 특정 키 ID를 전달하기 위해 API를 사용하여 사용자만 액세스할 수 있는 키를 확인할 수 있습니다.

키를 검색하려면 작성자 또는 관리자 액세스 정책이 필요하지만, 키 자체를 검색하지 않고 상태 전이 히스토리 또는 구성과 같은 키에 대한 세부사항만 볼 수 있는 방법이 필요할 수 있습니다. 리더 액세스 권한이 있는 경우 Key Protect 사용할 수 있습니다 API를 사용하여 키에 대한 메타데이터만 검색할 수 있습니다.

API를 사용하여 키 메타데이터 보기

특정 키에 대한 자세한 정보를 보기 위해 다음 엔드포인트에 대한 GET 호출을 작성할 수 있습니다.

https://<region>.kms.cloud.ibm.com/api/v2/keys/<key_ID_or_alias>/metadata

인증 정보를 검색하여 서비스에서 키에 대한 작업을 수행하십시오.
검사할 키의 ID를 검색하십시오.

ID 값은 키에 대한 자세한 정보에 액세스하는 데 사용됩니다. 다음 Key Protect 인스턴스의 키에 대한 ID를 키 목록을 검색하거나 Key Protect 대시보드.

다음 curl 명령을 실행하여 키에 대한 세부사항을 가져오십시오.

$ curl -X GET \
    "https://<region>.kms.cloud.ibm.com/api/v2/keys/<key_ID_or_alias>/metadata" \
    -H "accept: application/vnd.ibm.kms.key+json" \
    -H "authorization: Bearer <IAM_token>" \
    -H "bluemix-instance: <instance_ID>" \
    -H "x-kms-key-ring: <key_ring_ID>" \
    -H "correlation-id: <correlation_ID>"

다음 표에 따라 예제 요청의 변수를 대체하십시오.

Key Protect 사용하여 키에 대한 세부 정보를 보는 데 필요한 변수에 대해 설명합니다 API에 필요한 변수를 설명합니다.
가변	설명
지역	필수. Key Protect 인스턴스가 상주하는 지리적 영역을 표시하는 지역 약어(예: `us-south` 또는 `eu-gb`)입니다. 자세한 정보는 지역 서비스 엔드포인트를 참조하십시오.
keyID_or_alias	필수. 검사할 키의 고유 ID 또는 별명입니다.
IAM_token	필수. 사용자의 IBM Cloud 액세스 토큰입니다. curl 요청에 Bearer 값을 포함하여 IAM 토큰의 전체 컨텐츠를 포함하십시오. 자세한 정보는 액세스 토큰 검색을 참조하십시오.
instance_ID	필수. Key Protect 서비스 인스턴스에 지정된 고유 ID입니다. 자세한 정보는 인스턴스 ID 검색을 참조하십시오.
key_ring_ID	선택사항. 키가 속한 키 링의 고유 ID입니다. 헤더 자체는 선택사항이지만 지정되지 않으면 Key Protect에서 지정된 인스턴스와 연관된 모든 키 링의 키를 검색합니다. 보다 최적화된 요청을 위해 키 링 ID를 지정하는 것이 좋습니다. 참고: `x-kms-key-ring` 헤더 없이 작성된 키의 키 링 ID는 default입니다. 자세한 정보는 키 그룹화를 참조하십시오.
correlation_ID	선택사항. 트랜잭션을 추적하고 상관시키는 데 사용되는 고유 ID입니다.

성공적인 GET api/v2/keys/<key_ID_or_alias>/metadata 응답에서는 키에 대한 세부사항이 리턴됩니다. 다음 JSON 오브젝트는 표준 키의 리턴값 예를 표시합니다.

{
		"metadata": {
				"collectionType": "application/vnd.ibm.kms.key+json",
				"collectionTotal": 1
		},
		"resources": [
				{
						"type": "application/vnd.ibm.kms.key+json",
						"id": "02fd6835-6001-4482-a892-13bd2085f75d",
						"name": "test-standard-key",
						"aliases": [
								"alias-1",
								"alias-2"
						],
						"state": 1,
						"expirationDate": "2020-03-15T03:50:12Z",
						"extractable": true,
						"crn": "crn:v1:bluemix:public:kms:us-south:a/f047b55a3362ac06afad8a3f2f5586ea:12e8c9c2-a162-472d-b7d6-8b9a86b815a6:key:02fd6835-6001-4482-a892-13bd2085f75d",
						"imported": false,
						"creationDate": "2020-03-12T03:50:12Z",
						"createdBy": "...",
						"algorithmType": "Deprecated",
						"algorithmMetadata": {
								"bitLength": "256",
								"mode": "Deprecated"
						},
						"algorithmBitSize": 256,
						"algorithmMode": "Deprecated",
						"lastUpdateDate": "2020-03-12T03:50:12Z",
						"dualAuthDelete": {
								"enabled": false
						},
						"deleted": false
				}
		]
}

다음 단계

표준 키에 대한 payload 값을 검색해야 합니까? 자세히 알아보려면 키 검색을 참조하십시오.

응답 매개변수에 대한 자세한 설명은 Key Protect REST API 참조 문서.