Profileの有効化

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

Profileを有効化状態に設定します。

リクエスト

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

メソッド	URI
POST	/api/v1/profiles/{profileId}/enable

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request POST 'https://externalaccess.apigw.ntruss.com/api/v1/profiles/76da1a8c-****-****-****-cf13dfc49aa6/enable' \
--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'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`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": "abfb4598-****-****-****-95c49101a86d",
    "profileNrn": "nrn:PUB:ExternalAccess::*******:Profile/abfb4598-****-****-****-95c49101a86d",
    "name": "profile000",
    "description": "profile",
    "enabled": true,
    "durationSeconds": 600,
    "roleNrnList": [],
    "createTime": "2024-12-24T14:29:54.766+09:00",
    "updateTime": "2024-12-24T14:29:54.766+09:00"
}