The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.
Available in Classic and VPC
Create a group. It can be useful when assigning permissions to SSO users in the group.
Request
This section describes the request format. The method and URI are as follows:
| Method | URI |
|---|---|
| POST | /api/v1/groups |
Request headers
For information about the headers common to all Ncloud Single Sign-On APIs, see Ncloud Single Sign-On request headers.
Request body
You can include the following data in the body of your request:
| Field | Type | Required | Description |
|---|---|---|---|
name |
String | Required | Group name
|
description |
String | Optional | Group description
|
Request example
The request example is as follows:
curl --location --request POST 'https://sso.apigw.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"
}'
Response
This section describes the response format.
Response body
The response body includes the following data:
| Field | Type | Required | Description |
|---|---|---|---|
groupId |
String | - | Group ID |
groupName |
String | - | Group name |
nrn |
String | - | NAVER Cloud Platform resource identification value for group |
description |
String | - | Group description |
createdAt |
String | - | Group creation date and time
|
updatedAt |
String | - | Group modification date and time
|
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:
{
"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"
}