checkPassword

이 가이드는 API 명세를 기반으로 자동 생성했습니다.

Classic/VPC 환경에서 이용 가능합니다.

Ncloud API 표준 규격을 적용한 API입니다.

입력한 비밀번호가 요구되는 보안 수준을 충족하는지 검증합니다. 처리 결과로 비밀번호 사용 가능 여부를 제공하며, 충족하지 못한 경우 실패 사유를 설명하는 메시지를 함께 제공합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
POST	/sub-accounts/check-password

요청 헤더

Sub Account API에서 공통으로 사용하는 헤더에 대한 정보는 Sub Account 요청 헤더를 참조해 주십시오.

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`password`	String	Required	보안 정책 충족 여부를 확인할 비밀번호 <예시> P@ssw0rd!23

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request POST 'https://subaccount.apigw.gov-ntruss.com/api/v2/sub-accounts/check-password' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
  "password": "P@ssw0rd!23"
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`valid`	Boolean	-	비밀번호 보안 수준 충족 여부 `true` \| `false` `true`: 요구되는 보안 수준을 충족 `false`: 요구되는 보안 수준을 충족하지 않음 <예시> true
`reason`	String	-	충족하지 못한 경우의 사유 메시지. 충족하면 제공되지 않음 <예시> 비밀번호 보안 수준이 낮습니다.

응답 상태 코드

Sub Account API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Sub Account 응답 상태 코드를 참조해 주십시오.

이 API에만 해당하는 응답 상태 코드는 다음과 같습니다.

HTTP 상태 코드	코드	메시지	설명
200	-	-	비밀번호의 사용 가능 여부와 보안 등급을 반환
400	BadRequest	The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.	유효하지 않은 요청. 필수 필드 누락, 형식 오류 등 입력값 검증 실패
403	Forbidden	You do not have sufficient permissions to perform this action.	요청한 자원(또는 상위 자원)에 대한 접근 권한 없음. 자원의 존재 여부와 무관하게 우선 반환

응답 예시

응답 예시는 다음과 같습니다.

{
  "valid": true,
  "reason": "비밀번호 보안 수준이 낮습니다."
}