그룹 이름 체크

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

그룹 이름의 유효성 및 중복 여부를 체크합니다.

요청

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

요청 헤더

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

요청 쿼리 파라미터

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

요청 예시

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

curl --location --request GET 'https://sso.apigw.gov-ntruss.com/api/v1/groups/check-group-name?groupName=group001' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

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

응답 상태 코드

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

응답 예시

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

체크 결과 사용 가능 이름인 경우

체크 결과 사용 가능 이름인 경우의 응답 예시는 다음과 같습니다.

{
    "name": "group001",
    "success": true
}

체크 결과 사용 불가능 이름인 경우

체크 결과 사용 불가능 이름인 경우의 응답 예시는 다음과 같습니다.

• 그룹 이름이 이미 존재하는 경우

  {
      "name": "group000",
      "success": false,
      "message": "그룹 이름이 이미 있습니다."
  }
      ```
  
  

• 그룹 이름이 유효하지 않은 경우

  {
      "name": "!@",
      "success": false,
      "message": "영어, 숫자, (-_)의 특수문자만 허용하며 영어,숫자로 시작해야 합니다."
  }