인증서 관리 REST API 서비스 세부 정보

다음 섹션에서는 MIM(Microsoft Identity Manager) CM(인증서 관리) REST API에 대해 자세히 설명합니다.

건축학

MIM CM REST API 호출은 컨트롤러에서 처리됩니다. 다음 표에서는 컨트롤러의 전체 목록과 컨트롤러를 사용할 수 있는 컨텍스트의 샘플을 보여 줍니다.

컨트롤러	샘플 경로
CertificateDataController	/api/v1.0/requests/{requestid}/certificatedata/
인증서 요청 생성 옵션 컨트롤러	/api/v1.0/requests/{requestid}
CertificatesController	/api/v1.0/smartcards/{smartcardid}/certificates /api/v1.0/profiles/{profileid}/certificates
OperationsController	/api/v1.0/smartcards/{smartcardid}/operations /api/v1.0/profiles/{profileid}/operations
PoliciesController	/api/v1.0/profiletemplates/{profiletemplateid}/policies/{id}
프로필컨트롤러	/api/v1.0/profiles/{id}
프로필 템플릿 컨트롤러	/api/v1.0/profiletemplates/{id} /api/v1.0/profiletemplates /api/v1.0/profiletemplates/{profiletemplateid}/policies/{id}
RequestsController	/api/v1.0/requests/{id} /api/v1.0/requests
SmartcardsController	/api/v1.0/requests/{requestid}/smartcards/{id}/diversifiedkey /api/v1.0/requests/{requestid}/smartcards/{id}/serverproposedpin /api/v1.0/requests/{requestid}/smartcards/{id}/authenticationresponse /api/v1.0/requests/{requestid}/smartcards/{id} /api/v1.0/smartcards/{id} /api/v1.0/smartcards
스마트카드 설정 컨트롤러	/api/v1.0/profiletemplates/{profiletemplateid}/configuration/smartcards

HTTP 요청 및 응답 헤더

API로 전송된 HTTP 요청에는 다음 헤더가 포함되어야 합니다(이 목록은 완전하지 않음).

헤더	설명
승인	필수 사항입니다. 콘텐츠는 인증 방법에 따라 달라집니다. 이 메서드는 구성할 수 있으며 WIA(Windows 통합 인증) 또는 ADFS(Active Directory Federation Services)를 기반으로 할 수 있습니다.
콘텐츠 유형 (Content-Type)	요청에 본문이 있는 경우 필요합니다. application/json이어야 합니다.
콘텐츠-길이	요청에 본문이 있는 경우 필요합니다.
쿠키	세션 쿠키입니다. 인증 방법에 따라 필요할 수 있습니다.

HTTP 응답에는 다음 헤더가 포함됩니다(이 목록은 완전하지 않음).

헤더	설명
콘텐츠 유형 (Content-Type)	API는 항상 application/json반환합니다.
콘텐츠-길이	요청 본문의 길이(있는 경우)(바이트)입니다.

API 버전 관리

CM REST API의 현재 버전은 1.0입니다. 버전은 URI에서 /api 세그먼트 바로 다음에 있는 세그먼트에 지정됩니다: /api/v1.0. 버전 번호는 API 인터페이스를 크게 수정할 때 변경됩니다.

API 사용

<ClmConfiguration>Web.config 파일의 섹션이 새 키로 확장되었습니다.

<add key="Clm.WebApi.Enabled" value="false" />

이 키는 CM REST API가 클라이언트에 노출되는지 여부를 결정합니다. 키가 "false"로 설정된 경우 API에 대한 경로 매핑은 애플리케이션 시작 시 수행되지 않습니다. API 엔드포인트에 대한 후속 요청은 HTTP 404 오류 코드를 반환합니다. 키는 기본적으로 "사용 안 함"으로 설정됩니다.

비고

이 값을 "true"로 변경한 후 서버에서 iisreset 을 실행해야 합니다.

추적 및 로깅 활성화

MIM CM REST API는 전송된 각 HTTP 요청에 대한 추적 데이터를 내보낸다. 다음 구성 값을 설정하여 출력되는 추적 정보의 상세 수준을 설정할 수 있습니다.

<add name="Microsoft.Clm.Web.API" value="0" />

오류 처리 및 문제 해결

요청을 처리하는 동안 예외가 발생하면 MIM CM REST API는 웹 클라이언트에 HTTP 상태 코드를 반환합니다. 일반적인 오류의 경우 API는 적절한 HTTP 상태 코드와 오류 코드를 반환합니다.

처리되지 않은 예외는 HTTP 상태 코드 500("내부 오류")으로 변환 HttpResponseException 되고 이벤트 로그와 MIM CM 추적 파일 모두에서 추적됩니다. 처리되지 않은 각 예외는 해당 상관 관계 ID를 사용하여 이벤트 로그에 기록됩니다. 상관 관계 ID는 오류 메시지에서 API의 소비자에게도 전송됩니다. 오류를 해결하기 위해 관리자는 이벤트 로그에서 해당 상관 관계 ID 및 오류 세부 정보를 검색할 수 있습니다.

비고

MIM CM REST API를 사용한 결과로 생성된 오류에 해당하는 스택 추적은 클라이언트로 다시 전송되지 않습니다. 추적은 보안 문제로 인해 클라이언트로 다시 전송되지 않습니다.