署名検証結果の検索

Requestパラメータ

Request Bodyパラメータapplication/json

page_size

integer <int32>

一度に取得する署名検証結果の最大件数指定しない場合、デフォルト値(100件)が適用されます。

可選

page_token

string

取得するページのトークン前回のリクエストで取得した `next_page_token` を指定することで、残りのデータを取得することができます。指定しない場合、先頭のページから取得します。この値は一時的なものであり、再利用することはできません。

可選

filter

object (v2ListVerificationsRequestFilter)

可選

certificate_ids

array[string]

取得対象に含める署名検証結果に対応する証明書ID

可選

certificate_types

array[string]

取得対象に含める署名検証結果に対応する証明書の種別

可選

列挙型:

TYPE_UNSPECIFIEDTYPE_JPKI_CARD_DIGITAL_SIGNATURETYPE_JPKI_CARD_USER_AUTHENTICATION

user_ids

array[string]

取得対象に含める署名検証結果に対応する証明書の所有者に対応する利用者ID

可選

created_since

string <date-time>

取得対象に含める日時の範囲（開始）

可選

created_until

string <date-time>

取得対象に含める日時の範囲（終了）

可選

例

{
  "page_size": 0,
  "page_token": "string",
  "filter": {
    "certificate_ids": [
      "string"
    ],
    "certificate_types": [
      "TYPE_UNSPECIFIED"
    ],
    "user_ids": [
      "string"
    ],
    "created_since": "2019-08-24T14:15:22Z",
    "created_until": "2019-08-24T14:15:22Z"
  }
}

サンプルコード

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://verify.mock.p8n.app/pocketsign.verify.v2.VerificationService/ListVerifications' \
--header 'Content-Type: application/json' \
--data-raw '{
    "page_size": 0,
    "page_token": "string",
    "filter": {
        "certificate_ids": [
            "string"
        ],
        "certificate_types": [
            "TYPE_UNSPECIFIED"
        ],
        "user_ids": [
            "string"
        ],
        "created_since": "2019-08-24T14:15:22Z",
        "created_until": "2019-08-24T14:15:22Z"
    }
}'

Response

🟢200A successful response.

application/json

Body

next_page_token

string

次のページを取得するためのトークンこの値をリクエストの `page_token` に指定することで、次のページを取得することができます。次のページがない場合は空文字列が返却されます。

可選

total_size

integer <int32>

検索条件に該当する署名検証結果の総件数

可選

responses

array[object (v2GetVerificationResponse) {4}]

検索条件に該当する署名検証結果

可選

verification

object (署名検証の結果)

可選

certificate

object (証明書情報)

可選

certificate_status

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

可選

user

object (利用者情報)

可選

例

{
  "next_page_token": "string",
  "total_size": 0,
  "responses": [
    {
      "verification": {
        "id": "string",
        "result": "RESULT_UNSPECIFIED",
        "hash_algorithm": "HASH_ALGORITHM_UNSPECIFIED",
        "digest": "string",
        "signature": "string",
        "created_at": "2019-08-24T14:15:22Z"
      },
      "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.