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가 아닙니다. 즉, 사용자가 동일한 기기에서 별도의 사용자 인증 정보를 두 개 보유한 경우 이 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 상태로 돌아가야 합니다.
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

이 유형에는 필드가 없습니다.

사용자는 인증을 무제한으로 제출할 수 있습니다. 발급자에게는 권장되지 않습니다.