updateSwitchableRole

이 가이드는 API 명세를 기반으로 자동 생성했습니다.

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

Ncloud API 표준 규격을 적용한 API입니다.

호출 중인 서브 계정이 전환할 수 있는 역할 중 지정한 역할의 표시 이름과 설명을 전체 교체합니다(PUT). 수정 가능한 모든 필드를 전송해야 하며, 전송하지 않은 설명은 비워집니다. 같은 자원에 대한 수정 요청이 동시에 발생하면 마지막 요청이 적용됩니다.

요청

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

메서드	URI
PUT	/switchable-roles/{roleId}

요청 헤더

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

요청 경로 파라미터

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

필드	타입	필수 여부	설명
`roleId`	String (uuid)	Required	대상 역할의 식별자 <예시> 4e066e50-9c3a-11e7-8a66-1e5021fa7c80

요청 바디

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

필드	타입	필수 여부	설명
`displayName`	String	Required	전환 가능 역할의 표시 이름. 문자로 시작하고 문자(한글·영문 등), 숫자, `.`, `-`, `_`만 사용 가능 길이: 3 ~ 30 <예시> my-switchable-role
`description`	String	Optional	전환 가능 역할에 대한 설명 길이: 0 ~ 300 <예시> 전환 역할 설명입니다

요청 예시

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

curl --location --request PUT 'https://subaccount.apigw.gov-ntruss.com/api/v2/switchable-roles/4e066e50-9c3a-11e7-8a66-1e5021fa7c80' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
  "displayName": "my-switchable-role"
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`roleId`	String (uuid)	-	전환 대상 역할의 식별자 <예시> 4e066e50-9c3a-11e7-8a66-1e5021fa7c80
`roleNrn`	String	-	전환 대상 역할의 NRN(Ncloud Resource Name) <예시> nrn:GOV:IAM::25000000:Role/4e066e50-9c3a-11e7-8a66-1e5021fa7c80
`displayName`	String	-	전환 가능 역할의 표시 이름 <예시> my-switchable-role
`description`	String	-	전환 가능 역할에 대한 설명 <예시> 전환 역할 설명입니다
`switched`	Boolean	-	호출자의 현재 전환 상태 `true` \| `false` `true`: 호출자가 현재 이 역할로 전환한 상태 `false`: 이 역할로 전환하지 않은 상태 <예시> false

응답 상태 코드

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

이 API에만 해당하는 응답 상태 코드는 다음과 같습니다.

HTTP 상태 코드	코드	메시지	설명
200	-	-	수정된 전환 가능 역할을 반환
400	BadRequest	The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.	유효하지 않은 요청. 필수 필드 누락, 형식 오류 등 입력값 검증 실패
403	Forbidden	You do not have sufficient permissions to perform this action.	요청한 자원(또는 상위 자원)에 대한 접근 권한 없음. 자원의 존재 여부와 무관하게 우선 반환
403	AccessDenied	The request was denied by an access policy.	서브 계정 전용 API를 메인 계정으로 호출
404	NotFound	One or more of the resources in the request does not exist in the system.	지정한 전환 가능 역할이 등록되어 있지 않음
404	RoleNotFound	The specified role could not be found.	지정한 역할이 존재하지 않음
409	AlreadyExists	A resource with the requested identifier already exists.	이미 같은 값을 사용하는 자원이 존재

응답 예시

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

{
  "roleId": "4e066e50-9c3a-11e7-8a66-1e5021fa7c80",
  "roleNrn": "nrn:GOV:IAM::25000000:Role/4e066e50-9c3a-11e7-8a66-1e5021fa7c80",
  "displayName": "my-switchable-role",
  "description": "전환 역할 설명입니다",
  "switched": false
}