Method: vdc.getCredentialStatus

Punkt końcowy do pobierania bieżącego stanu danych logowania.

Żądanie HTTP

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

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "requestMetadata": {
    object (RequestMetadata)
  },
  "deviceReferenceId": string,
  "credentialId": string
}
Pola
requestMetadata

object (RequestMetadata)

Metadane dotyczące żądania, wymagane we wszystkich żądaniach.
deviceReferenceId

string

Identyfikator odpowiadający urządzeniu i klucz tożsamości powiązany z urządzeniem. NIE jest to identyfikator urządzenia, co oznacza, że jeśli użytkownik ma 2 osobne dane logowania na tym samym urządzeniu, ten identyfikator będzie się różnić.

Ten identyfikator jest podawany we wszystkich żądaniach i może służyć do ich korelowania.
credentialId

string

Identyfikator danych logowania, których stan jest sprawdzany przez wywołującego.

Treść odpowiedzi

Odpowiedź zawierająca bieżący stan danych logowania.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "responseMetadata": {
    object (ResponseMetadata)
  },
  "credentialStatus": {
    object (CredentialStatus)
  },
  "credentialVersionId": string
}
Pola
responseMetadata

object (ResponseMetadata)

Metadane dotyczące odpowiedzi, wymagane we wszystkich odpowiedziach.
credentialStatus

object (CredentialStatus)

Bieżący stan danych logowania.
credentialVersionId

string

Bieżąca wersja dokumentu. Oczekujemy, że zmieni się to, gdy pojawią się nowe wersje dokumentu tożsamości. Przykładem sytuacji, w której to nastąpi, jest aktualizacja adresu na dokumencie tożsamości przez użytkownika, co powoduje, że powiązany z nim dokument mdoc staje się nieaktualny.

CredentialStatus

Obiekt reprezentujący różne stany, w jakich mogą znajdować się dane logowania.

Zapis 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.
}
Pola
userActionRequired

object (UserActionRequired)

Działanie wymagane od użytkownika, aby uniknąć przejścia danych logowania do stanu z większymi ograniczeniami (np. ACTIVE –> REVOKED).
Pole zbiorcze status. Typ oneof zawierający różne stany, które może przyjmować dokument tożsamości. status może mieć tylko jedną z tych wartości:
provisionPending

object (ProvisionPending)

Oznacza dane logowania, które można pobrać, ale nie dostarczono jeszcze dowodu Provisioning. Wszelkie wywołania vdc.provisionMobileSecurityObjects w przypadku danych logowania w tym stanie powinny kończyć się niepowodzeniem, jeśli żądanie nie zawiera zaktualizowanego dowodu Provisioning. Dane logowania są w tym stanie, gdy są tworzone i gdy dostępna jest ich nowa wersja. W przypadku nowej wersji portfel musi ponownie udostępnić dokument i przesłać dowód udostępnienia, aby wrócić do stanu AKTYWNY.
active

object (Active)

Reprezentuje aktywne i użyteczne dane logowania. MSOs można pobrać tylko w przypadku danych logowania w stanie AKTYWNE.
revoked

object (Revoked)

Reprezentuje dane logowania, które są w ostatecznym, nieużytecznym stanie. Te dane logowania nie będą mogły być używane w przyszłości. Ten stan jest porównywalny ze stanem USUNIĘTO, ale może go ustawić tylko wydawca.
deleted

object (Deleted)

Reprezentuje dane logowania, które zostały wcześniej udostępnione, ale zostały usunięte z urządzenia. Ten stan jest porównywalny ze stanem ODWOŁANO, ale może być ustawiony tylko przez portfel.

ProvisionPending

Ten typ nie ma pól.

Obiekt reprezentujący stan oczekiwania na udostępnienie danych logowania. Ta wiadomość jest obecnie celowo pusta. W przyszłości możemy dodać nowe pola.

Aktywne

Ten typ nie ma pól.

Obiekt reprezentujący stan aktywnego dokumentu. Ta wiadomość jest obecnie celowo pusta. W przyszłości możemy dodać nowe pola.

Unieważniono

Ten typ nie ma pól.

Obiekt reprezentujący stan unieważnionych danych logowania. Ta wiadomość jest obecnie celowo pusta. W przyszłości możemy dodać nowe pola.

Usunięto

Ten typ nie ma pól.

Obiekt reprezentujący stan usuniętych danych logowania. Ta wiadomość jest obecnie celowo pusta. W przyszłości możemy dodać nowe pola.

UserActionRequired

Obiekt reprezentujący zadanie lub działanie, które użytkownik musi wykonać.

Zapis 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.
}
Pola
deadlineTimeMillis

string (int64 format)

Czas epoki, w którym wygasa działanie i wystawca powinien przenieść dane logowania do bardziej ograniczonego stanu. Używane przez klienta do ostrzegania użytkownika o terminie wykonania działania, ale egzekwowanie ograniczeń należy do wystawcy.
deadlineEnforcementHint

object (EnforcementHint)

Wskazówka opisująca, w jaki sposób wystawca będzie egzekwować termin działania.
Pole zbiorcze action. Działanie, które użytkownik musi wykonać. action może mieć tylko jedną z tych wartości:
submitProofing

object (SubmitProofing)

Prześlij dowód potwierdzający dane logowania.

EnforcementHint

Wskazówka opisująca, w jaki sposób wystawca wymusi wykonanie wymaganego działania.

Zapis JSON 
{

  // Union field hint can be only one of the following:
  "revocationHint": {
    object (RevocationHint)
  }
  // End of list of possible types for union field hint.
}
Pola
Pole zbiorcze hint. Typ wskazówki dotyczącej egzekwowania. hint może mieć tylko jedną z tych wartości:
revocationHint

object (RevocationHint)

Dane logowania zostaną unieważnione przez wydawcę.

RevocationHint

Ten typ nie ma pól.

Dane logowania zostaną unieważnione przez wydawcę.

SubmitProofing

Szczegóły stanu weryfikacji.

Zapis 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.
}
Pola
Pole zbiorcze ProofingAllowance. Próba weryfikacji bieżących danych logowania. ProofingAllowance może mieć tylko jedną z tych wartości:
limitedAttempts

object (LimitedAttempts)

Użytkownik ma ograniczoną liczbę prób przesłania dowodu.
unlimitedAttempts

object (UnlimitedAttempts)

Użytkownik może przesyłać dowody weryfikacji bez ograniczeń. Nie jest to zalecane dla wydawcy.

LimitedAttempts

Użytkownik ma ograniczoną liczbę prób przesłania dowodu.

Zapis JSON 
{
  "remainingAttempts": integer,
  "maxAttempts": integer,
  "maxAttemptsEnforcementHint": {
    object (EnforcementHint)
  }
}
Pola
remainingAttempts

integer

Liczba pozostałych prób przesłania dowodu. Służy to tylko do wyświetlania wiadomości UX. Portfel Google nie będzie działać na tym numerze.
maxAttempts

integer

Maksymalna liczba prób przesłania dowodu. Służy to tylko do wyświetlania wiadomości UX. Portfel Google nie będzie działać na tym numerze.
maxAttemptsEnforcementHint

object (EnforcementHint)

Wskazówka opisująca, w jaki sposób wystawca będzie egzekwować maksymalną liczbę prób.

UnlimitedAttempts

Ten typ nie ma pól.

Użytkownik może przesyłać dowody weryfikacji bez ograniczeń. Nie jest to zalecane dla wydawcy.