証明書管理REST APIサービスの詳細

以下のセクションでは、証明書管理 (CM) Microsoft Identity Manager (MIM) の詳細について説明REST API。

アーキテクチャ

MIM CM REST API の呼び出しは、コントローラーによって処理されます。 次の表に、コンテキストで使用可能なコントローラーとサンプルのすべての一覧を示します。

コントローラー サンプル ルート
CertificateDataController /api/v1.0/requests/{requestid}/certificatedata/
CertificateRequestGenerationOptionsController /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}
ProfilesController /api/v1.0/profiles/{id}
ProfileTemplatesController /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
SmartcardsConfigurationController /api/v1.0/profiletemplates/{profiletemplateid}/configuration/smartcards

HTTP 要求ヘッダーと応答ヘッダー

API に送信される HTTP 要求には、次のヘッダーを含める必要があります (この一覧は網羅的ではありません)。

ヘッダー 説明
承認 必須。 内容は認証方法によって異なる。 メソッドは構成可能であり、統合認証 (WIA) または Windows (ADFS) Active Directory フェデレーション サービス (AD FS)基づく場合があります。
Content-Type 要求本文が含まれる場合は必須。 application/jsonである必要があります。
Content-Length 要求本文が含まれる場合は必須。
クッキー セッションの Cookie。 認証方法によって必要な場合があります。

HTTP 応答には、次のヘッダーが含まれます (この一覧は網羅的ではありません)。

ヘッダー 説明
Content-Type API は常に を返します application/json
Content-Length 要求本文がある場合は、その長さ (バイト)。

API のバージョン管理

CM REST API の現在のバージョンは 1.0 です。 バージョンは、URI: /api/v1.0/api セグメントのすぐ後ろのセグメントで指定されています。 API インターフェイスに大きな変更が加わると、バージョン番号が変更されます。

API を有効にする

Web.config ファイルの <ClmConfiguration> セクションは、次の新しいキーで拡張されています。

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

このキーは、CM REST API がクライアントに公開されているかどうかを判断します。 キーが "false" に設定されていると、アプリケーションの起動時に、API のルート マッピングが実行されません。 API エンドポイントに対する後続の要求では、HTTP 404 エラー コードが返されます。 既定ではキーは「無効」に設定されています。

Note

この値を "true" に変更した後は、サーバーで iisreset を実行 してください。

トレースとログ記録を有効にする

MIM CM REST API では、受信した各 HTTP 要求のトレース データを出力します。 次の構成値を設定することで、出力されるトレース情報の詳細レベルを設定することができます。

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

エラー処理とトラブルシューティング

要求の処理中に例外が発生すると、MIM CM REST API は、HTTP 状態コードを Web クライアントに返します。 一般的なエラーの場合、API は該当する HTTP 状態コードとエラー コードを返します。

未処理の例外は、HTTP 状態コード 500 (「内部エラー」) の HttpResponseException に変換され、イベント ログと MIM CM のトレース ファイルの両方にトレースされます。 未処理の例外はそれぞれ、対応する関連付け ID を持つイベント ログに書き込まれます。 関連付け ID は、エラー メッセージで API のコンシューマーにも送信されます。 エラーのトラブルシューティングを行うため、管理者は対応する関連付け ID でイベント ログを検索して、エラーの詳細を確認できます。

Note

MIM CM REST API を使用した結果として生成されるエラーに対応するスタック トレースは、クライアントに返されません。 セキュリティ上の問題のため、トレースはクライアントに返されません。