그룹 생성

Prev Next

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

그룹을 생성합니다.

참고
  • 그룹은 최대 300개 생성할 수 있습니다.
  • 서브 계정당 소속 가능한 그룹은 최대 10개입니다.

요청

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

메서드 URI
POST /api/v1/groups

요청 헤더

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

요청 바디

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

필드 타입 필수 여부 설명
groupName String Required 그룹 이름
  • 한글, 영어 대소문자, 일어, 특수문자 . _ -를 사용하여 3~30자
  • 첫 글자는 한글, 영어 대소문자, 일어

요청 예시

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

curl --location --request POST 'https://subaccount.apigw.gov-ntruss.com/api/v1/groups' \
--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 '{
    "groupName": "group000"
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
success Boolean - API 호출 성공 여부
  • true | false
    • true: 성공
    • false: 실패
id String - 그룹 아이디

응답 상태 코드

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

응답 예시

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

{
    "success": true,
    "id": "bd8864a0-****-****-****-005056a79baa"
}