サブアカウントの更新

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

サブアカウント情報を更新します。

リクエスト

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

メソッド	URI
PUT	/api/v1/sub-accounts/{subAccountId}

リクエストヘッダ

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

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`subAccountId`	String	Required	サブアカウント ID サブアカウントリストの照会を通じて確認

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`active`	Boolean	Optional	有効化するかどうか `true` \| `false` `true`: 有効化 `false`: 無効化
`apiAllowSources`	Array	Optional	APIにアクセス可能なソースリスト
`canAPIGatewayAccess`	Boolean	Optional	API Gatewayにアクセス可能かどうか `true` \| `false` `true`: アクセス可能 `false`: アクセス不可 Access Keyを作成すると API Gatewayに登録された APIは使用可能
`canConsoleAccess`	Boolean	Optional	コンソールにアクセス可能かどうか `true` \| `false` `true`: アクセス可能 `false`: アクセス不可
`consolePermitIps`	Array	Optional	コンソールにアクセスできるIP帯域リスト
`email`	String	Optional	ユーザーのメールアドレス 6~100文字
`isMfaMandatory`	Boolean	Optional	2段階認証は必須かどうか `true` \| `false` `true`: 必須 `false`: 任意
`memo`	String	Optional	サブアカウントの説明(Bytes) 0~300
`name`	String	Required	サブアカウントのユーザー名 2~30文字
`useApiAllowSource`	Boolean	Optional	APIにアクセス可能なソースを制限するかどうか `true` \| `false` `true`: 指定のソースからのみアクセス可能 `false`: すべてのソースからアクセス可能
`useConsolePermitIp`	Boolean	Optional	コンソールにアクセス可能な IPアドレス帯域を制限するかどうか `true` \| `false` `true`: 指定の IPアドレス帯域からのみアクセス可能 `false`: 制限なしでアクセス可能

`apiAllowSources`

apiAllowSourcesの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`type`	String	Conditional	アクセスソースのタイプ `IP` \| `VPC` \| `VPC_SERVER` `IP`: サーバの単一 IPアドレスまたはサブネットを含む IPアドレス帯域 `VPC`: 使用中の VPC `VPC_SERVER`: 使用中の VPC内サーバ
`source`	String	Conditional	アクセスソース情報 IPアドレスまたはインスタンス番号を入力

リクエスト例

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

curl --location --request PUT 'https://subaccount.apigw.ntruss.com/api/v1/sub-accounts/2b141960-****-****-****-246e9659184c' \
--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 '{
    "email": "email@ncloud.com",
    "isMfaMandatory": false,
    "memo": "test",
    "name": "test",
    "useApiAllowSource": false,
    "useConsolePermitIp": false
}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
    "success": true
}