로그인 비밀번호 재설정

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

서브 계정의 로그인 비밀번호를 수정합니다.

요청

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

메서드	URI
PUT	/api/v1/sub-accounts/{subAccountId}/password

요청 헤더

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

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`subAccountId`	String	Required	서브 계정 아이디 서브 계정 목록 조회 참조

요청 바디

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

필드	타입	필수 여부	설명
`needPasswordGenerate`	Boolean	Optional	서브 계정 로그인 비밀번호 생성 방식 `true` \| `false` `true`: 자동 생성 `false`: 직접 입력
`newPassword`	String	Conditional	변경할 비밀번호 `needPasswordGenerate`가 `false`인 경우, 필수 입력 `needPasswordGenerate`가 `true`인 경우, 입력값과 관계 없이 비밀번호 자동 생성

요청 예시

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

curl --location --request PUT 'https://subaccount.apigw.gov-ntruss.com/api/v1/sub-accounts/2b141960-****-****-****-246e9659184c/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 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
    "needPasswordGenerate": true
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`success`	Boolean	-	API 호출 성공 여부 `true` \| `false` `true`: 성공 `false`: 실패
`generatedPassword`	String	-	서브 계정 로그인 비밀번호 `needPasswordGenerate`가 `false`인 경우, 표시

응답 상태 코드

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

응답 예시

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

{
    "success": true,
    "generatedPassword": "****************"
}