서브계정 수정

인쇄
공유
PDF

기사 요약

이 요약이 도움이 되었나요?

의견을 보내 주셔서 감사합니다.

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

서브 계정 정보를 수정합니다.

요청

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

메서드	URI
PUT	/api/v1/sub-accounts/{subAccountId}

요청 헤더

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

요청 경로 파라미터

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

필드	타입	필수 여부	설명
`subAccountId`	String	Required	서브 계정 아이디 서브 계정 목록 조회를 통해 확인

요청 바디

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

필드	타입	필수 여부	설명
`active`	Boolean	Optional	활성화 여부 `true` \| `false` `true`: 활성화 `false`: 비활성화
`apiAllowSources`	Array	Optional	API 접근 가능 소스 목록
`canAPIGatewayAccess`	Boolean	Optional	API Gateway 접근 가능 여부 `true` \| `false` `true`: 접근 가능 `false`: 접근 불가 Access Key를 생성하여 API Gateway에 등록된 API 사용 가능
`canConsoleAccess`	Boolean	Optional	콘솔 접근 가능 여부 `true` \| `false` `true`: 접근 가능 `false`: 접근 불가
`consolePermitIps`	Array	Optional	콘솔 접근 가능한 IP 대역 목록
`email`	String	Optional	사용자의 이메일 주소 6~100자
`isMfaMandatory`	Boolean	Optional	2차 인증 필수 여부 `true` \| `false` `true`: 필수 `false`: 선택
`memo`	String	Optional	서브 계정에 대한 설명(Bytes) 0~300
`name`	String	Required	서브 계정 사용자의 이름 2~30자
`useApiAllowSource`	Boolean	Optional	API 접근 가능한 소스 제한 여부 `true` \| `false` `true`: 지정한 소스에서만 접근 가능 `false`: 모든 소스에서 접근 가능
`useConsolePermitIp`	Boolean	Optional	콘솔 접근 가능한 IP 대역 제한 여부 `true` \| `false` `true`: 지정한 IP 대역에서만 접근 가능 `false`: 모든 곳에서 접근 가능

`apiAllowSources`

apiAllowSources에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`type`	String	Conditional	접근 소스 유형 `IP` \| `VPC` \| `VPC_SERVER` `IP`: 서버 단일 IP 또는 서브넷을 포함한 IP 대역 `VPC`: 사용 중인 VPC `VPC_SERVER`: 사용 중인 VPC 내 서버
`source`	String	Conditional	접근 소스 정보 IP 주소 또는 인스턴스 번호 입력

요청 예시

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

curl --location --request PUT 'https://subaccount.apigw.gov-ntruss.com/api/v1/sub-accounts/2b141960-****-****-****-246e9659184c' \
--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 '{
    "email": "email@ncloud.com",
    "isMfaMandatory": false,
    "memo": "test",
    "name": "test",
    "useApiAllowSource": false,
    "useConsolePermitIp": false
}'

응답

응답 형식을 설명합니다.

응답 바디

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

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

응답 상태 코드

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

응답 예시

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

{
    "success": true
}

이 문서가 도움이 되었습니까?

What's Next

서브계정 생성

요청
응답

태그

Sub Account