証明書をプロビジョニングするためのエンドポイント。
HTTP リクエスト
POST https://example.issuer.com/api/v1/vdc/provisionCredential
リクエストの本文
リクエストの本文には、次の構造のデータが含まれます。
| JSON 表現 |
|---|
{ "requestMetadata": { object ( |
| フィールド | |
|---|---|
requestMetadata |
リクエストに関するメタデータ。すべてのリクエストで必須。 |
deviceReferenceId |
デバイスに対応する ID とデバイスに関連付けられた ID 鍵。これはデバイス ID ではありません。つまり、ユーザーが同じデバイスで 2 種類の認証情報を使用する場合、この ID はそれぞれの認証情報で異なります。 この ID はすべてのリクエストで提供され、リクエストとリクエストを関連付けるために使用できます。 |
credentialId |
デバイスにプロビジョニングされた特定の認証情報を表す不透明な識別子。 credentialId が存在する場合は、新しい認証情報を作成する代わりに、このメソッドは既存の認証情報を返します。 例: UUID |
proofingId |
一連の特定の証拠による検証を表す、特定のデバイスの不透明な識別子。 検証は「承認済み」状態になっている必要があります。そうでない場合は、無効な ID を示す ErrorResponse が返されます。 |
deviceEncryptionKey |
デバイスのエフェメラル暗号鍵と関連するメタデータを含むオブジェクト。この鍵は、値を暗号化してデバイスに返すために使用されます。このオブジェクトは、オンボーディング時のサンドボックス環境では提供されないことがあります。その場合、発行元は平文のデータを返す必要があります。このオブジェクトは本番環境では必ず設定する必要があります。 |
レスポンスの本文
プロビジョニングされた認証情報を含むレスポンス。
成功した場合、レスポンスの本文には次の構造のデータが含まれます。
| JSON 表現 |
|---|
{ "responseMetadata": { object ( |
| フィールド | |
|---|---|
responseMetadata |
レスポンスに関するメタデータ。すべてのレスポンスで必須。 |
credential |
プロビジョニングされた認証情報。 |
credentialVersionId |
プロビジョニングされた認証情報の現在のバージョン。 |
認証情報
mdoc ベースの認証情報。認証情報のタイプごとに、関連する ISO 標準で定義されています。
たとえば、モバイル運転免許証の場合、ISO/IEC 18013-5 になります。mDL mDoc 形式については、こちらをご覧ください。
| JSON 表現 |
|---|
{ // Union field |
| フィールド | |
|---|---|
共用体フィールド presencetype。認証情報がどのように提示されているかを示す oneof。presencetype は次のいずれかになります。 |
|
encryptedData |
暗号化された値と、値を復号するために必要な暗号化メタデータ。 |
unencryptedValue |
base64 でエンコードされた認証情報の値。 |