Check group name

Available in Classic and VPC

Check validity and duplication status of a group name.

Request

This section describes the request format. The method and URI are as follows:

Request headers

For information about the headers common to all Ncloud Single Sign-On APIs, see Ncloud Single Sign-On request headers.

Request query parameters

You can use the following query parameters with your request:

Request example

The request example is as follows:

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}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Response status codes

For information about the response status codes common to all Ncloud Single Sign-On APIs, see Ncloud Single Sign-On response status codes.

Response example

The response example is as follows:

If check result is available name

The following is a sample response if the check result is an available name.

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

If check result is unavailable name

The following is a sample response if the check result is an unavailable name.

• If group name already exists

  {
      "name": "group000",
      "success": false,
      "message": "The group name already exists."
  }
      ```
  
  

• If group name is invalid

  {
      "name": "!@",
      "success": false,
      "message": "Only English letters, numbers, and special characters (-, _) can be used, and it must start with an English letter or a number."
  }