ロール(Account)適用対象の追加

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

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

Accountロールの適用対象を追加します。

リクエスト

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

メソッド	URI
POST	/api/v1/roles/{roleNo}/entities/account

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`roleNo`	String	Required	ロール ID ロールリストの照会を参照

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`isMyAccount`	Boolean	Required	本人のアカウントかどうか `true` \| `false` `true`: 本人のアカウント `false`: 別のメインアカウント
`accountName`	String	Conditional	サブアカウントのユーザー名 `isMyAccount`が`false`の場合は必ず入力
`loginId`	String	Conditional	サブアカウントのログイン ID `isMyAccount`が`false`の場合は必ず入力

リクエスト例

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

curl --location --request POST 'https://subaccount.apigw.ntruss.com/api/v1/roles/c85f94d0-***************************/entities/account' \
--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 '{
  "isMyAccount": false,
  "accountName": "***"
  "loginId": "j********@********.com",
}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
  "success": true
}

この記事は役に立ちましたか?

What's Next

ロール(Account)適用対象の削除

リクエスト
レスポンス

タグ

Sub Account