ロールの作成

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

ロールを作成します。ロールは、ポリシーで構成された仮の資格証明です。作成したロールで、サブアカウントだけでなくサーバなどのリソースにも権限を付与することができます。

参考

Sub Account APIでは、Server、Account、Serviceロールを作成・管理することができます。Single Sign-Onロールの作成、設定、削除は Ncloud Single Sign-Onサービスで行えます。

リクエスト

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

メソッド	URI
POST	/api/v1/roles

リクエストヘッダ

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

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`descCont`	String	Optional	ロールの説明(Bytes) 0~300
`roleName`	String	Required	ロール名ハングル、英字の大文字・小文字、日本語、記号。「_ -」を使用して3~30文字先頭文字はハングル、英字の大文字・小文字、日本語
`roleType`	String	Required	ロールタイプ `Server` \| `Account` \| `Service` `Server`: VPC環境のサーバリソースに割り当て。Access Keyなしでサービスやリソースにアクセス可能 `Account`: メインアカウントのポータルとコンソールへのアクセス権限をサブアカウントに割り当て。ロールの切り替えにより対象アカウントのリソースにアクセス可能 `Service`: サービスに割り当て。他のサービスのリソースにアクセス可能
`sessionExpirationSec`	Integer	Conditional	セッションタイムアウト(秒) `600` \| `1800` \| `3600` \| `10800` `roleType`が`Account`の場合は必ず入力

リクエスト例

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

curl --location --request POST 'https://subaccount.apigw.ntruss.com/api/v1/roles' \
--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 '{
	"descCont": "Roleの説明",
	"roleName": "role000",
	"roleType": "Account",
	"sessionExpirationSec": 600
}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
    "success": true,
    "id": "5befa3a0-****-****-****-246e96591a38"
}