グループ名のチェック

Classic/VPC環境で利用できます。

グループ名の有効性と重複チェックを行います。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

リクエストヘッダ

Ncloud Single Sign-On APIで共通して使用されるヘッダの詳細は、Ncloud Single Sign-Onのリクエストヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://sso.apigw.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": "英数字、記号の「-_」のみ入力できます。先頭文字は英字か数字のみ使用できます。"
  }