역할 상태 설정
- 인쇄
- PDF
역할 상태 설정
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
Classic/VPC 환경에서 이용 가능합니다.
역할 상태를 설정합니다.
참고
- Server 역할 비활성화 시 Access Key도 무효화 처리됩니다.
- Account 역할 비활성화 시 역할 전환된 서브 계정은 자동 로그아웃되며 Secure Token Service(STS)도 만료됩니다.
- Single Sign-On 역할은 Ncloud Single Sign-On에서 비활성화해야 합니다.
- Service 역할 비활성화 시 역할이 적용된 서비스 애플리케이션이 중단될 수 있습니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
|---|---|
| PUT | /api/v1/roles/{roleNo}/enable |
요청 헤더
Sub Account API에서 공통으로 사용하는 헤더에 대한 정보는 Sub Account 요청 헤더를 참조해 주십시오.
요청 경로 파라미터
요청 경로 파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
roleNo | String | Required | 역할 아이디
|
요청 쿼리 파라미터
요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
active | Required | - | 역할 상태
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request PUT 'https://subaccount.apigw.gov-ntruss.com/api/v1/roles/5befa3a0-****-****-****-246e96591a38/enable?active=true' \
--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'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
success | Boolean | - | API 호출 성공 여부
|
응답 상태 코드
Sub Account API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Sub Account 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"success": true
}
이 문서가 도움이 되었습니까?