Method: vdc.getCredentialStatus

Bir kimlik bilgisinin mevcut durumunu almak için kullanılan uç nokta.

HTTP isteği

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

İstek metni

İstek içeriği aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "requestMetadata": {
    object (RequestMetadata)
  },
  "deviceReferenceId": string,
  "credentialId": string
}
Alanlar
requestMetadata

object (RequestMetadata)

İstekle ilgili meta veriler (tüm isteklerde gereklidir).
deviceReferenceId

string

Cihaza karşılık gelen kimlik ve cihazla ilişkili kimlik anahtarı. Bu, bir cihaz kimliği DEĞİLDİR. Yani kullanıcının aynı cihazda iki ayrı kimlik bilgisi varsa bu kimlik bilgileri arasında farklılık gösterir.

Bu kimlik tüm isteklerde sağlanır ve istekleri ilişkilendirmek için kullanılabilir.
credentialId

string

Arayanın durumunu istediği kimlik bilgisinin kimliği.

Yanıt metni

Bir kimlik bilgisinin mevcut durumunu içeren yanıt.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "responseMetadata": {
    object (ResponseMetadata)
  },
  "credentialStatus": {
    object (CredentialStatus)
  },
  "credentialVersionId": string
}
Alanlar
responseMetadata

object (ResponseMetadata)

Yanıtla ilgili meta veriler. Tüm yanıtlarda gereklidir.
credentialStatus

object (CredentialStatus)

Kimlik bilgisinin mevcut durumu.
credentialVersionId

string

Kimlik bilgisinin mevcut sürümü. Bu durum, kimlik belgesinin yeni sürümleri kullanıma sunulduğunda değişebilir. Örneğin, kullanıcı kimlik belgesindeki adresini güncellediğinde bu durum değişir ve temel mdoc eski hale gelir.

CredentialStatus

Bir kimlik bilgisinin sahip olabileceği farklı durumları temsil eden bir nesne.

JSON gösterimi 
{
  "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.
}
Alanlar
userActionRequired

object (UserActionRequired)

Kullanıcının, kimlik bilgilerinin daha kısıtlanmış bir duruma (ör. ETKİN -> İPTAL EDİLDİ) geçmesini önlemek için yapması gereken işlem.
status birleşik alanı. Bir kimlik bilgisinin olası farklı durumlarını içeren bir oneof. status aşağıdakilerden yalnızca biri olabilir:
provisionPending

object (ProvisionPending)

Alınabilen ancak henüz ProofOfProvisioning sağlanmamış bir kimlik bilgisini temsil eder. Bu durumda olan bir kimlik bilgisi için vdc.provisionMobileSecurityObjects'e yapılan tüm çağrılar, istek güncellenmiş bir ProofOfProvisioning içermiyorsa başarısız olmalıdır. Kimlik bilgileri oluşturulduklarında ve yeni bir kimlik bilgisi sürümü kullanıma sunulduğunda bu duruma getirilir. Yeni sürümde, cüzdanın kimlik bilgisini yeniden sağlaması ve ETKİN duruma geri dönmek için ProofOfProvisioning sağlaması gerekir.
active

object (Active)

Etkin ve kullanılabilir bir kimlik bilgisini temsil eder. MSO'lar yalnızca ETKİN durumdaki bir kimlik bilgisi için alınabilir.
revoked

object (Revoked)

Nihai ve kullanılamaz durumda olan bir kimlik bilgisini temsil eder. Bu kimlik bilgisi gelecekte kullanılamaz. Bu durum, SİLİNDİ durumuna benzer ancak yalnızca veren kuruluş tarafından ayarlanabilir.
deleted

object (Deleted)

Bir zamanlar sağlanan ancak cihazdan silinen kimlik bilgisini temsil eder. Bu durum, İPTAL EDİLDİ durumuna benzer ancak yalnızca cüzdan tarafından ayarlanabilir.

ProvisionPending

Bu türde alan yok.

Bekleyen kimlik durumu sağlayan bir hükmü temsil eden nesne. Bu mesaj şu anda kasıtlı olarak boş. Gelecekte yeni alanlar eklenebilir.

Etkin

Bu türde alan yok.

Etkin bir kimlik bilgisi durumunu temsil eden nesne. Bu mesaj şu anda kasıtlı olarak boş. Gelecekte yeni alanlar eklenebilir.

Sonlandırıldı

Bu türde alan yok.

İptal edilmiş bir kimlik bilgisi durumunu temsil eden nesne. Bu mesaj şu anda kasıtlı olarak boş. Gelecekte yeni alanlar eklenebilir.

Silindi

Bu türde alan yok.

Silinmiş bir kimlik bilgisi durumunu temsil eden nesne. Bu mesaj şu anda kasıtlı olarak boş. Gelecekte yeni alanlar eklenebilir.

UserActionRequired

Kullanıcının tamamlaması gereken bir görevi / işlemi temsil eden nesne.

JSON gösterimi 
{
  "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.
}
Alanlar
deadlineTimeMillis

string (int64 format)

İşlemin süresinin dolduğu ve veren kuruluşun kimlik bilgisini daha kısıtlı bir duruma taşımasının beklendiği dönem. İstemci tarafından, işlemin ne zamana kadar tamamlanması gerektiği konusunda kullanıcıyı uyarmak için kullanılır ancak kısıtlamaları uygulamak veren kuruluşun sorumluluğundadır.
deadlineEnforcementHint

object (EnforcementHint)

Düzenleyenin, işlemin son tarihini nasıl uygulayacağını açıklayan ipucu.
action birleşik alanı. Kullanıcının tamamlaması gereken işlem. action aşağıdakilerden yalnızca biri olabilir:
submitProofing

object (SubmitProofing)

Kimlik bilgisinin onayını gönderin.

EnforcementHint

Düzenleyenin, gerekli işlemi nasıl uygulayacağını açıklayan ipucu.

JSON gösterimi 
{

  // Union field hint can be only one of the following:
  "revocationHint": {
    object (RevocationHint)
  }
  // End of list of possible types for union field hint.
}
Alanlar
hint birleşik alanı. Yaptırım ipucu türü. hint aşağıdakilerden yalnızca biri olabilir:
revocationHint

object (RevocationHint)

Kimlik bilgisi, veren kuruluş tarafından iptal edilir.

RevocationHint

Bu türde alan yok.

Kimlik bilgisi, veren kuruluş tarafından iptal edilir.

SubmitProofing

Düzeltme durumunun ayrıntıları.

JSON gösterimi 
{

  // 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.
}
Alanlar
ProofingAllowance birleşik alanı. Mevcut kimlik bilgisiyle ilgili doğrulama girişimi. ProofingAllowance aşağıdakilerden yalnızca biri olabilir:
limitedAttempts

object (LimitedAttempts)

Kullanıcının düzeltme göndermek için sınırlı sayıda deneme hakkı vardır.
unlimitedAttempts

object (UnlimitedAttempts)

Kullanıcı, düzeltme göndermek için sınırsız sayıda deneme yapabilir. Bu işlem, kartı veren kuruluş için önerilmez.

LimitedAttempts

Kullanıcının düzeltme göndermek için sınırlı sayıda deneme hakkı vardır.

JSON gösterimi 
{
  "remainingAttempts": integer,
  "maxAttempts": integer,
  "maxAttemptsEnforcementHint": {
    object (EnforcementHint)
  }
}
Alanlar
remainingAttempts

integer

Düzeltme göndermek için kalan deneme sayısı. Bu yalnızca kullanıcı deneyimi mesajı görüntüleme içindir. Google Cüzdan bu numara için işlem yapmaz.
maxAttempts

integer

Düzeltme göndermek için izin verilen maksimum deneme sayısı. Bu yalnızca kullanıcı deneyimi mesajı görüntüleme içindir. Google Cüzdan bu numara için işlem yapmaz.
maxAttemptsEnforcementHint

object (EnforcementHint)

Düzenleyenin, maksimum deneme sayısını nasıl uygulayacağını açıklayan ipucu.

UnlimitedAttempts

Bu türde alan yok.

Kullanıcı, düzeltme göndermek için sınırsız sayıda deneme yapabilir. Bu işlem, kartı veren kuruluş için önerilmez.