Method: vdc.getCredentialStatus

証明書の現在のステータスを取得するためのエンドポイント。

HTTP リクエスト

POST https://example.issuer.com/api/v1/vdc/getCredentialStatus

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "requestMetadata": {
    object (RequestMetadata)
  },
  "deviceReferenceId": string,
  "credentialId": string
}
フィールド
requestMetadata

object (RequestMetadata)

リクエストに関するメタデータ。すべてのリクエストで必須。
deviceReferenceId

string

デバイスに対応する ID とデバイスに関連付けられた ID 鍵。これはデバイス ID ではありません。つまり、ユーザーが同じデバイスで 2 種類の認証情報を使用する場合、この ID はそれぞれの認証情報で異なります。

この ID はすべてのリクエストで提供され、リクエストとリクエストを関連付けるために使用できます。
credentialId

string

呼び出し元がステータスをリクエストしている認証情報の ID。

レスポンスの本文

認証情報の現在のステータスを含むレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "responseMetadata": {
    object (ResponseMetadata)
  },
  "credentialStatus": {
    object (CredentialStatus)
  },
  "credentialVersionId": string
}
フィールド
responseMetadata

object (ResponseMetadata)

レスポンスに関するメタデータ。すべてのレスポンスで必須。
credentialStatus

object (CredentialStatus)

認証情報の現在のステータス。
credentialVersionId

string

認証情報の現在のバージョン。認証情報の新しいバージョンが利用可能になった時点で変更されることが想定されています。これが変更される場合の例としては、ユーザーが認証情報のアドレスを更新して、基となる mdoc が最新でなくなった場合が挙げられます。

CredentialStatus

認証情報に含まれ得る種々のステータスを表すオブジェクト。

JSON 表現 
{
  "userActionRequired": {
    object (UserActionRequired)
  },

  // Union field status can be only one of the following:
  "provisionPending": {
    object (ProvisionPending)
  },
  "active": {
    object (Active)
  },
  "revoked": {
    object (Revoked)
  },
  "deleted": {
    object (Deleted)
  }
  // End of list of possible types for union field status.
}
フィールド
userActionRequired

object (UserActionRequired)

認証情報がより制限された状態（ACTIVE -> REVOKED など）に移行するのを防ぐためにユーザーが実行する必要があるアクション。
共用体フィールド status。認証情報にあり得る種々のステータスを含む oneof。status は次のいずれかになります。
provisionPending

object (ProvisionPending)

取得はできるが ProofOfProvisioning をまだ提供していない認証情報を表します。この状態の認証情報に対する vdc.provisionMobileSecurityObjects の呼び出しは、更新された ProofOfProvisioning がリクエストに含まれていない場合、失敗します。認証情報の作成時や、認証情報の新しいバージョンが利用可能な場合に、この状態になります。新しいバージョンの場合、ウォレットは認証情報を再プロビジョニングし、ProofOfProvisioning を提供して有効状態に戻る必要があります。
active

object (Active)

有効かつ使用可能な認証情報を表します。有効状態の認証情報に対してのみ、MSO を取得できます。
revoked

object (Revoked)

最終的な使用不可能状態の認証情報を表します。この認証情報が後で使用可能になることはありません。DELETED と同等ですが、この状態を設定できるのは発行者だけです。
deleted

object (Deleted)

一度プロビジョニングされたが、デバイスから削除された認証情報を表します。REVOKED と同等ですが、この状態を設定できるのはウォレットだけです。

ProvisionPending

この型にはフィールドがありません。

プロビジョニング保留中の認証情報ステータスを表すオブジェクト。このメッセージは今、意図的に空になっています。今後、新しいフィールドが追加される可能性があります。

有効

この型にはフィールドがありません。

有効な認証情報ステータスを表すオブジェクト。このメッセージは今、意図的に空になっています。今後、新しいフィールドが追加される可能性があります。

取り消し済み

この型にはフィールドがありません。

取り消し済みの認証情報ステータスを表すオブジェクト。このメッセージは今、意図的に空になっています。今後、新しいフィールドが追加される可能性があります。

削除済み

この型にはフィールドがありません。

削除済みの認証情報ステータスを表すオブジェクト。このメッセージは今、意図的に空になっています。今後、新しいフィールドが追加される可能性があります。

UserActionRequired

ユーザーが完了する必要があるタスク / アクションを表すオブジェクト。

JSON 表現 
{
  "deadlineTimeMillis": string,
  "deadlineEnforcementHint": {
    object (EnforcementHint)
  },

  // Union field action can be only one of the following:
  "submitProofing": {
    object (SubmitProofing)
  }
  // End of list of possible types for union field action.
}
フィールド
deadlineTimeMillis

string (int64 format)

アクションの有効期限が切れ、発行者が認証情報をより制限された状態に移行することが想定されるエポック時間。クライアントがユーザーにアクションの完了期限を警告するために使用しますが、制限を適用するかどうかは発行者に委ねられます。
deadlineEnforcementHint

object (EnforcementHint)

発行者がアクションの期限をどのように適用するかを説明するヒント。
共用体フィールド action。ユーザーが完了する必要があるアクション。action は次のいずれかになります。
submitProofing

object (SubmitProofing)

認証情報の証明を送信します。

EnforcementHint

発行者が必要なアクションをどのように実施するかを説明するヒント。

JSON 表現 
{

  // Union field hint can be only one of the following:
  "revocationHint": {
    object (RevocationHint)
  }
  // End of list of possible types for union field hint.
}
フィールド
共用体フィールド hint。適用ヒントのタイプ。hint は次のいずれかになります。
revocationHint

object (RevocationHint)

認証情報は発行元によって取り消されます。

RevocationHint

この型にはフィールドがありません。

認証情報は発行元によって取り消されます。

SubmitProofing

校正ステータスの詳細。

JSON 表現 
{

  // Union field ProofingAllowance can be only one of the following:
  "limitedAttempts": {
    object (LimitedAttempts)
  },
  "unlimitedAttempts": {
    object (UnlimitedAttempts)
  }
  // End of list of possible types for union field ProofingAllowance.
}
フィールド
共用体フィールド ProofingAllowance。現在の認証情報の検証試行。ProofingAllowance は次のいずれかになります。
limitedAttempts

object (LimitedAttempts)

ユーザーが検証を送信できる回数には上限があります。
unlimitedAttempts

object (UnlimitedAttempts)

ユーザーは検証を何度でも送信できます。発行者にはおすすめしません。

LimitedAttempts

ユーザーが検証を送信できる回数には上限があります。

JSON 表現 
{
  "remainingAttempts": integer,
  "maxAttempts": integer,
  "maxAttemptsEnforcementHint": {
    object (EnforcementHint)
  }
}
フィールド
remainingAttempts

integer

身元確認を送信できる残りの回数。これは UX メッセージの表示専用です。Google ウォレットはこの番号に対してアクションを行いません。
maxAttempts

integer

証明書を送信できる試行回数の上限。これは UX メッセージの表示専用です。Google ウォレットはこの番号に対してアクションを行いません。
maxAttemptsEnforcementHint

object (EnforcementHint)

発行者が最大試行回数をどのように適用するかを説明するヒント。

UnlimitedAttempts

この型にはフィールドがありません。

ユーザーは検証を何度でも送信できます。発行者にはおすすめしません。