Set login access key

Prev Next

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:

Method URI
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:

Field Type Required Description
loginAlias String Required Sub 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:

Field Type Required Description
success Boolean - 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
}