Profile 수정

Prev Next

Classic/VPC 환경에서 이용 가능합니다.

Profile 정보를 수정합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
PATCH /api/v1/profiles/{profileId}

요청 헤더

Sub Account API에서 공통으로 사용하는 헤더에 대한 정보는 Sub Account 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
profileId String Required Profile 아이디

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
name String Optional Profile 이름
  • 한글, 영어 대소문자, 일어, 특수문자 . _ -를 사용하여 3~30자
  • 첫 글자는 한글, 영어 대소문자, 일어
description String Optional Profile에 대한 설명(Bytes)
  • 0~300
durationSeconds Integer Optional 세션 만료 시간
  • 임시 자격 증명 지속 시간(초)
  • 600~43,200 (기본값: 3,600)
roleIdList Array Optional 역할 아이디 목록
  • 역할 목록 조회 참조
  • null 입력 시 연결된 역할 변경 안 함
  • [] 입력 시 연결된 역할 삭제
  • 임시 자격 증명에 사용
  • External Access가 할당된 Service 역할만 사용 가능
  • 다른 Profile에 매핑된 역할은 입력 불가

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request PATCH 'https://externalaccess.apigw.gov-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
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
profileId String - Profile 아이디
profileNrn String - Profile에 대한 네이버 클라우드 플랫폼 리소스 식별 값
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.128+09:00",
    "updateTime": "2024-12-13T14:24:45.128+09:00"
}