Edit profile

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in Classic and VPC

Edit profile information.

Request

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

Method	URI
PATCH	/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 See Get profile list

Request body

You can include the following data in the body of your request:

Field	Type	Required	Description
`name`	String	Optional	Profile name 3-30 characters using Korean, English uppercase and lowercase letters, Japanese, and special characters . _ - First letter must be Korean, English uppercase and lowercase letter, or Japanese
`description`	String	Optional	Description of the profile (byte) 0-300
`durationSeconds`	Integer	Optional	Session expiration time Temporary credential duration (second) 600-43,200 (default: 3600)
`roleIdList`	Array	Optional	Role ID list See Get role list If `null` is entered, it doesn't change the connected role If `[]` is entered, it deletes the connected role Used for temporary credentials Only service roles with external access assigned can be used See Create role See Add role application target Roles mapped to other profiles cannot be entered

Request example

The request example is as follows:

curl --location --request PATCH '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' \
--header 'Content-Type: application/json' \
--data '{
    "name": "profile000",
    "description": "profile",
    "durationSeconds": 600,
    "roleIdList": null
}'

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": true,
    "durationSeconds": 600,
    "roleNrnList": [],
    "createTime": "2024-12-13T14:24:45.128+09:00",
    "updateTime": "2024-12-13T14:24:45.128+09:00"
}

Was this article helpful?

What's Next

Enable profile

Table of contents

Request
Response