Delete profile

Prev Next

Available in Classic and VPC

Delete a profile.

Request

This section describes the request format. The method and URI are as follows:

Method URI
DELETE /api/v1/profiles/{profileId}

Request headers

For information about the headers common to all Sub Account APIs, see Sub Account request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
profileId String Required Profile ID

Request example

The request example is as follows:

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'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
profileId String - Profile ID
profileNrn String - NAVER Cloud Platform resource identification value for profile
name String - Profile name
description String - Profile description
enabled Boolean - Status
  • true | false
    • true: enabled
    • false: disabled
durationSeconds Integer - Session expiration time
  • Temporary credential duration (second)
roleNrnList Array - List of roles mapped to profile
createTime String - Creation date and time
  • ISO 8601 format
updateTime String - Last modification date and time
  • ISO 8601 format

Response status codes

For information about the HTTP status codes common to all Sub Account APIs, see Sub Account status codes.

Response example

The response example is as follows:

{
    "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"
}