resetPassword

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

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

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

입력된 비밀번호 또는 자동 생성된 비밀번호로 지정한 서브 계정의 비밀번호를 재설정합니다. 자동 생성(passwordGenerationRequired=true)한 경우에만 생성된 비밀번호를 응답으로 반환합니다.

요청

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

메서드	URI
POST	/sub-accounts/{subAccountId}/reset-password

요청 헤더

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

요청 경로 파라미터

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

필드	타입	필수 여부	설명
`subAccountId`	String (uuid)	Required	대상 서브 계정의 식별자 <예시> 4e066e50-9c3a-11e7-8a66-1e5021fa7c80

요청 바디

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

필드	타입	필수 여부	설명
`newPassword`	String	Optional	새로 설정할 비밀번호. passwordGenerationRequired가 false인 경우 필수로 입력 <예시> P@ssw0rd!23
`passwordGenerationRequired`	Boolean	Optional	비밀번호 자동 생성 필요 여부 `true` \| `false` `true`: 난수화된 비밀번호를 자동 생성. 자동 생성된 비밀번호는 생성 완료 시점에 1회만 확인 가능 `false`: newPassword에 입력한 값을 사용 기본값: false <예시> false

요청 예시

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

curl --location --request POST 'https://subaccount.apigw.gov-ntruss.com/api/v2/sub-accounts/4e066e50-9c3a-11e7-8a66-1e5021fa7c80/reset-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'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`generatedPassword`	String	-	자동 생성된 비밀번호. passwordGenerationRequired=true로 재설정한 경우에만 반환되며, 입력한 비밀번호로 재설정한 경우에는 응답에 포함되지 않음 <예시> P@ssw0rd!23

응답 상태 코드

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

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

HTTP 상태 코드	코드	메시지	설명
200	-	-	비밀번호 재설정 결과를 반환. passwordGenerationRequired를 true로 지정한 경우에만 generatedPassword가 포함
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.	요청한 자원(또는 상위 자원)에 대한 접근 권한 없음. 자원의 존재 여부와 무관하게 우선 반환
404	SubAccountNotFound	The specified sub account could not be found.	지정한 서브 계정이 존재하지 않음

응답 예시

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

{
  "generatedPassword": "P@ssw0rd!23"
}