Reset login password

Prev Next

Available in Classic and VPC

Edit the login password for a sub account.

Request

This section describes the request format. The method and URI are as follows:

Method URI
PUT /api/v1/sub-accounts/{subAccountId}/password

Request headers

For information about the headers common to all Sub Account APIs, see Sub Account request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
subAccountId String Required Sub account ID

Request body

You can include the following data in the body of your request:

Field Type Required Description
needPasswordGenerate Boolean Optional Sub account login password creation method
  • true | false
    • true: automatic creation
    • false: manual input
newPassword String Conditional Password to change
  • Required if needPasswordGenerate is false
  • If needPasswordGenerate is true, the password is created automatically regardless of the input value

Request example

The request example is as follows:

curl --location --request PUT 'https://subaccount.apigw.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
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
success Boolean - API call success status
  • true | false
    • true: succeeded
    • false: failed
generatedPassword String - Sub account login password
  • Display if needPasswordGenerate is false

Response status codes

For information about the HTTP status codes common to all Sub Account APIs, see Sub Account status codes.

Response example

The response example is as follows:

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