Set login access key
    • PDF

    Set login access key

    • PDF

    Article summary

    Available in Classic and VPC

    Set a sub account login access key.

    Note

    The sub account login access key is used for the sub account login address as follows.

    • https://www.ncloud.com/nsa/{loginAlias}

    Request

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

    MethodURI
    PUT/api/v1/login-alias

    Request headers

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

    Request body

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

    FieldTypeRequiredDescription
    loginAliasStringRequiredSub account login access key
    • 3-20 characters using lowercase English letters and numbers

    Request example

    The request example is as follows:

    curl --location --request PUT 'https://subaccount.apigw.ntruss.com/api/v1/login-alias' \
    --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 '{
        "loginAlias": "test123123"
    }'
    

    Response

    This section describes the response format.

    Response body

    The response body includes the following data:

    FieldTypeRequiredDescription
    successBoolean-API call success status
    • true | false
      • true: succeeded
      • false: failed

    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
    }
    

    Was this article helpful?

    What's Next
    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.