그룹 생성

Prev Next

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

그룹을 생성합니다. 그룹에 속한 SSO User에게 권한을 할당할 때 유용하게 사용할 수 있습니다.

요청

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

메서드 URI
POST /api/v1/groups

요청 헤더

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

요청 바디

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

필드 타입 필수 여부 설명
name String Required 그룹 이름
  • 영문자, 숫자, 특수문자 '-', '_'를 조합하여 2~30자로 입력
  • 문자열의 시작은 영문자 또는 숫자로 구성
  • 생성 후 변경 불가
description String Optional 그룹 설명
  • 0~300자

요청 예시

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

curl --location --request POST 'https://sso.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}' \
--data '{
    "name": "group000",
    "description": "group000 description"
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
groupId String - 그룹 아이디
groupName String - 그룹 이름
nrn String - 그룹에 대한 네이버 클라우드 플랫폼 리소스 식별 값
description String - 그룹 설명
createdAt String - 그룹 생성 일시
  • ISO 8601 형식
updatedAt String - 그룹 수정 일시
  • ISO 8601 형식

응답 상태 코드

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

응답 예시

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

{
    "groupId": "12cfbd94-****-****-****-2ff725201395",
    "groupName": "group000",
    "nrn": "nrn:PUB:SSO::*******:Group/12cfbd94-****-****-****-2ff725201395",
    "description": "group000 description",
    "createdAt": "2025-01-13T02:04:15Z",
    "updatedAt": "2025-01-13T02:04:15Z"
}