Classic/VPC環境で利用できます。
サブアカウント Access Keyの状態を設定します。サブアカウントで Access Keyを使用可能にするには有効化状態に、使用できないようにするには無効化状態に設定します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
PUT | /api/v1/sub-accounts/{subAccountId}/access-keys |
リクエストヘッダ
Sub Account APIで共通して使用されるヘッダの詳細は、Sub Accountのリクエストヘッダをご参照ください。
リクエストパスパラメータ
リクエストパスパラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
subAccountId |
String | Required | サブアカウント ID |
リクエストボディ
リクエストボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
accessKey |
String | Required | Access Key |
active |
Boolean | Required | サブアカウント Access Keyの状態
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request PUT 'https://subaccount.apigw.ntruss.com/api/v1/sub-accounts/f1a03ae0-*************************/access-keys' \
--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' \
--data '{
"accessKey": "ncp_iam_*********************",
"active": false
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
success |
Boolean | - | API呼び出しに成功したかどうか
|
レスポンスステータスコード
Sub Account APIで共通して使用されるレスポンスステータスコードの詳細は、Sub Accountのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"success": true
}