등록 검색 API 계약

온라인에서 편집하기

거의 모든 외부 MFA 통합은 Verify에서 특정 사용자에 대해 현재 사용 가능한 모든 MFA 요소 기능을 찾는 ISV 기능을 지원해야 합니다. 실행하면 Verify에서 각 오브젝트가 사용자의 MFA 기능을 식별하고 나타내는 JSON 오브젝트 목록이 응답에 포함될 것으로 예상합니다.

다음 예시에서는 가 실시간 웹훅의 리소스로 enrollmentsVerify 전송하는 요청 예시를 보여줍니다. 웹훅 구성에 따라 이 동일한 페이로드를 대상 MFA 제공자에 직접 전송하거나 대상 제공자가 승인 가능한 API 클라이언트 요청으로 변환할 수 있습니다.

POST '/enrollments' \
'Content-Type: application/json' \
'Accept: application/json' \

{
    "username": "<<external MFA username>>"
}

참고: 이 예시에서 /enrollmentsHTTP 경로는 웹훅 구성에 따라 달라집니다.

등록 검색 요청 세부사항

요소	설명
HTTP 요청	POST
HTTP 헤더 - Content-Type	요청 페이로드의 컨텐츠 유형은 항상 `application/json`입니다.
HTTP 헤더 - Accept	응답 페이로드에 대해 예상되는 컨텐츠 유형은 항상 `application/json`입니다.
페이로드	등록이 요청된 사용자를 식별하는 JSON 오브젝트입니다.
사용자 이름	필수. 등록 데이터가 요청된 외부 제공자 시스템의 사용자 이름입니다.

다음 샘플은 enrollment lookup 응답 페이로드의 예제입니다.

[
    {
        "attributes": {
            "authExecutionFlow": "init_then_poll",
            "deviceName": "<<Device name if available>>",
        },
        "capability": "<<factor capability name, e.g. push>>",
        "id": "<<factor or device identifier from external provider>>"
    },
    {
        "attributes": {
            "authExecutionFlow": "init_then_validate",
            "deliveryAddress": "<<e.g. phone number or email address>>",
            "deviceName": "<<Device name if available>>",
        },
        "capability": "<<factor capability name, e.g. smsotp>>",
        "id": "<<factor or device identifier from external provider>>"
    },
    {
        "attributes": {
            "authExecutionFlow": "validate",
            "deviceName": "<<Device name if available>>",
        },
        "capability": "<<factor capability name, e.g. totp>>",
        "id": "<<factor or device identifier from external provider>>"
    }
]

등록 검색 응답 세부사항

요소	설명
페이로드 유형	외부 MFA 등록의 JSON 배열입니다.
HTTP 상태 코드	HTTP 상태를 참조하십시오.
`id`	필수. 사용자의 등록된 MFA 요소 기능의 고유 ID입니다.
`capability`	필수. 값은 유효한 문자열입니다. 웹훅과 연관된 MFA 제공자에 대해 구성된 기능 중 하나와 일치해야 합니다.
`attributes`	필수. 등록 검색을 트리거한 공용 Verify 클라이언트에 리턴되는 추가 속성입니다. 더 많은 속성 및 값이 있을 수 있습니다.
`attributes.authExecutionFlow`	필수. 요소 기능에서 지원되는 `MFA pattern`을 Verify에 알립니다. 유효한 값은 다음과 같습니다. `validate` - 유효성 검증 전용 패턴입니다. `init_then_validate` - 시작 후 유효성 검증 패턴입니다. `init_then_poll` - 시작 후 완료 대기 패턴입니다. 이 속성은 Verify 외부 MFA 런타임 인증 확인 UI/UX 및 프레임워크에서 런타임 실행을 구동하는 데 사용됩니다.
`attributes.deliveryAddress`	선택사항. 실행 패턴에 MFA 토큰 전달 또는 유사한 환경이 포함된 경우 Verify에서 MFA 사용자 선택 중에 이 속성을 표시합니다. 이 패턴은 제공되는 MFA 선택에 대한 도움을 주고 사용자 선택사항을 알릴 수 있습니다.
`attributes.deviceName`	선택사항. 실행 패턴에 MFA 토큰 전달 환경이 포함되거나 사용자가 소유한 일종의 별도 인증 디바이스 또는 토큰이 포함된 경우 Verify에서 MFA 사용자 선택 중에 이 속성을 표시합니다. 이 패턴은 제공되는 MFA 선택에 대한 도움을 주고 사용자 선택사항을 알릴 수 있습니다.