역할 생성

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

역할을 생성합니다. 역할은 정책으로 구성된 임시 자격 증명으로, 역할을 생성하여 서브 계정뿐만 아니라 서버와 같은 리소스에도 권한을 부여할 수 있습니다.

참고

Sub Account API에서는 Server, Account, Service 역할을 생성 및 관리할 수 있습니다. Single Sign-On 역할의 생성, 설정, 삭제는 Ncloud Single Sign-On 서비스에서 가능합니다.

요청

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

메서드	URI
POST	/api/v1/roles

요청 헤더

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

요청 바디

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

필드	타입	필수 여부	설명
`descCont`	String	Optional	역할에 대한 설명(Bytes) 0~300
`roleName`	String	Required	역할 이름 한글, 영어 대소문자, 일어, 특수문자 . _ -를 사용하여 3~30자 첫 글자는 한글, 영어 대소문자, 일어
`roleType`	String	Required	역할 유형 `Server` \| `Account` \| `Service` `Server`: VPC 환경의 서버 리소스에 할당. Access Key 없이 서비스 및 리소스 접근 가능 `Account`: 메인 계정의 포털 및 콘솔 접근 권한을 서브 계정에 할당. 역할 전환을 통해 대상 계정의 리소스 접근 가능 `Service`: 서비스에 할당. 다른 서비스의 리소스 접근 가능
`sessionExpirationSec`	Integer	Conditional	세션 만료 시간(초) `600` \| `1800` \| `3600` \| `10800` `roleType`이 `Account`인 경우 반드시 입력

요청 예시

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

curl --location --request POST 'https://subaccount.apigw.gov-ntruss.com/api/v1/roles' \
--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`: 실패
`id`	String	-	역할 아이디

응답 상태 코드

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

응답 예시

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

{
    "success": true,
    "id": "5befa3a0-****-****-****-246e96591a38"
}