Method: vdc.getCredentialStatus

Một điểm cuối để truy xuất trạng thái hiện tại của thông tin xác thực.

Yêu cầu HTTP

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

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu với cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "requestMetadata": {
    object (RequestMetadata)
  },
  "deviceReferenceId": string,
  "credentialId": string
}
Trường
requestMetadata

object (RequestMetadata)

Siêu dữ liệu về yêu cầu, bắt buộc trong tất cả các yêu cầu.
deviceReferenceId

string

Mã nhận dạng tương ứng với thiết bị và khoá nhận dạng được liên kết với thiết bị. Đây KHÔNG phải là mã nhận dạng thiết bị, tức là nếu người dùng có hai thông tin đăng nhập riêng biệt trên cùng một thiết bị, thì mã nhận dạng này sẽ khác nhau giữa hai thông tin đăng nhập đó.

Mã nhận dạng này được cung cấp trong tất cả các yêu cầu và có thể dùng để tương quan các yêu cầu.
credentialId

string

Mã nhận dạng của thông tin đăng nhập mà người gọi đang yêu cầu trạng thái.

Nội dung phản hồi

Phản hồi chứa trạng thái hiện tại của một thông tin xác thực.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "responseMetadata": {
    object (ResponseMetadata)
  },
  "credentialStatus": {
    object (CredentialStatus)
  },
  "credentialVersionId": string
}
Trường
responseMetadata

object (ResponseMetadata)

Siêu dữ liệu về phản hồi, bắt buộc trong tất cả các phản hồi.
credentialStatus

object (CredentialStatus)

Trạng thái hiện tại của thông tin đăng nhập.
credentialVersionId

string

Phiên bản hiện tại của thông tin đăng nhập. Điều này dự kiến sẽ thay đổi khi có các phiên bản mới của thông tin đăng nhập. Ví dụ về trường hợp này là khi người dùng cập nhật địa chỉ trên thông tin xác thực của họ, khiến mdoc cơ bản trở nên lỗi thời.

CredentialStatus

Một đối tượng đại diện cho các trạng thái mà thông tin đăng nhập có thể có.

Biểu diễn dưới dạng 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.
}
Trường
userActionRequired

object (UserActionRequired)

Việc người dùng cần làm để tránh thông tin đăng nhập của họ chuyển sang trạng thái bị hạn chế hơn (ví dụ: ACTIVE -> REVOKED).
Trường nhóm status. Một oneof chứa các trạng thái có thể có của thông tin đăng nhập. status chỉ có thể là một trong những trạng thái sau:
provisionPending

object (ProvisionPending)

Biểu thị một thông tin đăng nhập có thể truy xuất, nhưng chưa cung cấp ProofOfProvisioning. Mọi lệnh gọi đến vdc.provisionMobileSecurityObjects cho một thông tin đăng nhập ở trạng thái này sẽ không thành công nếu yêu cầu không chứa ProofOfProvisioning đã cập nhật. Thông tin đăng nhập sẽ ở trạng thái này khi được tạo và khi có phiên bản mới của thông tin đăng nhập. Đối với trường hợp phiên bản mới, ví phải cung cấp lại thông tin xác thực và cung cấp ProofOfProvisioning để quay lại trạng thái ĐANG HOẠT ĐỘNG.
active

object (Active)

Biểu thị một thông tin đăng nhập đang hoạt động và có thể sử dụng. Bạn chỉ có thể truy xuất MSO cho thông tin xác thực ở trạng thái ĐANG HOẠT ĐỘNG.
revoked

object (Revoked)

Biểu thị một thông tin đăng nhập ở trạng thái cuối cùng, không sử dụng được. Thông tin đăng nhập này sẽ không thể sử dụng được trong tương lai. Trạng thái này tương đương với trạng thái ĐÃ XOÁ, nhưng chỉ có thể được đặt bởi tổ chức phát hành.
deleted

object (Deleted)

Biểu thị một thông tin đăng nhập đã từng được cung cấp nhưng đã bị xoá khỏi thiết bị. Trạng thái này tương đương với trạng thái REVOKED, nhưng chỉ có thể được thiết lập bởi ví.

ProvisionPending

Loại này không có trường nào.

Một đối tượng đại diện cho trạng thái thông tin đăng nhập đang chờ cấp phép. Thông báo này hiện đang cố tình để trống. Các trường mới có thể được thêm vào trong tương lai.

Đang hoạt động

Loại này không có trường nào.

Một đối tượng đại diện cho trạng thái thông tin đăng nhập đang hoạt động. Thông báo này hiện đang cố tình để trống. Các trường mới có thể được thêm vào trong tương lai.

Đã bị thu hồi

Loại này không có trường nào.

Một đối tượng biểu thị trạng thái thông tin đăng nhập bị thu hồi. Thông báo này hiện đang cố tình để trống. Các trường mới có thể được thêm vào trong tương lai.

Đã xoá

Loại này không có trường nào.

Một đối tượng biểu thị trạng thái thông tin đăng nhập đã bị xoá. Thông báo này hiện đang cố tình để trống. Các trường mới có thể được thêm vào trong tương lai.

UserActionRequired

Một đối tượng đại diện cho nhiệm vụ / hành động mà người dùng cần hoàn thành.

Biểu diễn dưới dạng 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.
}
Trường
deadlineTimeMillis

string (int64 format)

Thời gian bắt đầu khi hành động hết hạn và tổ chức phát hành dự kiến sẽ chuyển thông tin xác thực sang trạng thái hạn chế hơn. Được ứng dụng sử dụng để cảnh báo người dùng về thời hạn hoàn thành hành động, nhưng bên phát hành có quyền thực thi các hạn chế.
deadlineEnforcementHint

object (EnforcementHint)

Gợi ý mô tả cách tổ chức phát hành sẽ thực thi thời hạn của hành động.
Trường nhóm action. Hành động mà người dùng cần hoàn tất. action chỉ có thể là một trong những trạng thái sau:
submitProofing

object (SubmitProofing)

Gửi bằng chứng về thông tin xác thực.

EnforcementHint

Gợi ý mô tả cách tổ chức phát hành sẽ thực thi hành động bắt buộc.

Biểu diễn dưới dạng JSON 
{

  // Union field hint can be only one of the following:
  "revocationHint": {
    object (RevocationHint)
  }
  // End of list of possible types for union field hint.
}
Trường
Trường nhóm hint. Loại gợi ý thực thi. hint chỉ có thể là một trong những trạng thái sau:
revocationHint

object (RevocationHint)

Thông tin đăng nhập sẽ bị đơn vị phát hành thu hồi.

RevocationHint

Loại này không có trường nào.

Thông tin đăng nhập sẽ bị đơn vị phát hành thu hồi.

SubmitProofing

Thông tin chi tiết về trạng thái hiệu đính.

Biểu diễn dưới dạng 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.
}
Trường
Trường nhóm ProofingAllowance. Nỗ lực xác minh trên thông tin đăng nhập hiện tại. ProofingAllowance chỉ có thể là một trong những trạng thái sau:
limitedAttempts

object (LimitedAttempts)

Người dùng chỉ có một số lần nhất định để gửi thông tin chứng minh.
unlimitedAttempts

object (UnlimitedAttempts)

Người dùng có thể gửi bằng chứng bao nhiêu lần tuỳ thích. Tổ chức phát hành không nên làm như vậy.

LimitedAttempts

Người dùng chỉ có một số lần nhất định để gửi thông tin chứng minh.

Biểu diễn dưới dạng JSON 
{
  "remainingAttempts": integer,
  "maxAttempts": integer,
  "maxAttemptsEnforcementHint": {
    object (EnforcementHint)
  }
}
Trường
remainingAttempts

integer

Số lần còn lại để gửi bằng chứng. Điều này chỉ dành cho việc hiển thị thông báo UX. Google Wallet sẽ không xử lý số này.
maxAttempts

integer

Số lần gửi bằng chứng tối đa. Điều này chỉ dành cho việc hiển thị thông báo UX. Google Wallet sẽ không xử lý số này.
maxAttemptsEnforcementHint

object (EnforcementHint)

Gợi ý mô tả cách tổ chức phát hành sẽ thực thi số lần thử tối đa.

UnlimitedAttempts

Loại này không có trường nào.

Người dùng có thể gửi bằng chứng bao nhiêu lần tuỳ thích. Tổ chức phát hành không nên làm như vậy.