ログインアクセスキーの設定

Prev Next

Classic/VPC環境で利用できます。

サブアカウントのログインアクセスキーを設定します。

参考

サブアカウントログインアクセスキーは次のようにサブアカウントログインアドレスに使用されます。

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

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
PUT /api/v1/login-alias

リクエストヘッダ

Sub Account APIで共通して使用されるヘッダの詳細は、Sub Accountのリクエストヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
loginAlias String Required サブアカウントログインアクセスキー
  • 英字の小文字、数字を使用して3~20文字

リクエスト例

リクエストのサンプルコードは次の通りです。

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"
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
success Boolean - API呼び出しに成功したかどうか
  • true | false
    • true: 成功
    • false: 失敗

レスポンスステータスコード

Sub Account APIで共通して使用されるレスポンスステータスコードの詳細は、Sub Accountのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "success": true
}