updateGroup

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

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

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

그룹 ID로 지정한 기존 그룹의 이름 등 변경 가능한 속성을 수정하고, 수정된 그룹을 반환. 요청 본문은 부분 수정 미디어 타입(application/merge-patch+json)과 일반 JSON을 모두 지원하며, 생략한 필드는 기존 값을 유지합니다. 필드에 null을 보내면 400을 반환합니다.

요청

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

메서드	URI
PATCH	/groups/{groupId}

요청 헤더

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

요청 경로 파라미터

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

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

요청 바디

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

요청 바디는 application/merge-patch+json, application/json 형식을 지원하며, Content-Type 헤더로 형식을 지정합니다.

필드	타입	필수 여부	설명
`groupName`	String	Optional	변경할 그룹의 이름 길이: 3 ~ 30 <예시> my-group

요청 예시

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

curl --location --request PATCH 'https://subaccount.apigw.gov-ntruss.com/api/v2/groups/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'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`groupId`	String (uuid)	-	그룹의 식별자 <예시> 4e066e50-9c3a-11e7-8a66-1e5021fa7c80
`groupName`	String	-	그룹의 이름 <예시> my-group
`nrn`	String	-	그룹의 NRN(Ncloud Resource Name) <예시> nrn:GOV:IAM::25000000:Group/4e066e50-9c3a-11e7-8a66-1e5021fa7c80
`createdDateTime`	String (date-time)	-	그룹이 생성된 일시 <예시> 2019-08-10T13:21:00Z
`updatedDateTime`	String (date-time)	-	그룹이 마지막으로 수정된 일시 <예시> 2019-08-10T13:21:00Z
`subAccounts`	List<SubAccountSummary>	-	그룹에 속한 서브 계정 목록
`policies`	List<PolicySummary>	-	그룹에 연결된 정책 목록

SubAccountSummary

서브 계정 요약 정보

필드	타입	필수 여부	설명
`subAccountId`	String (uuid)	-	서브 계정의 식별자 <예시> 4e066e50-9c3a-11e7-8a66-1e5021fa7c80
`loginId`	String	-	서브 계정의 로그인 아이디 <예시> myloginid01
`name`	String	-	서브 계정의 표시 이름 <예시> 홍길동
`nrn`	String	-	서브 계정의 NRN(Ncloud Resource Name) <예시> nrn:GOV:IAM::25000000:SubAccount/4e066e50-9c3a-11e7-8a66-1e5021fa7c80

PolicySummary

정책 요약 정보. 서브 계정·그룹·역할 응답의 연결된 정책 목록에 사용

필드	타입	필수 여부	설명
`policyId`	String (uuid)	-	정책의 식별자 <예시> 4e066e50-9c3a-11e7-8a66-1e5021fa7c80
`policyName`	String	-	정책의 이름 <예시> my-policy
`policyType`	String	-	정책 유형 `SYSTEM_MANAGED` \| `USER_CREATED` `SYSTEM_MANAGED`: 네이버 클라우드 플랫폼이 제공하는 관리형 정책 `USER_CREATED`: 사용자가 생성한 정책 <예시> USER_CREATED
`description`	String	-	정책에 대한 설명 <예시> 정책 설명입니다
`nrn`	String	-	정책의 NRN(Ncloud Resource Name) <예시> nrn:GOV:IAM::25000000:Policy/4e066e50-9c3a-11e7-8a66-1e5021fa7c80

응답 상태 코드

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.	요청한 자원(또는 상위 자원)에 대한 접근 권한 없음. 자원의 존재 여부와 무관하게 우선 반환
404	GroupNotFound	The specified group could not be found.	지정한 그룹이 존재하지 않음
409	AlreadyExists	A resource with the requested identifier already exists.	이미 같은 값을 사용하는 자원이 존재

응답 예시

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

{
  "groupId": "4e066e50-9c3a-11e7-8a66-1e5021fa7c80",
  "groupName": "my-group",
  "nrn": "nrn:GOV:IAM::25000000:Group/4e066e50-9c3a-11e7-8a66-1e5021fa7c80",
  "createdDateTime": "2019-08-10T13:21:00Z",
  "updatedDateTime": "2019-08-10T13:21:00Z",
  "subAccounts": [
    {
      "subAccountId": "4e066e50-9c3a-11e7-8a66-1e5021fa7c80",
      "loginId": "myloginid01",
      "name": "홍길동",
      "nrn": "nrn:GOV:IAM::25000000:SubAccount/4e066e50-9c3a-11e7-8a66-1e5021fa7c80"
    }
  ],
  "policies": [
    {
      "policyId": "4e066e50-9c3a-11e7-8a66-1e5021fa7c80",
      "policyName": "my-policy",
      "policyType": "USER_CREATED",
      "description": "정책 설명입니다",
      "nrn": "nrn:GOV:IAM::25000000:Policy/4e066e50-9c3a-11e7-8a66-1e5021fa7c80"
    }
  ]
}