Proflieの削除

Prev Next

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

Profileを削除します。

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
profileId String Required Profile ID

リクエスト例

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

curl --location --request DELETE 'https://externalaccess.apigw.ntruss.com/api/v1/profiles/76da1a8c-****-****-****-cf13dfc49aa6' \
--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": "76da1a8c-****-****-****-cf13dfc49aa6",
    "profileNrn": "nrn:PUB:ExternalAccess::*******:Profile/76da1a8c-****-****-****-cf13dfc49aa6",
    "name": "profile000",
    "description": "profile",
    "enabled": false,
    "durationSeconds": 600,
    "roleNrnList": [],
    "createTime": "2024-12-13T14:24:45.128+09:00",
    "updateTime": "2024-12-13T17:08:45.90355096+09:00"
}