그룹 조회

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

그룹의 상세 정보를 조회합니다.

요청

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

메서드	URI
GET	/api/v1/groups/{groupId}

요청 헤더

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

요청 경로 파라미터

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

필드	타입	필수 여부	설명
`groupId`	String	Required	그룹 아이디 그룹 목록 조회 참조

요청 예시

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

curl --location --request GET 'https://subaccount.apigw.gov-ntruss.com/api/v1/groups/50b77400-****-****-****-246e96591a38' \
--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'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`groupId`	String	-	그룹 아이디
`groupName`	String	-	그룹 이름
`subAccounts`	Array	-	그룹에 속한 서브 계정 목록
`policies`	Array	-	그룹에 할당된 정책 목록
`nrn`	String	-	그룹에 대한 네이버 클라우드 플랫폼 리소스 식별 값

`subAccounts`

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

필드	타입	필수 여부	설명
`subAccountId`	String	-	서브 계정 아이디
`loginId`	String	-	서브 계정 로그인 아이디
`name`	String	-	서브 계정 사용자 이름
`nrn`	String	-	서브 계정에 대한 네이버 클라우드 플랫폼 리소스 식별 값

`policies`

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

필드	타입	필수 여부	설명
`policyId`	String	-	정책 아이디
`policyName`	String	-	정책 이름
`policyType`	String	-	정책 유형 `SYSTEM_MANAGED` \| `USER_CREATED` `SYSTEM_MANAGED`: 관리형 정책 `USER_CREATED`: 사용자 정의 정책
`policyDesc`	String	-	정책에 대한 설명
`nrn`	String	-	정책에 대한 네이버 클라우드 플랫폼 리소스 식별 값

응답 상태 코드

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

응답 예시

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

{
    "groupId": "50b77400-****-****-****-246e96591a38",
    "groupName": "group001",
    "subAccounts": [
        {
            "subAccountId": "dfafe250-****-****-****-246e96591594",
            "loginId": "user000",
            "name": "user000",
            "nrn": "nrn:PUB:IAM::2768364:SubAccount/dfafe250-****-****-****-246e96591594"
        }
    ],
    "policies": [
        {
            "policyId": "56377a60-****-****-****-246e96591594",
            "policyName": "NCP_ADMINISTRATOR",
            "policyType": "SYSTEM_MANAGED",
            "policyDesc": "포털, 콘솔에 접근할 수 있는 권한이 메인 계정과 동일한 권한",
            "nrn": "nrn:PUB:IAM:::Policy/56377a60-****-****-****-246e96591594"
        },
        {
            "policyId": "f9a2ba60-****-****-****-000000008000",
            "policyName": "NCP_FINANCE_MANAGER",
            "policyType": "SYSTEM_MANAGED",
            "policyDesc": " Cost Explorer 서비스 및 포털 내 마이페이지의 이용 관리 메뉴와 결제 수단 관리 메뉴에 접근할 수 있는 권한",
            "nrn": "nrn:PUB:IAM:::Policy/f9a2ba60-****-****-****-000000008000"
        }
    ],
    "nrn": "nrn:PUB:IAM::2768364:Group/50b77400-****-****-****-246e96591a38"
}