MENU
      Check login password

        Check login password


        Article summary

        Available in Classic and VPC

        Check the validity and complexity of the login password to be used for a sub account.

        Request

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

        MethodURI
        GET/api/v1/join/check-password

        Request headers

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

        Request query parameters

        You can use the following query parameters with your request:

        FieldTypeRequiredDescription
        passwordStringRequiredSub account login password
        • 8-16 characters using a combination of English uppercase and lowercase letters, numbers, and special characters

        Request example

        The request example is as follows:

        curl --location --request GET 'https://subaccount.apigw.ntruss.com/api/v1/join/check-password?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'
        Shell

        Response

        This section describes the response format.

        Response body

        The response body includes the following data:

        FieldTypeRequiredDescription
        successBoolean-Sub account login password check result
        • true | false
          • true: available password
          • false: unavailable password
        messageString-Reason for unavailability
        • Display if success 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:

        If the check shows that the password is available

        The following is a sample response if the check result is an available password.

        {
            "success": true
        }
        JSON

        If the check shows that the password is unavailable

        The following is a sample response if the check result is an unavailable password.

        {
            "success": false,
            "message": "Unsafe password."
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.