전화 번호로 인증 시작

전화 번호로 인증 시작Client-side

post/login/phone/request

사용자 전화 번호로 인증을 시작하고 전화 번호로 확인 코드를 보냅니다. 코드는 3분 동안만 사용할 수 있습니다.

이 호출은 전화 번호로 인증 완료 호출에만 사용합니다.

이 호출을 사용하는 워크플로:

애플리케이션에서 사용자가 전화 번호를 입력할 수 있도록 인증 양식을 엽니다.
사용자가 전화 번호를 입력합니다.
애플리케이션이 이 요청을 엑솔라 로그인 서버로 전송합니다. a. send_link 매개변수가 true인 경우 이 요청 후에 확인 코드 가져오기 요청을 전송하여 SMS에 확인 코드와 링크가 포함되도록 해야 합니다. b. send_link 매개변수가 false이거나 전달되지 않으면 SMS에 확인 코드만 포함됩니다.
엑솔라 로그인 서버가 SMS를 전송하고 확인 코드의 ID를 반환합니다.
사용자가 확인 코드를 입력할 수 있도록 애플리케이션이 필드를 표시합니다.
사용자가 받은 확인 코드를 입력하거나 링크를 따라 이동합니다.
애플리케이션이 전화 번호로 인증 완료 요청을 엑솔라 로그인 서버로 전송합니다.
사용자가 인증된 것으로 간주됩니다.

Request

projectId required	string <uuid> 게시자 계정의 로그인 프로젝트 ID입니다.
login_url	string URL to redirect the user to after account confirmation, successful authentication, two-factor authentication configuration, or password reset confirmation. Must be identical to the Callback URL specified in the URL block of Publisher Account. For the scenario of a login error, the value should be identical to the the Error callback URL specified in the URL block of Publisher Account. To find the settings, go to Login > your Login project and select the Callback URLs section in the upper block. Required if there are several Callback URLs.
payload	string Your custom data. The value of the parameter will be returned in the `payload` claim of the user JWT. Recommended maximum length less than 500 characters. Note, that this parameter is only available if you use a custom user data storage.
with_logout	string Default: "0" 기존 사용자 JWT 값을 비활성화하고 이 호출로 생성한 값을 활성화할지 여부를 표시합니다. 사용 가능한 값: '1'은 기존 값을 비활성화하고 새 값을 활성화합니다. '0'은 기존 값을 활성화 상태로 유지합니다.

phone_number required	string^\+(\d){5,25}$ 전화번호.
link_url	string <uri> 사용자를 상태 인증 페이지로 리디렉션하는 URL입니다.매개변수 `send_link`가 `true`인 경우 필수입니다.
send_link	boolean SMS에서 확인 코드와 함께 링크를 전송했는지 여부를 표시합니다. 로그인에 확인 코드 대신 링크를 사용할 수 있습니다. 매개변수에 `true` 값이 있으면 SMS로 링크가 전송됩니다.

Responses

200

확인

404

찾을 수 없음

422

처리할 수 없는 엔터티

429

요청이 너무 많음

Request samples

application/json

{"link_url": "http://example.com",
"phone_number": "string",
"send_link": true
}

Response samples

application/json

{"operation_id": "string"
}