역할 수정

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

역할 정보를 수정합니다.

요청

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

메서드	URI
PUT	/api/v1/roles/{roleNo}

요청 헤더

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

요청 경로 파라미터

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

필드	타입	필수 여부	설명
`roleNo`	String	Required	역할 아이디 역할 목록 조회를 통해 확인

요청 바디

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

필드	타입	필수 여부	설명
`descCont`	String	Optional	역할에 대한 설명(Bytes) 0~300
`roleName`	String	Optional	역할 이름 한글, 영어 대소문자, 일어, 특수문자 . _ -를 사용하여 3~30자 첫 글자는 한글, 영어 대소문자, 일어
`roleType`	String	Required	역할 유형 수정 불가하므로 기존 유형 입력
`sessionExpirationSec`	Integer	Conditional	세션 만료 시간(초) `600` \| `1800` \| `3600` \| `10800` `roleType`이 `Account`인 경우 반드시 입력

요청 예시

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

curl --location --request PUT 'https://subaccount.apigw.gov-ntruss.com/api/v1/roles/5befa3a0-****-****-****-246e96591a38' \
--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 '{
	"descCont": "Role 설명",
	"roleName": "role000",
	"roleType": "Account",
	"sessionExpirationSec": 600
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`success`	Boolean	-	API 호출 성공 여부 `true` \| `false` `true`: 성공 `false`: 실패

응답 상태 코드

Sub Account API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Sub Account 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "success": true
}