Profileの作成

Prev Next

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

Profileを作成します。Profileに External Accessサービスが適用されたロールをマッピングすると、身元が確認された外部ワークロード対象が NAVERクラウドプラットフォームのリソースにアクセスできるように権限を制御できます。

リクエスト

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

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

リクエストヘッダ

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

リクエストボディ

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

フィールド タイプ 必須の有無 説明
name String Required Profile名
  • ハングル、英字の大文字・小文字、日本語、記号。「_ -」を使用して3~30文字
  • 先頭文字はハングル、英字の大文字・小文字、日本語
description String Optional Profileの説明(Bytes)
  • 0~300
durationSeconds Integer Optional セッションの有効期限
  • 仮認証情報の持続時間(秒)
  • 600~43,200 (デフォルト: 3,600)
enabled Boolean Optional 状態
  • true | false (デフォルト)
    • true: 有効化
    • false: 無効化
roleIdList Array Optional ロール IDリスト

リクエスト例

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

curl --location --request POST 'https://externalaccess.apigw.ntruss.com/api/v1/profiles' \
--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 '{
    "name": "profile000",
    "description": "profile",
    "durationSeconds": 600,
    "enabled": true,
    "roleIdList": []
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
profileId String - Profile ID
profileNrn String - Profileに対する NAVERクラウドプラットフォームリソースの識別値
name String - Profile名
description String - Profileの説明
enabled Boolean - 状態
  • true | false
    • true: 有効化
    • false: 無効化
durationSeconds Integer - セッションの有効期限
  • 仮認証情報の持続時間(秒)
roleNrnList Array - Profileにマッピングされたロールリスト
createTime String - 作成日時
  • ISO 8601形式
updateTime String - 最終更新日時
  • ISO 8601形式

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

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

レスポンス例

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

{
    "profileId": "76da1a8c-****-****-****-cf13dfc49aa6",
    "profileNrn": "nrn:PUB:ExternalAccess::*******:Profile/76da1a8c-****-****-****-cf13dfc49aa6",
    "name": "profile000",
    "description": "profile",
    "enabled": true,
    "durationSeconds": 600,
    "roleNrnList": [],
    "createTime": "2024-12-13T14:24:45.128386464+09:00",
    "updateTime": "2024-12-13T14:24:45.128386464+09:00"
}