利用者の現況確認 - PocketSign APIs

指定された利用者IDに対応する利用者に発行された証明書のうち、Verify APIが認識している最新の証明書について失効確認（現況確認）を行います。

Requestパラメータ

Request Bodyパラメータapplication/json

user_id

string

現況確認を行う利用者に対応する利用者ID

可選

certificate_type

enum<string>

可選

TYPE_JPKI_CARD_DIGITAL_SIGNATURE: マイナンバーカードに搭載された署名用電子証明書

TYPE_JPKI_CARD_USER_AUTHENTICATION: マイナンバーカードに搭載された利用者証明用電子証明書

列挙型:

TYPE_UNSPECIFIEDTYPE_JPKI_CARD_DIGITAL_SIGNATURETYPE_JPKI_CARD_USER_AUTHENTICATION

デフォルト値:

TYPE_UNSPECIFIED

check_method

enum<string>

可選

CHECK_METHOD_CRL: CRLを参照して失効確認

CHECK_METHOD_OCSP: OCSPレスポンダに問い合わせて失効確認

列挙型:

CHECK_METHOD_UNSPECIFIEDCHECK_METHOD_CRLCHECK_METHOD_OCSP

デフォルト値:

CHECK_METHOD_UNSPECIFIED

例

{
  "user_id": "string",
  "certificate_type": "TYPE_UNSPECIFIED",
  "check_method": "CHECK_METHOD_UNSPECIFIED"
}

サンプルコード

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Response

🟢200A successful response.

application/json

Body

certificate

object (証明書情報)

可選

string

証明書ID

可選

type

enum<string>

可選

TYPE_JPKI_CARD_DIGITAL_SIGNATURE: マイナンバーカードに搭載された署名用電子証明書

TYPE_JPKI_CARD_USER_AUTHENTICATION: マイナンバーカードに搭載された利用者証明用電子証明書

列挙型:

TYPE_UNSPECIFIEDTYPE_JPKI_CARD_DIGITAL_SIGNATURETYPE_JPKI_CARD_USER_AUTHENTICATION

デフォルト値:

TYPE_UNSPECIFIED

created_at

string <date-time>

証明書がPocketSign Verify APIに記録された時刻 PocketSign Verify APIサーバーの時刻が記録されます。

可選

certificate_status

object (証明書の失効確認履歴)

可選

string

証明書状態ID

可選

status

enum<string>

可選

STATUS_GOOD: 証明書が有効である

STATUS_REVOKED: 証明書が失効している

列挙型:

STATUS_UNSPECIFIEDSTATUS_GOODSTATUS_REVOKED

デフォルト値:

STATUS_UNSPECIFIED

check_method

enum<string>

可選

CHECK_METHOD_CRL: CRLを参照して失効確認

CHECK_METHOD_OCSP: OCSPレスポンダに問い合わせて失効確認

列挙型:

CHECK_METHOD_UNSPECIFIEDCHECK_METHOD_CRLCHECK_METHOD_OCSP

デフォルト値:

CHECK_METHOD_UNSPECIFIED

check_purpose

enum<string>

可選

CHECK_PURPOSE_SIGNATURE_VERIFICATION: 署名検証のため

CHECK_PURPOSE_LIVENESS_CHECK: 現況確認のため

列挙型:

CHECK_PURPOSE_UNSPECIFIEDCHECK_PURPOSE_SIGNATURE_VERIFICATIONCHECK_PURPOSE_LIVENESS_CHECK

デフォルト値:

CHECK_PURPOSE_UNSPECIFIED

source_updated_at

string <date-time>

証明書失効状態の確認に利用したデータソースの更新日時 CRLやOCSPレスポンスに含まれる `thisUpdate` に相当します。 CRLにシリアル番号が含まれない場合は設定されません。

可選

revoked_at

string <date-time>

証明書が失効した日時証明書が失効していない場合は設定されません。

可選

revocation_reason

enum<string>

可選

列挙型:

CRL_REASON_UNSPECIFIEDCRL_REASON_KEY_COMPROMISECRL_REASON_CA_COMPROMISECRL_REASON_AFFILIATION_CHANGEDCRL_REASON_SUPERSEDEDCRL_REASON_CESSATION_OF_OPERATIONCRL_REASON_CERTIFICATE_HOLDCRL_REASON_REMOVE_FROM_CRLCRL_REASON_PRIVILEGE_WITHDRAWNCRL_REASON_AA_COMPROMISE

デフォルト値:

CRL_REASON_UNSPECIFIED

created_at

string <date-time>

失効確認を行った日時

可選

user

object (利用者情報)

可選

string

利用者ID

可選

created_at

string <date-time>

利用者が初めてPocketSign Verify APIに識別された日時

可選

例

{
  "certificate": {
    "id": "string",
    "type": "TYPE_UNSPECIFIED",
    "created_at": "2019-08-24T14:15:22Z"
  },
  "certificate_status": {
    "id": "string",
    "status": "STATUS_UNSPECIFIED",
    "check_method": "CHECK_METHOD_UNSPECIFIED",
    "check_purpose": "CHECK_PURPOSE_UNSPECIFIED",
    "source_updated_at": "2019-08-24T14:15:22Z",
    "revoked_at": "2019-08-24T14:15:22Z",
    "revocation_reason": "CRL_REASON_UNSPECIFIED",
    "created_at": "2019-08-24T14:15:22Z"
  },
  "user": {
    "id": "string",
    "created_at": "2019-08-24T14:15:22Z"
  }
}

🔴500An unexpected error response.